describe XSS issue

[git.ikiwiki.info.git] / doc / ikiwiki / directive / format.mdwn

diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn
index 7d11d225f23cc4987964894e23f5ace370234d1e..ae976faed51456b218f5c332a84733469397c33e 100644 (file)
--- a/doc/ikiwiki/directive/format.mdwn
+++ b/doc/ikiwiki/directive/format.mdwn
@@ -18,7 +18,7 @@ some other format:
                4
        """]]
 
                4
        """]]
 

-Note that if the highlight plugin is enabled, this directive can also be
+Note that if the [[!iki plugins/highlight desc=highlight]] plugin is enabled, this directive can also be

 used to display syntax highlighted code. Many languages and formats are
 supported. For example:
 
 used to display syntax highlighted code. Many languages and formats are
 supported. For example:
 


@@ -26,4 +26,12 @@ supported. For example:
        print "hello, world\n";
        """]]
 
        print "hello, world\n";
        """]]
 

+`format` can also be used to format entire source files and display them on a page. Simply put an [[inline]] directive with the `raw` attribute set inside a `format`. This can be useful if you want to both serve the file raw, as well as show it syntax highlighted on a page. An example:
+
+       \[[!format python """
+       [[!inline pages="program.py" raw="yes"]]
+       """]]
+
+       \[[View raw file|program.py]]
+

 [[!meta robots="noindex, follow"]]
 [[!meta robots="noindex, follow"]]