Browse Source

Markdown.pl: add a --div option and corresponding API

It can be very convenient to be able to wrap the contents
in its own output "<div>".  Add an option to do that with
an underlying corresponding API option to match.

Signed-off-by: Kyle J. McKay <mackyle@gmail.com>
master
Kyle J. McKay 3 years ago
parent
commit
4e9eba45fa
  1. 40
      Markdown.pl

40
Markdown.pl

@ -359,6 +359,7 @@ sub _main {
'base|b=s' => \$cli_opts{'base'}, 'base|b=s' => \$cli_opts{'base'},
'htmlroot|r=s' => \$cli_opts{'htmlroot'}, 'htmlroot|r=s' => \$cli_opts{'htmlroot'},
'imageroot|i=s' => \$cli_opts{'imageroot'}, 'imageroot|i=s' => \$cli_opts{'imageroot'},
'div:s' => \$cli_opts{'divname'},
'wiki|w:s' => \$cli_opts{'wiki'}, 'wiki|w:s' => \$cli_opts{'wiki'},
'tabwidth|tab-width=s' => \$cli_opts{'tabwidth'}, 'tabwidth|tab-width=s' => \$cli_opts{'tabwidth'},
'autonumber|auto-number' => \$cli_opts{'autonumber'}, 'autonumber|auto-number' => \$cli_opts{'autonumber'},
@ -384,6 +385,8 @@ sub _main {
_SetAllowedTag("menu"); _SetAllowedTag("menu");
} }
my $xmlcheck; my $xmlcheck;
$options{divwrap} = defined($cli_opts{'divname'});
$options{divname} = defined($cli_opts{'divname'}) ? $cli_opts{'divname'} : "";
$options{sanitize} = 1; # sanitize by default $options{sanitize} = 1; # sanitize by default
$options{sanitize} = $cli_opts{'sanitize'} if defined($cli_opts{'sanitize'}); $options{sanitize} = $cli_opts{'sanitize'} if defined($cli_opts{'sanitize'});
$xmlcheck = $options{sanitize} ? 2 : 0; $xmlcheck = $options{sanitize} ? 2 : 0;
@ -675,6 +678,13 @@ sub ProcessRaw {
$text = _SanitizeTags($text, $opt{xmlcheck}, $opt{htmlauto}) if $opt{sanitize}; $text = _SanitizeTags($text, $opt{xmlcheck}, $opt{htmlauto}) if $opt{sanitize};
utf8::encode($text); utf8::encode($text);
if ($opt{divwrap}) {
my $id = $opt{divname};
defined($id) or $id = "";
$id eq "" or $id = ' id="'.escapeXML($id).'"';
chomp($text);
return "<div$id>\n".$text."\n</div>\n";
}
return $text; return $text;
} }
@ -723,6 +733,8 @@ sub ProcessRaw {
# empty_element_suffix => " />" or ">" # empty_element_suffix => " />" or ">"
# will be forced to " />" if not valid or defined. # will be forced to " />" if not valid or defined.
# effective for both ProcessRaw and Markdown. # effective for both ProcessRaw and Markdown.
# divwrap => if true, wrap output contents in <div>...</div>
# divname => if defined and non-empty will be id of divwrap div tag
# urlfunc => if set to a CODE ref, the function will be called with # urlfunc => if set to a CODE ref, the function will be called with
# seven arguments like so: # seven arguments like so:
# $result = &$urlfunc($iresult, \%opts, $tag, $uhost, $uabs, $q, $f) # $result = &$urlfunc($iresult, \%opts, $tag, $uhost, $uabs, $q, $f)
@ -1123,6 +1135,13 @@ sub Markdown {
"<tr>\n$hrows</tr>\n<tr>\n$drows</tr>\n</table>\n"; "<tr>\n$hrows</tr>\n<tr>\n$drows</tr>\n</table>\n";
} }
} }
if ($opt{divwrap}) {
my $id = $opt{divname};
defined($id) or $id = "";
$id eq "" or $id = ' id="'.escapeXML($id).'"';
chomp($text);
return "<div$id>\n".$yamltable.$text."\n</div>\n";
}
return $yamltable.$text; return $yamltable.$text;
} }
@ -4068,6 +4087,7 @@ B<Markdown.pl> [B<--help>] [B<--html4tags>] [B<--htmlroot>=I<prefix>]
-s | --shortversion show just the version number -s | --shortversion show just the version number
--raw | --raw-xml input contains only raw xhtml --raw | --raw-xml input contains only raw xhtml
--raw-html input contains only raw html --raw-html input contains only raw html
--div[=id] wrap body in div with given id
--stylesheet output the fancy style sheet --stylesheet output the fancy style sheet
--no-stylesheet do not output fancy style sheet --no-stylesheet do not output fancy style sheet
--stub wrap output in stub document --stub wrap output in stub document
@ -4589,10 +4609,10 @@ Display the short-form version number.
=item B<--raw>, B<--raw-xml> =item B<--raw>, B<--raw-xml>
Input contains only raw XHTML. All options other than Input contains only raw XHTML. All options other than B<--html4tags>,
B<--html4tags>, B<--deprecated>, B<--sanitize> (on by default), B<--deprecated>, B<--sanitize> (on by default), B<--strip-comments>,
B<--strip-comments>, B<--validate-xml> and B<--validate-xml-internal> B<--div>, B<--validate-xml> and B<--validate-xml-internal> (and
(and their B<--no-...> variants) are ignored. their B<--no-...> variants) are ignored.
With this option, arbitrary XHTML input can be passed through With this option, arbitrary XHTML input can be passed through
the sanitizer and/or validator. If sanitation is requested (the the sanitizer and/or validator. If sanitation is requested (the
@ -4643,6 +4663,18 @@ Remember that any B<--stub> and/or B<--stylesheet> options are
I<completely ignored> when B<--raw-html> is given. I<completely ignored> when B<--raw-html> is given.
=item B<--div>[=I<divname>]
Wrap the output contents in a C<div> tag. If I<divname> is given the
tag will have that C<id> attribute value. If the B<--stub> option and/or
the B<--stylesheet> option are active, they are applied I<after> wrapping
the output contents in the C<div>. Note that if a YAML table ends up
being generated, it I<will> be included I<inside> the C<div> wrapper.
In contrast to the B<--stylesheet> and B<--stub> options, this option
I<is> allowed with the B<--raw-xml> and B<--raw-html> options.
=item B<--stylesheet> =item B<--stylesheet>
Include the fancy style sheet at the beginning of the output (or in the Include the fancy style sheet at the beginning of the output (or in the

Loading…
Cancel
Save