]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/tag.pm
Automatically create tag pages,
[ikiwiki.git] / IkiWiki / Plugin / tag.pm
index c4a1756779126c53a265f9e40c82dcdc97c7a52c..6c43a053d3abde7709bed74b43c5ad47d48a2a0e 100644 (file)
@@ -4,26 +4,26 @@ package IkiWiki::Plugin::tag;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 my %tags;
 
-sub import { #{{{
+sub import {
        hook(type => "getopt", id => "tag", call => \&getopt);
        hook(type => "getsetup", id => "tag", call => \&getsetup);
        hook(type => "preprocess", id => "tag", call => \&preprocess_tag, scan => 1);
        hook(type => "preprocess", id => "taglink", call => \&preprocess_taglink, scan => 1);
        hook(type => "pagetemplate", id => "tag", call => \&pagetemplate);
-} # }}}
+}
 
-sub getopt () { #{{{
+sub getopt () {
        eval q{use Getopt::Long};
        error($@) if $@;
        Getopt::Long::Configure('pass_through');
        GetOptions("tagbase=s" => \$config{tagbase});
-} #}}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
                plugin => {
                        safe => 1,
@@ -36,35 +36,52 @@ sub getsetup () { #{{{
                        safe => 1,
                        rebuild => 1,
                },
-} #}}}
+               tag_autocreate => {
+                       type => "boolean",
+                       example => 0,
+                       description => "Autocreate new tag pages",
+                       safe => 1,
+                       rebuild => 1,
+               },
+}
 
-sub tagpage ($) { #{{{
+sub tagpage ($) {
        my $tag=shift;
                        
        if ($tag !~ m{^\.?/} &&
            defined $config{tagbase}) {
                $tag="/".$config{tagbase}."/".$tag;
+               $tag=~y#/#/#s; # squash dups
        }
 
        return $tag;
-} #}}}
+}
 
-sub taglink ($$$;@) { #{{{
+sub taglink ($$$;@) {
        my $page=shift;
        my $destpage=shift;
        my $tag=shift;
        my %opts=@_;
 
-       my $link=tagpage($tag);
+       return htmllink($page, $destpage, tagpage($tag), %opts);
+}
+
+sub gentag ($) {
+       my $tag=shift;
+       if (defined $config{tag_autocreate} && $config{tag_autocreate}) {
+               my $tagfile = newpagefile(tagpage($tag), $config{default_pageext});
+               $tagfile=~s/^\///;
+               return if (srcfile($tagfile,1));
 
-       # Force tag creation links to create the tag under /tagbase,
-       # if there is a tagbase and this tag used it.
-       $link="/".$link if $tag ne $link;
+               debug(sprintf(gettext("creating tag page %s"), $tag));
 
-       return htmllink($page, $destpage, $link, %opts);
-} #}}}
+               my $template=template("autotag.tmpl");
+               $template->param(tag => $tag);
+               writefile($tagfile, $config{srcdir}, $template->output);
+       }
+}
 
-sub preprocess_tag (@) { #{{{
+sub preprocess_tag (@) {
        if (! @_) {
                return "";
        }
@@ -77,14 +94,18 @@ sub preprocess_tag (@) { #{{{
        foreach my $tag (keys %params) {
                $tag=linkpage($tag);
                $tags{$page}{$tag}=1;
+
+               # add tagpage if necessary
+               gentag($tag);
+
                # hidden WikiLink
-               push @{$links{$page}}, tagpage($tag);
+               add_link($page, tagpage($tag));
        }
                
        return "";
-} # }}}
+}
 
-sub preprocess_taglink (@) { #{{{
+sub preprocess_taglink (@) {
        if (! @_) {
                return "";
        }
@@ -93,23 +114,23 @@ sub preprocess_taglink (@) { #{{{
                if (/(.*)\|(.*)/) {
                        my $tag=linkpage($2);
                        $tags{$params{page}}{$tag}=1;
-                       push @{$links{$params{page}}}, tagpage($tag);
+                       add_link($params{page}, tagpage($tag));
                        return taglink($params{page}, $params{destpage}, $tag,
                                linktext => pagetitle($1));
                }
                else {
                        my $tag=linkpage($_);
                        $tags{$params{page}}{$tag}=1;
-                       push @{$links{$params{page}}}, tagpage($tag);
+                       add_link($params{page}, tagpage($tag));
                        return taglink($params{page}, $params{destpage}, $tag);
                }
        }
        grep {
                $_ ne 'page' && $_ ne 'destpage' && $_ ne 'preview'
        } keys %params);
-} # }}}
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params=@_;
        my $page=$params{page};
        my $destpage=$params{destpage};
@@ -128,6 +149,14 @@ sub pagetemplate (@) { #{{{
                                sort keys %{$tags{$page}}]);
                }
        }
-} # }}}
+}
+
+package IkiWiki::PageSpec;
+
+sub match_tagged ($$;@) {
+       my $page = shift;
+       my $glob = shift;
+       return match_link($page, IkiWiki::Plugin::tag::tagpage($glob));
+}
 
 1