* Add toc (table of contents) plugin.

IkiWiki/Plugin/skeleton.pm

@@ -21,6 +21,8 @@ sub import { #{{{
 		call => \&htmlize);
 	IkiWiki::hook(type => "sanitize", id => "skeleton", 
 		call => \&sanitize);
+	IkiWiki::hook(type => "format", id => "skeleton", 
+		call => \&format);
 	IkiWiki::hook(type => "pagetemplate", id => "skeleton", 
 		call => \&pagetemplate);
 	IkiWiki::hook(type => "delete", id => "skeleton", 
@@ -71,6 +73,14 @@ sub sanitize ($) { #{{{
 	return $content;
 } # }}}
 
+sub format ($) { #{{{
+	my $content=shift;
+	
+	IkiWiki::debug("skeleton plugin running as a formatter");
+
+	return $content;
+} # }}}
+
 sub pagetemplate (@) { #{{{
 	my %params=@_;
 	my $page=$params{page};

IkiWiki/Plugin/toc.pm

@@ -0,0 +1,116 @@
+#!/usr/bin/perl
+# Table Of Contents generator
+package IkiWiki::Plugin::toc;
+
+use warnings;
+use strict;
+use IkiWiki;
+use HTML::Parser;
+
+sub import { #{{{
+	IkiWiki::hook(type => "preprocess", id => "toc",
+		call => \&preprocess);
+	IkiWiki::hook(type => "format", id => "toc",
+		call => \&format);
+} # }}}
+
+my @tocs;
+
+sub preprocess (@) { #{{{
+	my %params=@_;
+
+	$params{levels}=1 unless exists $params{levels};
+
+	# It's too early to generate the toc here, so just record the
+	# info.
+	push @tocs, \%params;
+
+	return "\n[[toc $#tocs]]\n";
+} # }}}
+
+sub format ($) { #{{{
+	my $content=shift;
+	
+	return $content unless @tocs && $content=~/\[\[toc (\d+)\]\]/ && $#tocs >= $1;
+	my $id=$1;
+	my %params=%{$tocs[$id]};
+
+	my $p=HTML::Parser->new(api_version => 3);
+	my $page="";
+	my $index="";
+	my %anchors;
+	my $curlevel;
+	my $startlevel=0;
+	my $liststarted=0;
+	my $indent=sub { "\t" x $curlevel };
+	$p->handler(start => sub {
+		my $tagname=shift;
+		my $text=shift;
+		if ($tagname =~ /^h(\d+)$/i) {
+			my $level=$1;
+			my $anchor="index".++$anchors{$level}."h$level";
+			$page.="$text<a name=\"$anchor\" />";
+	
+			# Take the first header level seen as the topmost level,
+			# even if there are higher levels seen later on.
+			if (! $startlevel) {
+				$startlevel=$level;
+				$curlevel=$startlevel-1;
+			}
+			elsif ($level < $startlevel) {
+				$level=$startlevel;
+			}
+			
+			return if $level - $startlevel >= $params{levels};
+	
+			if ($level > $curlevel) {
+				while ($level > $curlevel + 1) {
+					$index.=&$indent."<ol>\n";
+					$curlevel++;
+					$index.=&$indent."<li class=\"L$curlevel\">\n";
+				}
+				$index.=&$indent."<ol>\n";
+				$curlevel=$level;
+				$liststarted=1;
+			}
+			elsif ($level < $curlevel) {
+				while ($level < $curlevel) {
+					$index.=&$indent."</li>\n" if $curlevel;
+					$curlevel--;
+					$index.=&$indent."</ol>\n";
+				}
+				$liststarted=0;
+			}
+	
+			$p->handler(text => sub {
+				$page.=join("", @_);
+				$index.=&$indent."</li>\n" unless $liststarted;
+				$liststarted=0;
+				$index.=&$indent."<li class=\"L$curlevel\">".
+					"<a href=\"#$anchor\">".
+					join("", @_).
+					"</a>\n";
+				$p->handler(text => undef);
+			}, "dtext");
+		}
+		else {
+			$page.=$text;
+		}
+	}, "tagname, text");
+	$p->handler(default => sub { $page.=join("", @_) }, "text");
+	$p->parse($content);
+	$p->eof;
+
+	while ($startlevel && $curlevel >= $startlevel) {
+		$index.=&$indent."</li>\n" if $curlevel;
+		$curlevel--;
+		$index.=&$indent."</ol>\n";
+	}
+
+	# Ignore cruft around the toc marker, probably <p> tags added by
+	# markdown which shouldn't appear in a list anyway.
+	$page=~s/\n.*\[\[toc $id\]\].*\n/$index/;
+	return $page;
+}
+
+1

Makefile.PL

@@ -24,7 +24,7 @@ extra_build:
 		--plugin=orphans --plugin=haiku --plugin=meta \
 		--plugin=tag --plugin=polygen --plugin=pagestats \
 		--plugin=fortune --plugin=aggregate --plugin=map \
-		--plugin=template
+		--plugin=template --plugin=toc
 	./mdwn2man ikiwiki 1 doc/usage.mdwn > ikiwiki.man
 	./mdwn2man ikiwiki-mass-rebuild 8 doc/ikiwiki-mass-rebuild.mdwn > ikiwiki-mass-rebuild.man
 		

debian/changelog

@@ -40,8 +40,9 @@ ikiwiki (1.22) UNRELEASED; urgency=low
   * Factor out the cgi header printing code into a new function.
   * Fix preferences page on anonok wikis; still need to sign in to get
     to the preferences page.
+  * Add toc (table of contents) plugin.
 
- -- Joey Hess <joeyh@debian.org>  Sun, 27 Aug 2006 16:17:21 -0400
+ -- Joey Hess <joeyh@debian.org>  Mon, 28 Aug 2006 02:31:56 -0400
 
 ikiwiki (1.21) unstable; urgency=low
 

doc/features.mdwn

@@ -1,6 +1,7 @@
-Some of ikiwiki's features:
+An overview of some of ikiwiki's features:
+[[toc ]]
 
-* Uses a real RCS
+## Uses a real RCS
 
 Rather than implement its own system for storing page histories etc,
 ikiwiki uses a real RCS. This isn't because we're lazy, it's because a
@@ -19,7 +20,7 @@ Some of ikiwiki's features:
 Note that ikiwiki does not require a RCS to function. If you want to
 run a simple wiki without page history, it can do that too.
 
-* Supports many markup languages
+## Supports many markup languages
 
 By default, pages in the wiki are written using the [[MarkDown]] format.
 Any page with a filename ending in ".mdwn" is converted from markdown to html
@@ -33,20 +34,20 @@ Some of ikiwiki's features:
 [[plugins/WikiText]] formatted pages, pages written as pure
 [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]].
 
-* support for other file types
+## support for other file types
 
 ikiwiki also supports files of any other type, including plain text,
 images, etc. These are not converted to wiki pages, they are just copied
 unchanged by ikiwiki as it builds your wiki. So you can check in an image,
 program, or other special file and link to it from your wiki pages.
 
-* Fast compiler
+## Fast compiler
 
 ikiwiki is fast and smart about updating a wiki, it only builds pages
 that have changed (and tracks things like creation of new pages and links
 that can indirectly cause a page to need a rebuild)
 
-* [[blogging|blog]]
+## [[blogging|blog]]
 
 You can turn any page in the wiki into a [[blog]]. Pages matching a
 specified [[PageSpec]] will be displayed as a weblog within the blog
@@ -59,52 +60,52 @@ Some of ikiwiki's features:
 the wiki. This can be used to create a Planet type site that aggregates
 interesting feeds.
 
-* [[tags]]
+## [[tags]]
 
 You can tag pages and use these tags in various ways. Tags will show
 up in the ways you'd expect, like at the bottom of pages, in blogs, and
 in rss feeds.
 
-* valid html and css
+## valid html and css
 
 ikiwiki aims to produce 
 [valid XHTML 1.0](http://validator.w3.org/check?url=referer).
 ikiwiki generates html using [[templates]], and uses css, so you can 
 change the look and layout of all pages in any way you would like.
 
-* [[SubPages|SubPage]]
+## [[SubPages|SubPage]]
 
 Arbitrarily deep hierarchies of pages with fairly simple and useful
 [[SubPage/LinkingRules]]
 
-* [[BackLinks]]
+## [[BackLinks]]
 
 Automatically included on pages. Rather faster than eg MoinMoin and
 always there to help with navigation.
 
-* [[PageHistory]]
+## [[PageHistory]]
 
 Well, sorta. Rather than implementing YA history browser, it can link to
 [[ViewCVS]] or the like to browse the history of a wiki page.
 
-* [[RecentChanges]], editing pages in a web browser
+## [[RecentChanges]], editing pages in a web browser
 
 Nearly the definition of a wiki, although perhaps ikiwiki challenges how
 much of that web gunk a wiki really needs. These features are optional
 and can be enabled by enabling [[CGI]].
 
-* User registration
+## User registration
 
 Can optionally be configured to allow only registered users to post
 pages; online user registration form, etc.
 
-* Discussion pages
+## Discussion pages
 
 Thanks to subpages, every page can easily and automatically have a
 /Discussion subpage. By default, these links are included in the
 [[templates]] for each page.
 
-* Smart merging and conflict resolution in your web browser
+## Smart merging and conflict resolution in your web browser
 
 Since it uses a real RCS, ikiwiki takes advantage of its smart merging to
 avoid any conflicts when two people edit different parts of the same page
@@ -117,21 +118,21 @@ Some of ikiwiki's features:
 shown in the file to resolve the conflict, so if you're already familiar
 with that there's no new commit marker syntax to learn.
 
-* page locking
+## page locking
 
 Wiki admins can lock pages so that only other admins can edit them.
 
-* Full text search
+## Full text search
 
 ikiwiki can use the [[HyperEstraier]] search engine to add powerful
 full text search capabilities to your wiki.
 
-* Commit mails
+## Commit mails
 
 ikiwiki can be configured to send you commit mails with diffs of changes
 to selected pages.
 
-* [[Plugins]]
+## [[Plugins]]
 
 Plugins can be used to add additional features to ikiwiki. The interface
 is quite flexible, allowing plugins to implement additional markup
@@ -140,16 +141,12 @@ Some of ikiwiki's features:
 Ikiwiki's backend RCS support is also pluggable, so support for new
 revision control systems can be added to ikiwiki. 
 
-* [[todo/utf8]]
+## [[todo/utf8]]
 
 After rather a lot of fiddling, we think that ikiwiki correctly and fully
 supports utf8 everywhere.
 
-* [[w3mmode]]
+## [[w3mmode]]
 
 Can be set up so that w3m can be used to browse a wiki and edit pages
 without using a web server.
-
-----
-
-It also has some [[TODO]] items and [[Bugs]].

doc/ikiwiki.setup

@@ -83,7 +83,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}],
+	#                   sidebar map rst toc}],
 	# If you want to disable any of the default plugins, list them here.
 	#disable_plugins => [qw{inline htmlscrubber}],
 }

