You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2013/07/25 00:03:37 UTC
[4/4] git commit: Updated indexing and build/config sections.
Updated indexing and build/config sections.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/9b021428
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/9b021428
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/9b021428
Branch: refs/heads/master
Commit: 9b021428cd0791a675d2e31621c18b2957f7fac7
Parents: 0430477
Author: Leif Hedstrom <zw...@apache.org>
Authored: Wed Jul 24 16:03:01 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Wed Jul 24 16:03:01 2013 -0600
----------------------------------------------------------------------
doc/plugins/combo_handler.en.rst | 32 +++++++++++++++++++++-----------
1 file changed, 21 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9b021428/doc/plugins/combo_handler.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/combo_handler.en.rst b/doc/plugins/combo_handler.en.rst
index 11e4633..260d3f3 100644
--- a/doc/plugins/combo_handler.en.rst
+++ b/doc/plugins/combo_handler.en.rst
@@ -19,8 +19,23 @@ Combohandler Plugin
under the License.
-This plugin provides that functionality (and more) with the same
-interface but with these differences in configuration:
+This plugin provides an intelligent way to combine multiple URLs into a single
+URL, and have Apache Traffic Server combine the components into one
+response. This is useful for example to create URLs that combine multiple CSS
+or Javascript files into one.
+
+Installation
+============
+
+This plugin is only built if the configure option ::
+
+ --enable-experimental-plugins
+
+is given at build time. Note that this plugin is built and installed in
+combination with the ESI module, since they share common code.
+
+Configuration
+=============
The arguments in the
```plugin.config`` <../../configuration-files/plugin.config>`_ line in
@@ -38,14 +53,12 @@ default value be applied.
Also, just like the original combohandler, this plugin generates URLs of
the form ``http://localhost/<dir>/<file-path>``. ``<dir>`` here defaults
to ``l`` unless specified by the file path in the query parameter using
-a colon. For example:
+a colon. For example::
-::
http://combo.com/admin/v1/combo?filepath1&dir1:filepath2&filepath3
-Will result in these three pages being fetched:
+Will result in these three pages being fetched::
-::
http://localhost/l/filepath1
http://localhost/dir1/filepath2
http://localhost/l/filepath3
@@ -57,14 +70,11 @@ The plugin also supports a prefix parameter. Common parts of successive
file paths can be extracted and specified separately using a 'p' query
parameter. Successive file path parameters are appended to this prefix
to create complete file paths. The prefix will remain active until
-changed or cleared (set to an empty string). For example, the query
-
-::
+changed or cleared (set to an empty string). For example, the query ::
"/file1&p=/path1/&file2&file3&p=&/file4&p=/dir:path2/&file5&file6"
-results in these file paths being "reconstructed":
+results in these file paths being "reconstructed"::
-::
/file1
/path1/file2
/path1/file3