From 7bde880fa8cf2e7d3413a7ede7ae5b604a97e85b Mon Sep 17 00:00:00 2001 From: joey Date: Sat, 22 Sep 2007 16:32:24 +0000 Subject: [PATCH 1/1] * map: Render pages on the way to subpages whose parent pages are not included in the map. Include special styling for such pages. * map: Remove common prefixes and don't over-indent. * Add class option to htmllink(). --- IkiWiki.pm | 3 ++ IkiWiki/Plugin/map.pm | 66 +++++++++++++++++++++++++++++++++--------- debian/changelog | 9 +++--- doc/plugins/write.mdwn | 3 +- doc/style.css | 4 +++ 5 files changed, 66 insertions(+), 19 deletions(-) diff --git a/IkiWiki.pm b/IkiWiki.pm index 720afdecd..1c15e9299 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -588,6 +588,9 @@ sub htmllink ($$$;@) { #{{{ if (defined $opts{rel}) { push @attrs, ' rel="'.$opts{rel}.'"'; } + if (defined $opts{class}) { + push @attrs, ' class="'.$opts{class}.'"'; + } return "$linktext"; } #}}} diff --git a/IkiWiki/Plugin/map.pm b/IkiWiki/Plugin/map.pm index 2ff840ff7..97450eb6d 100644 --- a/IkiWiki/Plugin/map.pm +++ b/IkiWiki/Plugin/map.pm @@ -19,43 +19,80 @@ sub preprocess (@) { #{{{ my %params=@_; $params{pages}="*" unless defined $params{pages}; + my $common_prefix; + # Get all the items to map. - my @mapitems = (); + my %mapitems; foreach my $page (keys %pagesources) { if (pagespec_match($page, $params{pages}, location => $params{page})) { - push @mapitems, "/".$page; + $mapitems{$page}=1; + + # Check for a common prefix. + if (! defined $common_prefix) { + $common_prefix=$page; + } + elsif (length $common_prefix && + $page !~ /^\Q$common_prefix\E(\/|$)/) { + my @a=split(/\//, $page); + my @b=split(/\//, $common_prefix); + $common_prefix=""; + while (@a && @b && $a[0] eq $b[0]) { + $common_prefix.=shift(@a); + shift @b; + } + } } } + + # Common prefix should not be a page in the map. + while (length $common_prefix && exists $mapitems{$common_prefix}) { + $common_prefix=IkiWiki::dirname($common_prefix); + } # Needs to update whenever a page is added or removed, so # register a dependency. add_depends($params{page}, $params{pages}); # Explicitly add all currently shown pages, to detect when pages # are removed. - add_depends($params{page}, join(" or ", @mapitems)); + add_depends($params{page}, join(" or ", keys %mapitems)); # Create the map. my $parent=""; my $indent=0; my $openli=0; - my $map = "
\n"; - foreach my $item (sort @mapitems) { - my $depth = ($item =~ tr/\//\//); + my $map = "
\n
    \n"; + foreach my $item (sort keys %mapitems) { + $item=~s/^\Q$common_prefix\E\/// if length $common_prefix; + my $depth = ($item =~ tr/\//\//) + 1; my $baseitem=IkiWiki::dirname($item); - while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E/) { + while (length $parent && length $baseitem && $baseitem !~ /^\Q$parent\E(\/|$)/) { $parent=IkiWiki::dirname($parent); $indent--; - $map.="
\n"; + $map .= "\n"; + if ($indent > 0) { + $map .= "\n"; + } } while ($depth < $indent) { $indent--; - $map.="\n"; + $map .= "\n"; + if ($indent > 0) { + $map .= "\n"; + } } + my @bits=split("/", $item); + my $p=""; + $p.="/".shift(@bits) for 1..$indent; while ($depth > $indent) { $indent++; - $map.="
    \n"; + if ($indent > 1) { + $map .= "
      \n"; + } if ($depth > $indent) { - $map .= "
    • \n"; + $p.="/".shift(@bits); + $map .= "
    • " + .htmllink($params{page}, $params{destpage}, $p, class => "mapparent") + ."\n"; $openli=1; } else { @@ -64,14 +101,15 @@ sub preprocess (@) { #{{{ } $map .= "
      • \n" if $openli; $map .= "
    • " - .htmllink($params{page}, $params{destpage}, $item) - ."\n"; + .htmllink($params{page}, $params{destpage}, + "/".$common_prefix."/".$item, class => "mapitem") + ."\n"; $openli=1; $parent=$item; } while ($indent > 0) { $indent--; - $map.="
    \n"; + $map .= "\n
\n"; } $map .= "
\n"; return $map; diff --git a/debian/changelog b/debian/changelog index 3041fad45..377bb41b8 100644 --- a/debian/changelog +++ b/debian/changelog @@ -5,11 +5,12 @@ ikiwiki (2.9) UNRELEASED; urgency=low Closes: #443344 * map: Fully specify paths to links to avoid issues when the bestlink didn't point to the correct page. - * map: Render empty nodes on the way to subpages whose parent pages - are not included in the map. - * map: Fix valid html issue. + * map: Render pages on the way to subpages whose parent pages + are not included in the map. Include special styling for such pages. + * map: Remove common prefixes and don't over-indent. + * Add class option to htmllink(). - -- Joey Hess Fri, 21 Sep 2007 13:28:32 -0400 + -- Joey Hess Sat, 22 Sep 2007 12:31:22 -0400 ikiwiki (2.8) unstable; urgency=low diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 4ec9e8c7b..77f336dca 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -412,7 +412,8 @@ control some options. These are: * forcesubpage - set to force a link to a subpage * linktext - set to force the link text to something * anchor - set to make the link include an anchor -* rel - set to add a rel attribute to the link. +* rel - set to add a rel attribute to the link +* class - set to add a css class to the link #### `readfile($;$)` diff --git a/doc/style.css b/doc/style.css index 0399031f8..0fa15d2b1 100644 --- a/doc/style.css +++ b/doc/style.css @@ -49,6 +49,10 @@ div.tags { margin-top: 1em; } +.mapparent { + text-decoration: none; +} + #backlinks { margin-top: 1em; } -- 2.45.0