add plugin safe/rebuild info (part 3 of 3)
[ikiwiki.git] / IkiWiki / Plugin / tag.pm
index 3de09a7672641ec471eb147038fd6a9672a3e0e3..74d187cd2d8e132756e9c2f4666b73a0b519510d 100644 (file)
@@ -4,37 +4,53 @@ package IkiWiki::Plugin::tag;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 2.00;
 
 my %tags;
 
 sub import { #{{{
-       IkiWiki::hook(type => "getopt", id => "tag",
-               call => \&getopt);
-       IkiWiki::hook(type => "preprocess", id => "tag",
-               call => \&preprocess);
-       IkiWiki::hook(type => "pagetemplate", id => "tag",
-               call => \&pagetemplate);
+       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 () { #{{{
        eval q{use Getopt::Long};
+       error($@) if $@;
        Getopt::Long::Configure('pass_through');
-       GetOptions("tagbase=s" => \$IkiWiki::config{tagbase});
+       GetOptions("tagbase=s" => \$config{tagbase});
+} #}}}
+
+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+               tagbase => {
+                       type => "string",
+                       example => "tag",
+                       description => "parent page tags are located under",
+                       safe => 1,
+                       rebuild => 1,
+               },
 } #}}}
 
 sub tagpage ($) { #{{{
        my $tag=shift;
                        
-       if (exists $IkiWiki::config{tagbase} &&
-           defined $IkiWiki::config{tagbase}) {
-               $tag=$IkiWiki::config{tagbase}."/".$tag;
+       if ($tag !~ m{^\.?/} &&
+           exists $config{tagbase} &&
+           defined $config{tagbase}) {
+               $tag=$config{tagbase}."/".$tag;
        }
 
        return $tag;
 } #}}}
 
-sub preprocess (@) { #{{{
+sub preprocess_tag (@) { #{{{
        if (! @_) {
                return "";
        }
@@ -42,17 +58,45 @@ sub preprocess (@) { #{{{
        my $page = $params{page};
        delete $params{page};
        delete $params{destpage};
+       delete $params{preview};
 
-       $tags{$page} = [];
        foreach my $tag (keys %params) {
-               push @{$tags{$page}}, $tag;
+               $tag=IkiWiki::linkpage($tag);
+               $tags{$page}{$tag}=1;
                # hidden WikiLink
-               push @{$IkiWiki::links{$page}}, tagpage($tag);
+               push @{$links{$page}}, tagpage($tag);
        }
                
        return "";
 } # }}}
 
+sub preprocess_taglink (@) { #{{{
+       if (! @_) {
+               return "";
+       }
+       my %params=@_;
+       return join(" ", map {
+               if (/(.*)\|(.*)/) {
+                       my $tag=IkiWiki::linkpage($2);
+                       $tags{$params{page}}{$tag}=1;
+                       push @{$links{$params{page}}}, tagpage($tag);
+                       return htmllink($params{page}, $params{destpage},
+                               tagpage($tag),
+                               linktext => IkiWiki::pagetitle($1));
+               }
+               else {
+                       my $tag=IkiWiki::linkpage($_);
+                       $tags{$params{page}}{$tag}=1;
+                       push @{$links{$params{page}}}, tagpage($tag);
+                       return htmllink($params{page}, $params{destpage},
+                               tagpage($tag));
+               }
+       }
+       grep {
+               $_ ne 'page' && $_ ne 'destpage' && $_ ne 'preview'
+       } keys %params);
+} # }}}
+
 sub pagetemplate (@) { #{{{
        my %params=@_;
        my $page=$params{page};
@@ -61,14 +105,16 @@ sub pagetemplate (@) { #{{{
 
        $template->param(tags => [
                map { 
-                       link => IkiWiki::htmllink($page, $destpage, tagpage($_))
-               }, @{$tags{$page}}
-       ]) if exists $tags{$page} && @{$tags{$page}} && $template->query(name => "tags");
+                       link => htmllink($page, $destpage, tagpage($_),
+                                       rel => "tag")
+               }, sort keys %{$tags{$page}}
+       ]) if exists $tags{$page} && %{$tags{$page}} && $template->query(name => "tags");
 
-       if ($template->query(name => "pubdate")) {
-               # It's an rss template. Add any categories.
-               if (exists $tags{$page} && @{$tags{$page}}) {
-                       $template->param(categories => [map { category => $_ }, @{$tags{$page}}]);
+       if ($template->query(name => "categories")) {
+               # It's an rss/atom template. Add any categories.
+               if (exists $tags{$page} && %{$tags{$page}}) {
+                       $template->param(categories => [map { category => $_ },
+                               sort keys %{$tags{$page}}]);
                }
        }
 } # }}}