backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-24 06:59:52 +01:00
Code Issues Projects Releases Activity

fix errors in docs/manual/rewriter.rst (#655)

Browse Source 
* fix format error in docs/manual/rewriter.rst

* fix incorrect names in docs/manual/rewriter.rst
This commit is contained in:
Simon Chan 2021-07-07 12:01:38 +08:00 committed by GitHub
parent 81308780ec
commit 096850b41d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/manual/rewriter.rst
View File

@ -92,7 +92,7 @@ Configuring Rewriters
--------------------- ---------------------
pywb provides customizable rewriting based on content-type, the available types are configured pywb provides customizable rewriting based on content-type, the available types are configured
in the :py:mod:`pywb.rewriter.default_rewriter`, which specifies rewriter classes per known type, in the :py:mod:`pywb.rewrite.default_rewriter`, which specifies rewriter classes per known type,
and mapping of content-types to rewriters. and mapping of content-types to rewriters.
@ -118,6 +118,7 @@ JS Rewriting
The JS rewriter is applied to inline ``<script>`` blocks, or inline attribute js, and any files determine to be javascript (based on content type and ``js_`` modifier). The JS rewriter is applied to inline ``<script>`` blocks, or inline attribute js, and any files determine to be javascript (based on content type and ``js_`` modifier).
The default JS rewriter does not rewrite any links. Instead, JS rewriter performs limited regular expression on the following: The default JS rewriter does not rewrite any links. Instead, JS rewriter performs limited regular expression on the following:
* ``postMessage`` calls * ``postMessage`` calls
* certain ``this`` property accessors * certain ``this`` property accessors
* specific ``location =`` assignment * specific ``location =`` assignment
@ -126,7 +127,7 @@ Then, the entire script block is wrapped in a special code block to be executed
The server-side rewriting is to aid the client-side execution of wrapped code. The server-side rewriting is to aid the client-side execution of wrapped code.
For more information, see :py:mod:`pywb.rewriter.regex_rewriters.JSWombatProxyRewriterMixin` For more information, see :py:mod:`pywb.rewrite.regex_rewriters.JSWombatProxyRewriterMixin`
JSONP Rewriting JSONP Rewriting
@ -140,7 +141,7 @@ For example, a requested url might be ``/my-coll/http://example.com?callback=jQu
To ensure the JSONP callback works as expected, the content is rewritten to ``jQuery123(...)`` -> ``jQuery456(...)`` To ensure the JSONP callback works as expected, the content is rewritten to ``jQuery123(...)`` -> ``jQuery456(...)``
For more information, see :py:mod:`pywb.rewriter.jsonp_rewriter` For more information, see :py:mod:`pywb.rewrite.jsonp_rewriter`
DASH and HLS Rewriting DASH and HLS Rewriting
@ -148,5 +149,5 @@ DASH and HLS Rewriting
To support recording and replaying, adaptive streaming formants (DASH and HLS), pywb can perform special rewriting on the manifests for these formats to remoe all but one possible resolution/format. As a result, the non-deterministic format selection is reduced to a single consistent format. To support recording and replaying, adaptive streaming formants (DASH and HLS), pywb can perform special rewriting on the manifests for these formats to remoe all but one possible resolution/format. As a result, the non-deterministic format selection is reduced to a single consistent format.
For more information, see :py:mod:`pywb.rewriter.rewrite_hls` and :py:mod:`pywb.rewriter.rewrite_dash` and the tests in ``pywb/rewrite/test/test_content_rewriter.py`` For more information, see :py:mod:`pywb.rewrite.rewrite_hls` and :py:mod:`pywb.rewrite.rewrite_dash` and the tests in ``pywb/rewrite/test/test_content_rewriter.py``