/usr/share/perl5/Pod/Simple/Wiki/Mediawiki.pm is in libpod-simple-wiki-perl 0.15-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 | package Pod::Simple::Wiki::Mediawiki;
###############################################################################
#
# Pod::Simple::Wiki::Mediawiki - A class for creating Pod to MediaWiki filters.
#
#
# Copyright 2003-2012, John McNamara, jmcnamara@cpan.org
#
# Documentation after __END__
#
# perltidy with the following options: -mbl=2 -pt=0 -nola
use Pod::Simple::Wiki;
use strict;
use vars qw(@ISA $VERSION);
@ISA = qw(Pod::Simple::Wiki);
$VERSION = '0.15';
###############################################################################
#
# The tag to wiki mappings.
#
my $tags = {
'<b>' => "'''",
'</b>' => "'''",
'<i>' => "''",
'</i>' => "''",
'<tt>' => '<tt>',
'</tt>' => '</tt>',
'<pre>' => "<code>\n",
'</pre>' => "\n</code>\n",
'<h1>' => '==',
'</h1>' => "==\n",
'<h2>' => '===',
'</h2>' => "===\n",
'<h3>' => '====',
'</h3>' => "====\n",
'<h4>' => '=====',
'</h4>' => "=====\n",
};
###############################################################################
#
# The default module options
#
my $default_opts = {
transformer_lists => 0,
link_prefix => 0,
sentence_case_headers => 0,
remove_name_section => 0,
};
###############################################################################
#
# new()
#
# Simple constructor inheriting from Pod::Simple::Wiki.
#
sub new {
my $class = shift;
my $opts = {};
if ( ref $_[-1] eq 'HASH' ) {
$opts = pop @_;
# Merge custom tags with the default tags, if passed.
$opts->{tags} = {
%$tags,
%{
exists $opts->{custom_tags}
? delete $opts->{custom_tags}
: {}
}
};
}
else {
$opts->{tags} = $tags;
}
$opts = { %$default_opts, %$opts };
my $self = Pod::Simple::Wiki->new( 'wiki', @_ );
$self->{_tags} = $opts->{tags};
$self->{_transformer_lists} = $opts->{transformer_lists};
$self->{_link_prefix} = $opts->{link_prefix};
$self->{_sentence_case_headers} = $opts->{sentence_case_headers};
$self->{_remove_name_section} = $opts->{remove_name_section};
bless $self, $class;
$self->accept_targets( 'mediawiki' );
$self->nbsp_for_S( 1 );
return $self;
}
###############################################################################
#
# _append()
#
# Appends some text to the buffered Wiki text.
#
sub _append {
my $self = shift;
if ( $self->{_indent_text} ) {
$self->{_wiki_text} .= $self->{_indent_text};
$self->{_indent_text} = '';
}
$self->{_wiki_text} .= $_[0];
}
###############################################################################
#
# _indent_item()
#
# Indents an "over-item" to the correct level.
#
sub _indent_item {
my $self = shift;
my $item_type = $_[0];
my $item_param = $_[1];
my $indent_level = $self->{_item_indent};
if ( $item_type eq 'bullet' ) {
$self->_append( '*' x $indent_level . ' ' );
}
elsif ( $item_type eq 'number' ) {
$self->_append( '#' x $indent_level . ' ' );
}
elsif ( $item_type eq 'text' ) {
$self->_append( ':' x ( $indent_level - 1 ) . '; ' );
}
}
###############################################################################
#
# Functions to deal with links.
sub _start_L {
my ( $self, $attr ) = @_;
if ( !$self->_skip_headings ) {
$self->_append( '' ); # In case we have _indent_text pending
# Flush the text buffer, so it will contain only the link text
$self->_output;
$self->{_link_attr} = $attr; # Save for later
}
}
sub _end_L {
my $self = $_[0];
my $attr = delete $self->{_link_attr};
if ( $attr and my $method = $self->can( '_format_link' ) ) {
$self->{_wiki_text} = $method->( $self, $self->{_wiki_text}, $attr );
}
}
###############################################################################
#
# _format_link
sub _format_link {
my ( $self, $text, $attr ) = @_;
if ( $attr->{type} eq 'url' ) {
my $link = $attr->{to};
return $link if $attr->{'content-implicit'};
return "[$link $text]";
}
# Manpage:
if ( $attr->{type} eq 'man' ) {
# FIXME link to http://www.linuxmanpages.com?
return "<tt>$text</tt>" if $attr->{'content-implicit'};
return "$text (<tt>$attr->{to}</tt>)";
}
die "Unknown link type $attr->{type}" unless $attr->{type} eq 'pod';
# Handle a link within this page:
return "[[#$attr->{section}|$text]]" unless defined $attr->{to};
# Handle a link to a specific section in another page:
if ( defined $attr->{section} ) {
return $self->{_link_prefix}
? "[$self->{_link_prefix}$attr->{to}#$attr->{section} $text]"
: "[[$attr->{to}#$attr->{section}|$text]]";
}
if ( $attr->{'content-implicit'} ) {
return $self->{_link_prefix}
? "[$self->{_link_prefix}$attr->{to} $attr->{to}]"
: "[[$attr->{to}]]";
}
return "[[$attr->{to}|$text]]";
}
###############################################################################
#
# _handle_text()
#
# Perform any necessary transforms on the text. This is mainly used to escape
# inadvertent CamelCase words.
#
sub _handle_text {
my $self = shift;
my $text = $_[0];
if ( $self->{_sentence_case_headers} ) {
if ( $self->{_in_head1} ) {
$text = ucfirst( lc( $text ) );
}
}
if ( !$self->{_in_Data} ) {
# Escape colons in definition lists:
if ( $self->{_in_item_text} ) {
$text =~ s/:/:/g; # A colon would end the item
}
# Escape empty lines in verbatim sections:
if ( $self->{_in_Verbatim} ) {
$text =~ s/^$/ /mg; # An empty line would split the section
}
$text =~ s/\xA0/ /g; # Convert non-breaking spaces to entities
$text =~ s/''/''/g; # It's not a formatting code
$text =~ s/\xA9/©/g; # Convert copyright symbols to entities
}
$self->_append( $text );
}
###############################################################################
#
# Functions to deal with =over ... =back regions for
#
# Bulleted lists
# Numbered lists
# Text lists
# Block lists
#
sub _end_item_text { } # _start_Para will insert the :
###############################################################################
#
# _start_Para()
#
# Special handling for paragraphs that are part of an "over" block.
#
sub _start_Para {
my $self = shift;
my $indent_level = $self->{_item_indent};
if ( $self->{_in_over_block} ) {
$self->{_indent_text} = ( ':' x $indent_level );
}
if ( $self->{_in_over_text} ) {
$self->{_indent_text} = "\n" . ( ':' x $indent_level );
}
if ( $self->{_transformer_lists} ) {
if ( $self->{_in_over_bullet} || $self->{_in_over_number} ) {
if ( $self->{output_string} ) {
chomp( ${ $self->{output_string} } );
}
$self->{_indent_text} = "<p>";
}
}
}
###############################################################################
#
# _end_Para()
#
# Special handling for paragraphs that are part of an "over_text" block.
#
sub _end_Para {
my $self = shift;
# Only add a newline if the paragraph isn't part of a text
if ( $self->{_in_over_text} ) {
# Do nothing in this format.
}
elsif ( $self->{_transformer_lists}
&& ( $self->{_in_over_bullet} || $self->{_in_over_number} ) )
{
$self->_output( "</p>\n" );
}
else {
$self->_output( "\n" );
}
if ( !$self->{_transformer_lists}
|| ( !$self->{_in_over_bullet} && !$self->{_in_over_number} ) )
{
$self->_output( "\n" );
}
}
######################################################################
#
# _end_Data
#
# Special handling for data paragraphs
sub _end_Data { $_[0]->_output( "\n\n" ) }
###############################################################################
#
# parse_string_document()
#
# Optional overriding of Pod::Simple method to remove the "NAME" section
#
sub parse_string_document {
my $self = shift;
$self = $self->SUPER::parse_string_document( @_ );
if ( $self->{_remove_name_section} ) {
no warnings 'uninitialized';
${ $self->{output_string} } =~
s/^==\s*NAME\s*==\n(?:[\w:]+)(?: - (.*))*/$1||''/iesg;
}
return $self;
}
1;
__END__
=pod
=encoding utf8
=head1 NAME
Pod::Simple::Wiki::Mediawiki - A class for creating Pod to Mediawiki wiki filters.
=head1 SYNOPSIS
This module isn't used directly. Instead it is called via C<Pod::Simple::Wiki>:
#!/usr/bin/perl -w
use strict;
use Pod::Simple::Wiki;
my $parser = Pod::Simple::Wiki->new('mediawiki', \%opts);
...
Convert Pod to a Mediawiki wiki format using the installed C<pod2wiki> utility:
pod2wiki --style mediawiki file.pod > file.wiki
=head1 DESCRIPTION
The C<Pod::Simple::Wiki::Mediawiki> module is used for converting Pod text to Wiki text.
Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation.
For an introduction to Mediawiki see: http://www.mediawiki.org/wiki/MediaWiki
This module isn't generally invoked directly. Instead it is called via C<Pod::Simple::Wiki>. See the L<Pod::Simple::Wiki> and L<pod2wiki> documentation for more information.
=head1 METHODS
Pod::Simple::Wiki::Mediawiki inherits all of the methods of C<Pod::Simple> and C<Pod::Simple::Wiki>. See L<Pod::Simple> and L<Pod::Simple::Wiki> for more details.
=head2 new
The following options are supported by the C<Pod::Simple::Wiki::Mediawiki> constructor:
=over 4
=item B<custom_tags>
This option accepts a hashref containing the HTML tag to MediaWiki mappings.
For example, if your MediaWiki installation has the L<SyntaxHighlight GeSHi|http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi> extension installed, you could pass the following custom tags to enable your verbatim paragraphs to be syntax highlighted:
{
custom_tags => {
'<pre>' => "<syntaxhighlight lang=\"perl\">\n",
'</pre>' => "\n</syntaxhighlight>\n",
}
}
Any custom tags you define will override the classes' default tags as defined in the C<$tags> variable.
Defaults to "{}".
=item B<transformer_lists>
If enabled, modify the item list output to better support the L<Pod::Elemental::Transformer::List> style of lists (as used by many L<Dist::Zilla> based distros via L<Pod::Weaver>).
For example, the output of the following list definition:
=for :list
* Point one
This is pointy
* Point two
That hurts
will be transformed into:
* Point one<p>This is pointy</p>
* Point two<p>That hurts</p>
This will be rendered as a bulleted with list headings that have correctly indented paragraph blocks immediately beneath.
Defaults to 0.
=item B<link_prefix>
If set, all links without any extra qualifier text are prefixed with the given URL. A useful URL to set this option to is: C<http://search.cpan.org/perldoc?>, which will enable the links to be correctly resolved to the external links when used within your internal MediaWiki site.
Defaults to 0.
=item B<sentence_case_headers>
This option will modify any C<=head1> header by lower-casing it and then upper-casing the first character.
For example, this header:
=head1 DESCRIPTION
becomes:
=head1 Description
This option is inspired from L<http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Article_titles> in the Wikipedia "Manual of Style".
Defaults to 0.
=item B<remove_name_section>
If enabled, modify the resultant wiki output text to remove the "NAME" (or "Name") section, but first parse out the embedded abstract text and place that at the top of the wiki page, as a brief introduction.
Defaults to 0.
=back
=head1 SEE ALSO
This module also installs a C<pod2wiki> command line utility. See C<pod2wiki --help> for details.
=head1 ACKNOWLEDGEMENTS
Thanks Tony Sidaway for initial Wikipedia/MediaWiki support. Christopher J. Madsen for several major additions and tests. Peter Hallam added several MediaWiki enhancements.
=head1 DISCLAIMER OF WARRANTY
Please refer to the DISCLAIMER OF WARRANTY in L<Pod::Simple::Wiki>.
=head1 AUTHORS
John McNamara jmcnamara@cpan.org
Christopher J. Madsen perl@cjmweb.net
=head1 COPYRIGHT
MMIII-MMXII, John McNamara.
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
|