pagestats: rename disp to show, and document it

diff --git a/IkiWiki/Plugin/pagestats.pm b/IkiWiki/Plugin/pagestats.pm
index d0a4ec7aa0f2d323799f6b6e745da3e98fb88518..ac0a463e3ff65814ac001c6214598bd4b0f8dc18 100644 (file)
--- a/IkiWiki/Plugin/pagestats.pm
+++ b/IkiWiki/Plugin/pagestats.pm
@@ -34,10 +34,10 @@ sub getsetup () {
 sub linktext ($%) {
        # Return the text of the link to a tag, depending on option linktext.
        my ($page, %params) = @_;
 sub linktext ($%) {
        # Return the text of the link to a tag, depending on option linktext.
        my ($page, %params) = @_;

-       if (exists $params{disp} &&
+       if (exists $params{show} &&

                exists $pagestate{$page} &&
                exists $pagestate{$page} &&

-               exists $pagestate{$page}{meta}{$params{disp}}) {
-               return $pagestate{$page}{meta}{$params{disp}};
+               exists $pagestate{$page}{meta}{$params{show}}) {
+               return $pagestate{$page}{meta}{$params{show}};

        }
        else {
                return undef;
        }
        else {
                return undef;

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`.
 
 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"]]
 [[!meta robots="noindex, follow"]]