summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--IkiWiki/Plugin/autoindex.pm55
-rw-r--r--IkiWiki/Plugin/skeleton.pm.example5
-rw-r--r--doc/plugins/autoindex.mdwn7
-rw-r--r--templates/autoindex.tmpl1
4 files changed, 68 insertions, 0 deletions
diff --git a/IkiWiki/Plugin/autoindex.pm b/IkiWiki/Plugin/autoindex.pm
new file mode 100644
index 000000000..0a8d90701
--- /dev/null
+++ b/IkiWiki/Plugin/autoindex.pm
@@ -0,0 +1,55 @@
+#!/usr/bin/perl
+package IkiWiki::Plugin::autoindex;
+
+use warnings;
+use strict;
+use IkiWiki 2.00;
+use Encode;
+
+sub import { #{{{
+ hook(type => "refresh", id => "autoindex", call => \&refresh);
+} # }}}
+
+sub genindex ($) { #{{{
+ my $page=shift;
+ my $file=$page.".".$config{default_pageext};
+ my $template=template("autoindex.tmpl");
+ $template->param(page => $page);
+ writefile($file, $config{srcdir}, $template->output);
+} #}}}
+
+sub refresh () { #{{{
+ eval q{use File::Find};
+ error($@) if $@;
+
+ my (%pages, %dirs);
+ find({
+ no_chdir => 1,
+ wanted => sub {
+ $_=decode_utf8($_);
+ if (IkiWiki::file_pruned($_, $config{srcdir})) {
+ $File::Find::prune=1;
+ }
+ elsif (! -l $_) {
+ my ($f)=/$config{wiki_file_regexp}/; # untaint
+ return unless defined $f;
+ $f=~s/^\Q$config{srcdir}\E\/?//;
+ return unless length $f;
+ if (! -d _) {
+ $pages{pagename($f)}=1;
+ }
+ else {
+ $dirs{$f}=1;
+ }
+ }
+ }
+ }, $config{srcdir});
+
+ foreach my $dir (keys %dirs) {
+ if (! exists $pages{$dir}) {
+ genindex($dir);
+ }
+ }
+} #}}}
+
+1
diff --git a/IkiWiki/Plugin/skeleton.pm.example b/IkiWiki/Plugin/skeleton.pm.example
index 1af8e4e9d..10c7002e4 100644
--- a/IkiWiki/Plugin/skeleton.pm.example
+++ b/IkiWiki/Plugin/skeleton.pm.example
@@ -11,6 +11,7 @@ use IkiWiki 2.00;
sub import { #{{{
hook(type => "getopt", id => "skeleton", call => \&getopt);
hook(type => "checkconfig", id => "skeleton", call => \&checkconfig);
+ hook(type => "refresh", id => "skeleton", call => \&refresh);
hook(type => "needsbuild", id => "skeleton", call => \&needsbuild);
hook(type => "preprocess", id => "skeleton", call => \&preprocess);
hook(type => "filter", id => "skeleton", call => \&filter);
@@ -42,6 +43,10 @@ sub checkconfig () { #{{{
debug("skeleton plugin checkconfig");
} #}}}
+sub refresh () { #{{{
+ debug("skeleton plugin refresh");
+} #}}}
+
sub needsbuild () { #{{{
debug("skeleton plugin needsbuild");
} #}}}
diff --git a/doc/plugins/autoindex.mdwn b/doc/plugins/autoindex.mdwn
new file mode 100644
index 000000000..66e0163c2
--- /dev/null
+++ b/doc/plugins/autoindex.mdwn
@@ -0,0 +1,7 @@
+[[!template id=plugin name=autoindex core=0 author="[[Joey]]"]]
+[[!tag type/useful]]
+
+This plugin searches for [[SubPages|ikiwiki/subpage]] with a missing parent
+page, and generates a parent page for them. The generated page content is
+controlled by the autoindex [[template|wikitemplates]], which by default,
+uses a [[map]] to list the SubPages.
diff --git a/templates/autoindex.tmpl b/templates/autoindex.tmpl
new file mode 100644
index 000000000..d5ec3b8ee
--- /dev/null
+++ b/templates/autoindex.tmpl
@@ -0,0 +1 @@
+[[!map pages="<TMPL_VAR PAGE>/* and ! <TMPL_VAR PAGE>/*/*"]]