diff options
| -rw-r--r-- | IkiWiki/Plugin/linkmap.pm | 106 | ||||
| -rw-r--r-- | debian/changelog | 3 | ||||
| -rw-r--r-- | doc/bugs/rss_feed_cleanup_on_delete.mdwn | 2 | ||||
| -rw-r--r-- | doc/ikiwiki.setup | 2 | ||||
| -rw-r--r-- | doc/plugins/linkmap.mdwn | 23 | ||||
| -rw-r--r-- | doc/todo/link_map.mdwn | 2 | ||||
| -rw-r--r-- | doc/todo/plugin.mdwn | 1 |
7 files changed, 135 insertions, 4 deletions
diff --git a/IkiWiki/Plugin/linkmap.pm b/IkiWiki/Plugin/linkmap.pm new file mode 100644 index 000000000..356306e84 --- /dev/null +++ b/IkiWiki/Plugin/linkmap.pm @@ -0,0 +1,106 @@ +#!/usr/bin/perl +package IkiWiki::Plugin::linkmap; + +use warnings; +use strict; +use IkiWiki; +use IPC::Open2; + +sub import { #{{{ + IkiWiki::hook(type => "preprocess", id => "linkmap", + call => \&preprocess); + IkiWiki::hook(type => "format", id => "linkmap", + call => \&format); +} # }}} + +my $mapnum=0; +my %maps; + +sub preprocess (@) { #{{{ + my %params=@_; + $params{pages}="*" unless defined $params{pages}; + + # Needs to update whenever a page is added or removed, so + # register a dependency. + IkiWiki::add_depends($params{page}, $params{pages}); + + # Can't just return the linkmap here, since the htmlscrubber + # scrubs out all <object> tags (with good reason!) + # Instead, insert a placeholder tag, which will be expanded during + # formatting. + $mapnum++; + $maps{$mapnum}=\%params; + return "<div class=\"linkmap$mapnum\"></div>"; +} # }}} + +sub format (@) { #{{{ + my %params=@_; + + $params{content}=~s/<div class=\"linkmap(\d+)"><\/div>/genmap($1)/eg; + + return $params{content}; +} # }}} + +sub genmap ($) { #{{{ + my $mapnum=shift; + return "" unless exists $maps{$mapnum}; + my %params=%{$maps{$mapnum}}; + + # Get all the items to map. + my %mapitems = (); + foreach my $item (keys %IkiWiki::links) { + if (IkiWiki::pagespec_match($item, $params{pages})) { + my $link=IkiWiki::htmlpage($item); + $link=IkiWiki::abs2rel($link, IkiWiki::dirname($params{page})); + $mapitems{$item}=$link; + } + } + + # Use ikiwiki's function to create the file, this makes sure needed + # subdirs are there and does some sanity checking. + IkiWiki::writefile("$params{page}.png", $IkiWiki::config{destdir}, ""); + + # Run dot to create the graphic and get the map data. + # TODO: should really add the png to renderedfiles and call + # check_overwrite, but currently renderedfiles + # only supports listing one file per page. + my $tries=10; + my $pid; + while (1) { + eval { + $pid=open2(*IN, *OUT, "dot /dev/stdin -Tpng -o '$IkiWiki::config{destdir}/$params{page}.png' -Tcmapx"); + }; + last unless $@; + $tries--; + if ($tries < 1) { + return "failed to run dot: $@"; + } + } + # open2 doesn't respect "use open ':utf8'" + binmode (IN, ':utf8'); + binmode (OUT, ':utf8'); + + print OUT "digraph linkmap$mapnum {\n"; + print OUT "concentrate=true;\n"; + foreach my $item (keys %mapitems) { + print OUT "\"$item\" [shape=box,href=\"$mapitems{$item}\"];\n"; + foreach my $link (map { IkiWiki::bestlink($item, $_) } @{$IkiWiki::links{$item}}) { + print OUT "\"$item\" -> \"$link\";\n" + if $mapitems{$link}; + } + } + print OUT "}\n"; + close OUT; + + local $/=undef; + my $ret="<object data=\"". + IkiWiki::abs2rel("$params{page}.png", IkiWiki::dirname($params{page})). + "\" type=\"image/png\" usemap=\"#linkmap$mapnum\">\n". + <IN>. + "</object>"; + close IN; + waitpid $pid, 0; + return $ret; +} #}}} + +1 diff --git a/debian/changelog b/debian/changelog index 3e7c3e082..0a761c9ec 100644 --- a/debian/changelog +++ b/debian/changelog @@ -8,8 +8,9 @@ ikiwiki (1.25) UNRELEASED; urgency=low * Add support for mercurial, contributed by Emanuele Aina. * Include <link rel> tag for RSS feeds, used by some aggregators and firefox to find the feed. + * Add a linkmap plugin (requires graphviz). - -- Joey Hess <joeyh@debian.org> Wed, 6 Sep 2006 16:42:21 -0400 + -- Joey Hess <joeyh@debian.org> Thu, 7 Sep 2006 00:11:18 -0400 ikiwiki (1.24) unstable; urgency=low diff --git a/doc/bugs/rss_feed_cleanup_on_delete.mdwn b/doc/bugs/rss_feed_cleanup_on_delete.mdwn index 5fe2bcd55..32cdba0cc 100644 --- a/doc/bugs/rss_feed_cleanup_on_delete.mdwn +++ b/doc/bugs/rss_feed_cleanup_on_delete.mdwn @@ -1,2 +1,4 @@ If a page stops inlining anthing, its rss feed file will linger around and not be deleted. + +(The linkmap plugin has the same problem with the png files it creates.) diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index ac84352df..ab5c9eb35 100644 --- a/doc/ikiwiki.setup +++ b/doc/ikiwiki.setup @@ -93,7 +93,7 @@ use IkiWiki::Setup::Standard { # To add plugins, list them here. #add_plugins => [qw{meta tag pagecount brokenlinks search smiley # wikitext camelcase pagestats htmltidy fortune - # sidebar map rst toc}], + # sidebar map rst toc linkmap}], # If you want to disable any of the default plugins, list them here. #disable_plugins => [qw{inline htmlscrubber}], } diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn new file mode 100644 index 000000000..35dcf8f56 --- /dev/null +++ b/doc/plugins/linkmap.mdwn @@ -0,0 +1,23 @@ +[[template id=plugin name=linkmap included=1 author="Joey Hess"]] +[[tag type/meta]] +[[tag type/slow]] +the mapped pages is changed, which can make the wiki a bit slow. +This plugin uses graphviz to generate a graph showing the links between a +set of pages in the wiki. Example usage: + + \[[linkmap pages="* and !blog/* and !*/Discussion"]] + +Only links between mapped pages will be shown; links pointing to or from +unmapped pages will be omitted. If the pages to include are not specified, +the links between all pages (and other files) in the wiki are mapped. For +best results, only a small set of pages should be mapped, since otherwise +the map can become very large, unweildy, and complicated. Also, the map is +rebuilt whenever one of the mapped pages is changed, which can make the +wiki a bit slow. + +This plugin is included in ikiwiki, but is not enabled by default. + +If this plugin is enabled, here is a link map of the index page and all +pages it links to: + +[[linkmap pages="index or (backlink(index) and !*.png)"]] diff --git a/doc/todo/link_map.mdwn b/doc/todo/link_map.mdwn index e7cb0ca2f..a02a792e4 100644 --- a/doc/todo/link_map.mdwn +++ b/doc/todo/link_map.mdwn @@ -3,4 +3,4 @@ An idea: Use graphviz to generate a map of all the links between pages. Graphviz can output image maps. -- ChristofferSawicki -This could be a [[plugin]].
\ No newline at end of file +[[todo/done]] diff --git a/doc/todo/plugin.mdwn b/doc/todo/plugin.mdwn index ae5600477..fdd37d954 100644 --- a/doc/todo/plugin.mdwn +++ b/doc/todo/plugin.mdwn @@ -1,7 +1,6 @@ Suggestions of ideas for plugins: * list of registered users - tricky because it sorta calls for a way to rebuild the page when a new user is registered. Might be better as a cgi? -* a [[link_map]] * [[sigs]] ? * Support [[RecentChanges]] as a regular page containing a plugin that |