X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/848a836e583c9b2718604c5ede543c5d0fa4ac8d..c18b85451625ff5b7ba8940c43f6703cc3b795d3:/doc/ikiwiki/directive/format.mdwn

diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn
index a32ad05e9..ae976faed 100644
--- a/doc/ikiwiki/directive/format.mdwn
+++ b/doc/ikiwiki/directive/format.mdwn
@@ -18,7 +18,7 @@ some other format:
 		4
 	"""]]
 
-Note that if the [[highlight|plugins/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:
 
@@ -26,4 +26,12 @@ supported. For example:
 	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"]]