From: Joey Hess <joey@kodama.kitenet.net>
Date: Sun, 15 Jun 2008 20:11:11 +0000 (-0400)
Subject: map: Add a "show" parameter. "show=title" can be used to display page titles, rather... 
X-Git-Tag: 2.51~85
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=71d984b3109e7d5ab9e7e41bb50dc00a1787dd6f;p=ikiwiki.git

map: Add a "show" parameter. "show=title" can be used to display page titles, rather than the default page name. Based on a patch from  Jaldhar H. Vyas, Closes: #484510
---

diff --git a/IkiWiki/Plugin/map.pm b/IkiWiki/Plugin/map.pm
index 581ae5011..af08005b8 100644
--- a/IkiWiki/Plugin/map.pm
+++ b/IkiWiki/Plugin/map.pm
@@ -25,8 +25,13 @@ sub preprocess (@) { #{{{
 	my %mapitems;
 	foreach my $page (keys %pagesources) {
 		if (pagespec_match($page, $params{pages}, location => $params{page})) {
-			$mapitems{$page}=1;
-
+			if (exists $params{show} && 
+			    exists $pagestate{$page}{meta}{$params{show}}) {
+				$mapitems{$page}=$pagestate{$page}{meta}{$params{show}};
+			}
+			else {
+				$mapitems{$page}=$page;
+			}
 			# Check for a common prefix.
 			if (! defined $common_prefix) {
 				$common_prefix=$page;
@@ -66,7 +71,7 @@ sub preprocess (@) { #{{{
 	my $openli=0;
 	my $dummy=0;
 	my $map = "<div class='map'>\n<ul>\n";
-	foreach my $item (sort keys %mapitems) {
+	foreach my $item (sort { $mapitems{$a} cmp $mapitems{$b} } keys %mapitems) {
 		$item=~s/^\Q$common_prefix\E\///
 			if defined $common_prefix && length $common_prefix;
 		my $depth = ($item =~ tr/\//\//) + 1;
@@ -114,6 +119,7 @@ sub preprocess (@) { #{{{
 		$map .= "<li>"
 			.htmllink($params{page}, $params{destpage}, 
 				"/".$common_prefix."/".$item,
+				linktext => $mapitems{$item},
 				class => "mapitem", noimageinline => 1)
 			."\n";
 		$openli=1;
diff --git a/debian/changelog b/debian/changelog
index 11a100c0d..3465a51f4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,6 +2,9 @@ ikiwiki (2.51) UNRELEASED; urgency=low
 
   * Improve toplevel parentlink to link directly to index.html when usedirs is
     disabled.
+  * map: Add a "show" parameter. "show=title" can be used to display page
+    titles, rather than the default page name. Based on a patch from 
+    Jaldhar H. Vyas, Closes: #484510
 
  -- Joey Hess <joeyh@debian.org>  Sun, 15 Jun 2008 15:03:33 -0400
 
diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn
index 44ce9edd4..d50c9b292 100644
--- a/doc/plugins/map.mdwn
+++ b/doc/plugins/map.mdwn
@@ -8,6 +8,11 @@ This plugin generates a hierarchical page map for the wiki. Example usage:
 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:
+	
+	\[[map pages="* and !blog/* and !*/Discussion" show=title]]
+
 Hint: To limit the map to displaying pages less than a certain level deep,
 use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"`
 
diff --git a/doc/plugins/map/discussion.mdwn b/doc/plugins/map/discussion.mdwn
index 9fdd32eeb..814e4f934 100644
--- a/doc/plugins/map/discussion.mdwn
+++ b/doc/plugins/map/discussion.mdwn
@@ -17,4 +17,4 @@ Thoughts, anyone?  --[[KarlMW]]
 We'd also very much like to have an option to display the title of the page instead of the filename in the map plugin. --Andrew
 
 There's a patch implementing this in [[debbug 484510]]. It needs a few fixes
-before I merge it. --[[Joey]]
+before I merge it. Now applied. --[[Joey]]
diff --git a/doc/users/The_TOVA_Company.mdwn b/doc/users/The_TOVA_Company.mdwn
index 0e56ec4f4..406dc7fc1 100644
--- a/doc/users/The_TOVA_Company.mdwn
+++ b/doc/users/The_TOVA_Company.mdwn
@@ -14,7 +14,8 @@ We're looking for the following "standard" wiki features for some of our git-dis
 
 - Some cleanups on other plugins:
    - Add the ability to use the meta title to the map plugin.
-     > Patch [[exists|plugins/map/discussion]], just needs some cleanup. --[[Joey]]
+     > Patch [[exists|plugins/map/discussion]], just needs some cleanup.
+     > Now done. --[[Joey]]
 
 ----
 Looking for a part-time ikiwiki developer