Skip to content
Browse files

Clean up docs about esi:remove and <!--esi

Fixes #1122
  • Loading branch information...
1 parent 22bc7fc commit dd0d58624b8d48547b52c90b6259d8793ba43f54 @scoof scoof committed with Tollef Fog Heen Apr 23, 2012
Showing with 19 additions and 26 deletions.
  1. +19 −26 doc/sphinx/tutorial/esi.rst
View
45 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"/>
<esi:remove>
- <a href="http://www.example.com">www.example.com</a>
+ <a href="http://www.example.com/LICENSE">The license</a>
</esi:remove>
-
-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::
-
<!--esi
- <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" />
+ -->

0 comments on commit dd0d586

Please sign in to comment.
Something went wrong with that request. Please try again.