pagestats: rename disp to show, and document it

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

diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn
index 8d2be09469ccd964b34d971d42939ec973a82b73..ab8397366f985a8604236c597ba8814c8b3aaf01 100644 (file)
--- a/doc/ikiwiki/directive/pagestats.mdwn
+++ b/doc/ikiwiki/directive/pagestats.mdwn
@@ -40,4 +40,10 @@ that name still works, if its value is numeric.
 The optional `class` parameter can be used to control the class
 of the generated tag cloud `div` or page stats `table`.
 
+By default, the names of pages are shown. The `show` parameter
+can be used (with a non-numeric value) to show the titles or descriptions
+of pages instead (as set by the [[meta]] directive). For example:
+
+       \[[!pagestats pages="tags/*" show="title"]]
+
 [[!meta robots="noindex, follow"]]