we should prefer existing IDs and only act as a fallback

[git.ikiwiki.info.git] / IkiWiki / Plugin / mdwn.pm

diff --git a/IkiWiki/Plugin/mdwn.pm b/IkiWiki/Plugin/mdwn.pm
index 920d90e5e5eb8f81abf8560f402cd8d849e4c72b..9f06c03f2ec05678e0426a723a352eab7475313c 100644 (file)
--- a/IkiWiki/Plugin/mdwn.pm
+++ b/IkiWiki/Plugin/mdwn.pm
@@ -4,26 +4,60 @@ package IkiWiki::Plugin::mdwn;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
+       hook(type => "checkconfig", id => "mdwn", call => \&checkconfig);
        hook(type => "getsetup", id => "mdwn", call => \&getsetup);
-       hook(type => "htmlize", id => "mdwn", call => \&htmlize);
-} # }}}
+       hook(type => "htmlize", id => "mdwn", call => \&htmlize, longname => "Markdown");
+       hook(type => "htmlize", id => "md", call => \&htmlize, longname => "Markdown (popular file extension)", nocreate => 1);
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 1, # format plugin
+                       section => "format",
+               },
                multimarkdown => {
                        type => "boolean",
-                       default => 0,
-                       description => "enable use of multimarkdown features",
+                       example => 0,
+                       description => "enable multimarkdown features?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               nodiscount => {
+                       type => "boolean",
+                       example => 0,
+                       description => "disable use of markdown discount?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               mdwn_footnotes => {
+                       type => "boolean",
+                       example => 1,
+                       description => "enable footnotes in Markdown (where supported)?",
+                       safe => 1,
+                       rebuild => 1,
+               },
+               mdwn_alpha_lists => {
+                       type => "boolean",
+                       example => 0,
+                       description => "interpret line like 'A. First item' as ordered list when using Discount?",
+                       advanced => 1,
                        safe => 1,
                        rebuild => 1,
                },
-} #}}}
+}
+
+sub checkconfig () {
+       $config{mdwn_footnotes} = 1 unless defined $config{mdwn_footnotes};
+       $config{mdwn_alpha_lists} = 0 unless defined $config{mdwn_alpha_lists};
+}
 
 my $markdown_sub;
-sub htmlize (@) { #{{{
+sub htmlize (@) {
        my %params=@_;
        my $content = $params{content};
 
@@ -39,8 +73,60 @@ sub htmlize (@) { #{{{
                        if ($@) {
                                debug(gettext("multimarkdown is enabled, but Text::MultiMarkdown is not installed"));
                        }
-                       $markdown_sub=sub {
-                               Text::MultiMarkdown::markdown(shift, {use_metadata => 0});
+                       else {
+                               $markdown_sub=sub {
+                                       my %flags=( use_metadata => 0 );
+
+                                       if ($config{mdwn_footnotes}) {
+                                               $flags{disable_footnotes}=1;
+                                       }
+
+                                       Text::MultiMarkdown::markdown(shift, \%flags);
+                               }
+                       }
+               }
+               if (! defined $markdown_sub &&
+                   (! exists $config{nodiscount} || ! $config{nodiscount})) {
+                       eval q{use Text::Markdown::Discount};
+                       if (! $@) {
+                               $markdown_sub=sub {
+                                       my $t=shift;
+
+                                       # Workaround for discount binding bug
+                                       # https://rt.cpan.org/Ticket/Display.html?id=73657
+                                       return "" if $t=~/^\s*$/;
+
+                                       my $flags=0;
+
+                                       # Disable Pandoc-style % Title, % Author, % Date
+                                       # Use the meta plugin instead
+                                       $flags |= Text::Markdown::Discount::MKD_NOHEADER();
+
+                                       # Disable Unicodification of quote marks, em dashes...
+                                       # Use the typography plugin instead
+                                       $flags |= Text::Markdown::Discount::MKD_NOPANTS();
+
+                                       if ($config{mdwn_footnotes}) {
+                                               $flags |= Text::Markdown::Discount::MKD_EXTRA_FOOTNOTE();
+                                       }
+
+                                       unless ($config{mdwn_alpha_lists}) {
+                                               $flags |= Text::Markdown::Discount::MKD_NOALPHALIST();
+                                       }
+
+                                       # Workaround for discount's eliding
+                                       # of <style> blocks.
+                                       # https://rt.cpan.org/Ticket/Display.html?id=74016
+                                       if (Text::Markdown::Discount->can("MKD_NOSTYLE")) {
+                                               $flags |= Text::Markdown::Discount::MKD_NOSTYLE();
+                                       }
+                                       else {
+                                               # This is correct for the libmarkdown.so.2 ABI
+                                               $flags |= 0x00400000;
+                                       }
+
+                                       return Text::Markdown::Discount::markdown($t, $flags);
+                               }
                        }
                }
                if (! defined $markdown_sub) {
@@ -59,8 +145,9 @@ sub htmlize (@) { #{{{
                                        $markdown_sub=\&Markdown::Markdown;
                                }
                                else {
+                                       my $error = $@;
                                        do "/usr/bin/markdown" ||
-                                               error(sprintf(gettext("failed to load Markdown.pm perl module (%s) or /usr/bin/markdown (%s)"), $@, $!));
+                                               error(sprintf(gettext("failed to load Markdown.pm perl module (%s) or /usr/bin/markdown (%s)"), $error, $!));
                                        $markdown_sub=\&Markdown::Markdown;
                                }
                        }
@@ -79,6 +166,6 @@ sub htmlize (@) { #{{{
        $content=Encode::decode_utf8($content);
 
        return $content;
-} # }}}
+}
 
 1