]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/shortcut.pm
switch preprocess hooks to use error function
[ikiwiki.git] / IkiWiki / Plugin / shortcut.pm
index d09d5879d27b5f5c640bedf259b65a0ee1e426ec..8df60cfe2a34b5e428e1eafcae88ac9c71a3c0ed 100644 (file)
@@ -3,7 +3,7 @@ package IkiWiki::Plugin::shortcut;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 2.00;
 
 sub import { #{{{
        hook(type => "checkconfig", id => "shortcut", call => \&checkconfig);
@@ -13,26 +13,32 @@ sub import { #{{{
 sub checkconfig () { #{{{
        # Preprocess the shortcuts page to get all the available shortcuts
        # defined before other pages are rendered.
-       IkiWiki::preprocess("shortcuts", "shortcuts",
-               readfile(srcfile("shortcuts.mdwn")));
+       my $srcfile=srcfile("shortcuts.mdwn", 1);
+       if (! defined $srcfile) {
+               error(gettext("shortcut plugin will not work without a shortcuts.mdwn"));
+       }
+       IkiWiki::preprocess("shortcuts", "shortcuts", readfile($srcfile));
 } # }}}
 
 sub preprocess_shortcut (@) { #{{{
        my %params=@_;
 
        if (! defined $params{name} || ! defined $params{url}) {
-               return "[[shortcut missing name or url parameter]]";
+               error gettext("missing name or url parameter");
        }
 
        hook(type => "preprocess", no_override => 1, id => $params{name},
-               call => sub { shortcut_expand($params{name}, $params{url}, @_) });
+               call => sub { shortcut_expand($params{url}, $params{desc}, @_) });
 
-       return "shortcut $params{name} points to $params{url}";
+       #translators: This is used to display what shortcuts are defined.
+       #translators: First parameter is the name of the shortcut, the second
+       #translators: is an URL.
+       return sprintf(gettext("shortcut %s points to <i>%s</i>"), $params{name}, $params{url});
 } # }}}
 
 sub shortcut_expand ($$@) { #{{{
-       my $name=shift;
        my $url=shift;
+       my $desc=shift;
        my %params=@_;
 
        # Get params in original order.
@@ -51,8 +57,22 @@ sub shortcut_expand ($$@) { #{{{
        my $encoded_text=$text;
        $encoded_text=~s/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg;
        
-       $url=~s/\%s/$encoded_text/g;
-       return "<a href=\"$url\">$text</a>";
+       $url=~s{\%([sS])}{
+               $1 eq 's' ? $encoded_text : $text
+       }eg;
+
+       $text=~s/_/ /g;
+       if (defined $params{desc}) {
+               $desc=$params{desc};
+       }
+       if (defined $desc) {
+               $desc=~s/\%s/$text/g;
+       }
+       else {
+               $desc=$text;
+       }
+
+       return "<a href=\"$url\">$desc</a>";
 } #}}}
 
 1