X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a9970df0bfd3d982def2747b4576cea54b211b0f..6cde5baef6eb52e5e7c7b90ba93be416382a02b5:/doc/ikiwiki/directive/format.mdwn

diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn
index 23830e9cd..ae976faed 100644
--- a/doc/ikiwiki/directive/format.mdwn
+++ b/doc/ikiwiki/directive/format.mdwn
@@ -18,12 +18,20 @@ some other format:
 		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:
 
-	\[[format perl """
+	\[[!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"]]