doc/plugins/toc.mdwn

@@ -0,0 +1,13 @@
+[[template id=plugin name=toc included=1 author="Joey Hess"]]
+[[tag type/chrome]]
+
+Add a table of contents be to a page:
+
+	\[[toc ]]
+
+The table of contents will be automatically generated based on the
+headers of the page. By default only the largest headers present on the
+page will be shown; to control how many levels of headers are shown, use
+the `levels` parameter:
+
+	\[[toc levels=2]]

doc/security.mdwn

@@ -6,6 +6,8 @@ security issues with this program than with cat(1). If, however, you let
 others edit pages in your wiki, then some possible security issues do need
 to be kept in mind.
 
+[[toc levels=2]]
+
 ----
 
 # Probable holes

doc/todo/pageindexes.mdwn

@@ -1,3 +1,5 @@
 Might be nice to support automatically generating an index based on headers
 in a page, for long pages. This could be done as a sanitize hook that
 parsed the html, with a preprocessordirective that controlled it.
+
+[[todo/done]]

t/html.t

@@ -6,7 +6,7 @@ use Test::More;
 my @pages;
 
 BEGIN {
-	@pages=qw(index todo features news plugins/map);
+	@pages=qw(index todo features news plugins/map security);
 	if (! -x "/usr/bin/validate") {
 		plan skip_all => "/usr/bin/validate html validator not present";
 	}