X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1fc3f034191d3eec78b4d5da343e282092a221be..c18b85451625ff5b7ba8940c43f6703cc3b795d3:/doc/ikiwiki/directive/pagestats.mdwn diff --git a/doc/ikiwiki/directive/pagestats.mdwn b/doc/ikiwiki/directive/pagestats.mdwn index 8d904f5a3..ab8397366 100644 --- a/doc/ikiwiki/directive/pagestats.mdwn +++ b/doc/ikiwiki/directive/pagestats.mdwn @@ -28,13 +28,22 @@ Or to display a cloud of tags related to Linux, you could use: \[[!pagestats pages="tags/* and !tags/linux" among="tagged(linux)"]] -The optional `show` parameter limits display to the specified number of +The optional `limit` parameter limits display to the specified number of pages. For instance, to show a table of the top ten pages with the most links: - \[[!pagestats style="table" show="10"]] + \[[!pagestats style="table" limit="10"]] + +In older versions of IkiWiki this parameter was called `show`; +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"]]