* Add a linkmap plugin (requires graphviz).

5 files changed, 27 insertions, 3 deletions

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