]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/ikiwiki/directive/format.mdwn
describe XSS issue
[git.ikiwiki.info.git] / doc / ikiwiki / directive / format.mdwn
index 94cf1b04fdc24f70981716b18c9d5d94d8f73149..ae976faed51456b218f5c332a84733469397c33e 100644 (file)
@@ -18,4 +18,20 @@ some other format:
                4
        """]]
 
+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:
+
+       \[[!format perl """
+       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"]]