meta: Store "description" in pagestate for use by other plugins.
authorJoey Hess <joey@kodama.kitenet.net>
Sun, 15 Jun 2008 23:08:50 +0000 (19:08 -0400)
committerJoey Hess <joey@kodama.kitenet.net>
Sun, 15 Jun 2008 23:08:50 +0000 (19:08 -0400)
map: Support show=description.

IkiWiki/Plugin/meta.pm
debian/changelog
doc/plugins.mdwn
doc/plugins/map.mdwn

index e2914a78aa1eaa73271784972851354893ca3cae..8e1b11859fdf4a3bd676d67d8c8a6211adb2c1b1 100644 (file)
@@ -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}}, '<link rel="license" href="#page_license" />';
index 800a383004918ecb475867c9c6dcf9679c508dba..e1a1d7b334f9a150e7921bee3f606c7834142d15 100644 (file)
@@ -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 <joeyh@debian.org>  Sun, 15 Jun 2008 15:03:33 -0400
 
index 439cecc8aff3d1efdb0fe6dfefc9fffae2882fea..ca1dfd1ff8a90d0ced43b56861f782c35d51a7f3 100644 (file)
@@ -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
index d50c9b292538d6e220e101343536fd5964140b1a..df34d77cd8007cd72e344da43c6f8e871a2b7b35 100644 (file)
@@ -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,