From 4da54999de859c505c26ff2a0a23772939caeffa Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sun, 15 Jun 2008 19:08:50 -0400 Subject: [PATCH] meta: Store "description" in pagestate for use by other plugins. map: Support show=description. --- IkiWiki/Plugin/meta.pm | 5 +++++ debian/changelog | 2 ++ doc/plugins.mdwn | 2 ++ doc/plugins/map.mdwn | 7 +++++-- 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm index e2914a78a..8e1b11859 100644 --- a/IkiWiki/Plugin/meta.pm +++ b/IkiWiki/Plugin/meta.pm @@ -78,6 +78,11 @@ sub preprocess (@) { #{{{ # Metadata collection that needs to happen during the scan pass. if ($key eq 'title') { $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value); + # fallthrough + } + elsif ($key eq 'description') { + $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value); + # fallthrough } elsif ($key eq 'license') { push @{$metaheaders{$page}}, ''; diff --git a/debian/changelog b/debian/changelog index 800a38300..e1a1d7b33 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,6 +6,8 @@ ikiwiki (2.51) UNRELEASED; urgency=low titles, rather than the default page name. Based on a patch from Jaldhar H. Vyas, Closes: #484510 * hnb: New plugin, contributed by Axel Beckert. + * meta: Store "description" in pagestate for use by other plugins. + * map: Support show=description. -- Joey Hess Sun, 15 Jun 2008 15:03:33 -0400 diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 439cecc8a..ca1dfd1ff 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -1,6 +1,8 @@ Most of ikiwiki's [[features]] are implemented as plugins. Many of these plugins are included with ikiwiki. +[[map pages="plugins/*" show=description]] + [[pagestats pages="plugins/type/* and !plugins/type/slow"]] There's documentation if you want to [[write]] your own plugins, or you can diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index d50c9b292..df34d77cd 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,6 +1,8 @@ [[template id=plugin name=map author="Alessandro Dotti Contra"]] [[tag type/meta]] +[[meta description="some page description"]] + This plugin generates a hierarchical page map for the wiki. Example usage: \[[map pages="* and !blog/* and !*/Discussion"]] @@ -9,8 +11,9 @@ If the pages to include are not specified, all pages (and other files) in the wiki are mapped. By default, the names of pages are shown in the map. The `show` parameter -can be used to show the titles of pages instead. For example: - +can be used to show the titles or descriptions of pages instead (as set by +the [[meta]] plugin). For example: + \[[map pages="* and !blog/* and !*/Discussion" show=title]] Hint: To limit the map to displaying pages less than a certain level deep, -- 2.44.0