Commit dd0d5862 authored by Andreas Plesner Jacobsen's avatar Andreas Plesner Jacobsen Committed by Tollef Fog Heen

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

Fixes #1122
parent 22bc7fc6
...@@ -22,7 +22,9 @@ have three ESI statements: ...@@ -22,7 +22,9 @@ have three ESI statements:
Content substitution based on variables and cookies is not implemented Content substitution based on variables and cookies is not implemented
but is on the roadmap. 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 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:: ...@@ -55,32 +57,23 @@ For ESI to work you need to activate ESI processing in VCL, like this::
} }
} }
Example: esi remove Example: esi:remove and <!--esi ... -->
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The <esi:remove> and <!--esi ... --> constructs can be used to present
The *remove* keyword allows you to remove output. You can use this to make appropriate content whether or not ESI is available, for example you can
a fall back of sorts, when ESI is not available, like this:: 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> <esi:remove>
<a href="http://www.example.com">www.example.com</a> <a href="http://www.example.com/LICENSE">The license</a>
</esi:remove> </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 <!--esi
<p>Warning: ESI Disabled!</p> <p>The full text of the license:</p>
</p> --> <esi:include src="http://example.com/LICENSE" />
-->
This assures that the ESI markup will not interfere with the rendering
of the final HTML if not processed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment