[experimental-ims] ad9356a Clean up docs about esi:remove and <!--esi

Andreas Plesner Jacobsen apj at mutt.dk
Thu Dec 18 10:27:44 CET 2014

commit ad9356a952617bf97a539dfcc686142b7120d7f0
Author: Andreas Plesner Jacobsen <apj at mutt.dk>
Date:   Mon Apr 23 19:07:13 2012 +0200

    Clean up docs about esi:remove and <!--esi
    Fixes #1122

diff --git a/doc/sphinx/tutorial/esi.rst b/doc/sphinx/tutorial/esi.rst
index 1badd5d..720b790 100644
--- a/doc/sphinx/tutorial/esi.rst
+++ b/doc/sphinx/tutorial/esi.rst
@@ -22,7 +22,9 @@ have three ESI statements:
 Content substitution based on variables and cookies is not implemented
 but is on the roadmap. 
-Example: esi include
+Varnish will not process ESI instructions in HTML comments.
+Example: esi:include
 Lets see an example how this could be used. This simple cgi script
@@ -55,32 +57,23 @@ For ESI to work you need to activate ESI processing in VCL, like this::
-Example: esi remove
-The *remove* keyword allows you to remove output. You can use this to make
-a fall back of sorts, when ESI is not available, like this::
+Example: esi:remove and <!--esi ... -->
+The <esi:remove> and <!--esi ... --> constructs can be used to present
+appropriate content whether or not ESI is available, for example you can
+include content when ESI is available or link to it when it is not.
+ESI processors will remove the start ("<!--esi") and end ("-->") when
+the page is processed, while still processing the contents. If the page
+is not processed, it will remain, becoming an HTML/XML comment tag.
+ESI processors will remove <esi:remove> tags and all content contained
+in them, allowing you to only render the content when the page is not
+being ESI-processed.
+For example::
-  <esi:include src="http://www.example.com/ad.html"/> 
-    <a href="http://www.example.com">www.example.com</a>
+    <a href="http://www.example.com/LICENSE">The license</a>
-Example: <!--esi ... -->
-This is a special construct to allow HTML marked up with ESI to render
-without processing. ESI Processors will remove the start ("<!--esi")
-and end ("-->") when the page is processed, while still processing the
-contents. If the page is not processed, it will remain, becoming an
-HTML/XML comment tag. For example::
-  <p>Warning: ESI Disabled!</p>
-  </p>  -->
-This assures that the ESI markup will not interfere with the rendering
-of the final HTML if not processed.
+  <p>The full text of the license:</p>
+  <esi:include src="http://example.com/LICENSE" />
+  -->

More information about the varnish-commit mailing list