/usr/share/perl5/Pod/Markdown.pm is in libpod-markdown-perl 1.500000-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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 | # vim: set ts=2 sts=2 sw=2 expandtab smarttab:
#
# This file is part of Pod-Markdown
#
# This software is copyright (c) 2004 by Marcel Gruenauer.
#
# This is free software; you can redistribute it and/or modify it under
# the same terms as the Perl 5 programming language system itself.
#
use 5.008;
use strict;
use warnings;
package Pod::Markdown;
{
$Pod::Markdown::VERSION = '1.500';
}
# git description: v1.401-20-g3999377
BEGIN {
$Pod::Markdown::AUTHORITY = 'cpan:RWSTAUNER';
}
# ABSTRACT: Convert POD to Markdown
use Pod::Parser 1.51 ();
use parent qw(Pod::Parser);
use Pod::ParseLink (); # core
our %URL_PREFIXES = (
sco => 'http://search.cpan.org/perldoc?',
metacpan => 'https://metacpan.org/pod/',
man => 'http://man.he.net/man',
);
$URL_PREFIXES{perldoc} = $URL_PREFIXES{metacpan};
# new() is provided by Pod::Parser (which calls initialize()).
sub initialize {
my $self = shift;
$self->SUPER::initialize(@_);
for my $type ( qw( perldoc man ) ){
my $attr = $type . '_url_prefix';
# Use provided argument or default alias.
my $url = $self->{ $attr } || $type;
# Expand alias if defined (otherwise use url as is).
$self->{ $attr } = $URL_PREFIXES{ $url } || $url;
}
$self->_prepare_fragment_formats;
$self->_private;
$self;
}
my @attr = qw(
man_url_prefix
perldoc_url_prefix
perldoc_fragment_format
markdown_fragment_format
);
{
no strict 'refs'; ## no critic
foreach my $attr ( @attr ){
*$attr = sub { return $_[0]->{ $attr } };
}
}
sub _prepare_fragment_formats {
my ($self) = @_;
foreach my $attr ( @attr ){
next unless $attr =~ /^(\w+)_fragment_format/;
my $type = $1;
my $format = $self->{ $attr };
# If one was provided.
if( $format ){
# If the attribute is a coderef just use it.
next if ref($format) eq 'CODE';
}
# Else determine a default.
else {
if( $type eq 'perldoc' ){
# Choose a default that matches the destination url.
my $target = $self->{perldoc_url_prefix};
foreach my $alias ( qw( metacpan sco ) ){
if( $target eq $URL_PREFIXES{ $alias } ){
$format = $alias;
}
}
# This seems like a reasonable fallback.
$format ||= 'pod_simple_xhtml';
}
else {
$format = $type;
}
}
# The short name should become a method name with the prefix prepended.
my $prefix = 'format_fragment_';
$format =~ s/^$prefix//;
die "Unknown fragment format '$format'"
unless $self->can($prefix . $format);
# Save it.
$self->{ $attr } = $format;
}
return;
}
sub _private {
my $self = shift;
$self->{_MyParser} ||= {
Text => [], # final text
Indent => 0, # list indent levels counter
ListType => '-', # character on every item
searching => '' , # what are we searching for? (title, author etc.)
sstack => [] , # Stack for searching, needed for nested list
Title => undef, # page title
Author => undef, # page author
};
}
sub as_markdown {
my ($parser, %args) = @_;
my $data = $parser->_private;
my $lines = $data->{Text};
my @header;
if ($args{with_meta}) {
@header = $parser->_build_markdown_head;
}
join("\n" x 2, @header, @{$lines}) . "\n";
}
sub _build_markdown_head {
my $parser = shift;
my $data = $parser->_private;
return join "\n",
map { qq![[meta \l$_="$data->{$_}"]]! }
grep { defined $data->{$_} }
qw( Title Author );
}
# $prelisthead:
# undef : not list head
# '' : list head not huddled
# otherwise: list head huddled
sub _save {
my ($parser, $text, $prelisthead) = @_;
my $data = $parser->_private;
$text = $parser->_indent_text($text, defined($prelisthead));
$text = $prelisthead."\n".$text if defined $prelisthead && $prelisthead ne '';
push @{ $data->{Text} }, $text;
return;
}
sub _unsave {
my $parser = shift;
my $data = $parser->_private;
return pop @{ $data->{Text} };
}
sub _indent_text {
my ($parser, $text, $listhead) = @_;
my $data = $parser->_private;
my $level = $data->{Indent};
--$level if $listhead;
my $indent = undef;
$indent = ' ' x ($level * 4);
my @lines = map { $indent . $_; } split(/\n/, $text);
return wantarray ? @lines : join("\n", @lines);
}
sub _clean_text {
my $text = $_[1];
my @trimmed = grep { $_; } split(/\n/, $text);
return wantarray ? @trimmed : join("\n", @trimmed);
}
# Backslash escape markdown characters to avoid having them interpreted.
sub _escape {
local $_ = $_[1];
# do inline characters first
s/([][\\`*_#])/\\$1/g;
# escape unordered lists and blockquotes
s/^([-+*>])/\\$1/mg;
# escape dots that would wrongfully create numbered lists
s/^( (?:>\s+)? \d+ ) (\.\x20)/$1\\$2/xgm;
return $_;
}
# Formats a header according to the given level.
sub format_header {
my ($self, $level, $paragraph) = @_;
# TODO: put a name="" if $self->{embed_anchor_tags}; ?
# https://rt.cpan.org/Ticket/Display.html?id=57776
sprintf '%s %s', '#' x $level, $paragraph;
}
# Handles POD command paragraphs, denoted by a line beginning with C<=>.
sub command {
my ($parser, $command, $paragraph, $line_num) = @_;
my $data = $parser->_private;
# cleaning the text
$paragraph = $parser->_clean_text($paragraph);
# is it a header ?
if ($command =~ m{head(\d)}xms) {
my $level = $1;
$paragraph = $parser->_escape_and_interpolate($paragraph, $line_num);
# the headers never are indented
$parser->_save($parser->format_header($level, $paragraph));
if ($level == 1) {
if ($paragraph =~ m{NAME}xmsi) {
$data->{searching} = 'title';
} elsif ($paragraph =~ m{AUTHOR}xmsi) {
$data->{searching} = 'author';
} else {
$data->{searching} = '';
}
}
}
# opening a list ?
elsif ($command =~ m{over}xms) {
# update indent level
$data->{Indent}++;
push @{$data->{sstack}}, $data->{searching};
# closing a list ?
} elsif ($command =~ m{back}xms) {
# decrement indent level
$data->{Indent}--;
$data->{searching} = pop @{$data->{sstack}};
} elsif ($command =~ m{item}xms) {
# this strips the POD list head; the searching=listhead will insert markdown's
# FIXME: this does not account for named lists
# Assuming that POD is correctly wrtitten, we just use POD list head as markdown's
$data->{ListType} = '-'; # Default
if($paragraph =~ m{^[ \t]* \* [ \t]*}xms) {
$paragraph =~ s{^[ \t]* \* [ \t]*}{}xms;
} elsif($paragraph =~ m{^[ \t]* (\d+)\.? [ \t]*}xms) {
$data->{ListType} = $1.'.'; # For numbered list only
$paragraph =~ s{^[ \t]* \d+\.? [ \t]*}{}xms;
}
if ($data->{searching} eq 'listpara') {
$data->{searching} = 'listheadhuddled';
}
else {
$data->{searching} = 'listhead';
}
if (length $paragraph) {
$parser->textblock($paragraph, $line_num);
}
}
# ignore other commands
return;
}
# Handles verbatim text.
sub verbatim {
my ($parser, $paragraph) = @_;
# NOTE: perlpodspec says parsers should expand tabs by default
# NOTE: Apparently Pod::Parser does not. should we?
# NOTE: this might be s/^\t/" " x 8/e, but what about tabs inside the para?
# POD verbatim can start with any number of spaces (or tabs)
# markdown should be 4 spaces (or a tab)
# so indent any paragraphs so that all lines start with at least 4 spaces
my @lines = split /\n/, $paragraph;
my $indent = ' ' x 4;
foreach my $line ( @lines ){
next unless $line =~ m/^( +)/;
# find the smallest indentation
$indent = $1 if length($1) < length($indent);
}
if( (my $smallest = length($indent)) < 4 ){
# invert to get what needs to be prepended
$indent = ' ' x (4 - $smallest);
# leave tabs alone
$paragraph = join "\n", map { /^\t/ ? $_ : $indent . $_ } @lines;
}
# FIXME: Checking _PREVIOUS is breaking Pod::Parser encapsulation
# but helps solve the extraneous extra blank line b/t verbatim blocks.
# We could probably keep track ourselves if need be.
# NOTE: This requires Pod::Parser 1.50.
# This is another reason to switch to Pod::Simple.
my $previous_was_verbatim =
$parser->{_PREVIOUS} && $parser->{_PREVIOUS} eq 'verbatim';
if($previous_was_verbatim && $parser->_private->{Text}->[-1] =~ /[ \t]+$/){
$paragraph = $parser->_unsave . "\n" . $paragraph;
}
$parser->_save($paragraph);
}
sub _escape_and_interpolate {
my ($parser, $paragraph, $line_num) = @_;
# escape markdown characters in text sequences except for inline code
$paragraph = join '', $parser->parse_text(
{ -expand_text => '_escape_non_code' },
$paragraph, $line_num
)->raw_text;
# interpolate the paragraph for embedded sequences
$paragraph = $parser->interpolate($paragraph, $line_num);
return $paragraph;
}
sub _escape_non_code {
my ($parser, $text, $ptree) = @_;
if ($ptree->isa('Pod::InteriorSequence') && $ptree->cmd_name =~ /\A[CFL]\z/) {
return $text;
}
return $parser->_escape($text);
}
# Handles normal blocks of POD.
sub textblock {
my ($parser, $paragraph, $line_num) = @_;
my $data = $parser->_private;
my $prelisthead;
$paragraph = $parser->_escape_and_interpolate($paragraph, $line_num);
# clean the empty lines
$paragraph = $parser->_clean_text($paragraph);
# searching ?
if ($data->{searching} =~ m{title|author}xms) {
$data->{ ucfirst $data->{searching} } = $paragraph;
$data->{searching} = '';
} elsif ($data->{searching} =~ m{listhead(huddled)?$}xms) {
my $is_huddled = $1;
$paragraph = sprintf '%s %s', $data->{ListType}, $paragraph;
if ($is_huddled) {
# To compress into an item in order to avoid "\n\n" insertion.
$prelisthead = $parser->_unsave();
} else {
$prelisthead = '';
}
$data->{searching} = 'listpara';
} elsif ($data->{searching} eq 'listpara') {
$data->{searching} = '';
}
# save the text
$parser->_save($paragraph, $prelisthead);
}
# An interior sequence is an embedded command
# within a block of text which appears as a command name - usually a single
# uppercase character - followed immediately by a string of text which is
# enclosed in angle brackets.
sub interior_sequence {
my ($self, $seq_command, $seq_argument, $pod_seq) = @_;
# nested links are not allowed
return sprintf '%s<%s>', $seq_command, $seq_argument
if $seq_command eq 'L' && $self->_private->{InsideLink};
my $i = 2;
my %interiors = (
'I' => sub { return '_' . $_[$i] . '_' }, # italic
'B' => sub { return '__' . $_[$i] . '__' }, # bold
'C' => \&_wrap_code_span, # monospace
'F' => \&_wrap_code_span, # system path
# non-breaking space
'S' => sub {
(my $s = $_[$i]) =~ s/ / /g;
return $s;
},
'E' => sub {
my $charname = $_[$i];
return '<' if $charname eq 'lt';
return '>' if $charname eq 'gt';
return '|' if $charname eq 'verbar';
return '/' if $charname eq 'sol';
# convert legacy charnames to more modern ones (see perlpodspec)
$charname =~ s/\A([lr])chevron\z/${1}aquo/;
return "&#$1;" if $charname =~ /^0(x[0-9a-fA-Z]+)$/;
$charname = oct($charname) if $charname =~ /^0\d+$/;
return "&#$charname;" if $charname =~ /^\d+$/;
return "&$charname;";
},
'L' => \&_resolv_link,
# TODO: create `a name=` if configured?
'X' => sub { '' },
'Z' => sub { '' },
);
if (exists $interiors{$seq_command}) {
my $code = $interiors{$seq_command};
return $code->($self, $seq_command, $seq_argument, $pod_seq);
} else {
return sprintf '%s<%s>', $seq_command, $seq_argument;
}
}
sub _resolv_link {
my ($self, $cmd, $arg) = @_;
local $self->_private->{InsideLink} = 1;
my ($text, $inferred, $name, $section, $type) =
# perlpodspec says formatting codes can occur in all parts of an L<>
map { $_ && $self->interpolate($_, 1) }
Pod::ParseLink::parselink($arg);
my $url = '';
if ($type eq 'url') {
$url = $name;
} elsif ($type eq 'man') {
$url = $self->format_man_url($name);
} else {
$url = $self->format_perldoc_url($name, $section);
}
# if we don't know how to handle the url just print the pod back out
if (!$url) {
return sprintf '%s<%s>', $cmd, $arg;
}
# TODO: put unescaped section into link title? [a](b "c")
return sprintf '[%s](%s)', ($text || $inferred), $url;
}
# A code span can be delimited by multiple backticks (and a space)
# similar to pod codes (C<< code >>), so ensure we use a big enough
# delimiter to not have it broken by embedded backticks.
sub _wrap_code_span {
my ($self, undef, $arg) = @_;
my $longest = 0;
while( $arg =~ /([`]+)/g ){
my $len = length($1);
$longest = $len if $longest < $len;
}
my $delim = '`' x ($longest + 1);
my $pad = $longest > 0 ? ' ' : '';
return $delim . $pad . $arg . $pad . $delim;
}
sub format_man_url {
my ($self, $to) = @_;
my ($page, $part) = ($to =~ /^ ([^(]+) (?: \( (\S+) \) )? /x);
return $self->man_url_prefix . ($part || 1) . '/' . ($page || $to);
}
sub format_perldoc_url {
my ($self, $name, $section) = @_;
my $url_prefix = $self->perldoc_url_prefix;
my $url = '';
# If the link is to another module (external link).
if ($name) {
$url = $url_prefix . $name;
}
# See https://rt.cpan.org/Ticket/Display.html?id=57776
# for a discussion on the need to mangle the section.
if ($section){
my $method = $url
# If we already have a prefix on the url it's external.
? $self->perldoc_fragment_format
# Else an internal link points to this markdown doc.
: $self->markdown_fragment_format;
$method = 'format_fragment_' . $method
unless ref($method);
{
# Set topic to enable code refs to be simple.
local $_ = $section;
$section = $self->$method($section);
}
$url .= '#' . $section;
}
return $url;
}
# TODO: simple, pandoc, etc?
sub format_fragment_markdown {
my ($self, $section) = @_;
# If this is an internal link (to another section in this doc)
# we can't be sure what the heading id's will look like
# (it depends on what is rendering the markdown to html)
# but we can try to follow popular conventions.
# http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html#header-identifiers-in-html-latex-and-context
#$section =~ s/(?![-_.])[[:punct:]]//g;
#$section =~ s/\s+/-/g;
$section =~ s/\W+/-/g;
$section =~ s/-+$//;
$section =~ s/^-+//;
$section = lc $section;
#$section =~ s/^[^a-z]+//;
$section ||= 'section';
return $section;
}
{
# From Pod::Simple::XHTML 3.28.
# The strings gets passed through encode_entities() before idify().
# If we don't do it here the substitutions below won't operate consistently.
# encode_entities {
my %entities = (
q{>} => 'gt',
q{<} => 'lt',
q{'} => '#39',
q{"} => 'quot',
q{&} => 'amp',
);
my
$ents = join '', keys %entities;
# }
sub format_fragment_pod_simple_xhtml {
my ($self, $t) = @_;
# encode_entities {
$t =~ s/([$ents])/'&' . ($entities{$1} || sprintf '#x%X', ord $1) . ';'/ge;
# }
# idify {
for ($t) {
s/<[^>]+>//g; # Strip HTML.
s/&[^;]+;//g; # Strip entities.
s/^\s+//; s/\s+$//; # Strip white space.
s/^([^a-zA-Z]+)$/pod$1/; # Prepend "pod" if no valid chars.
s/^[^a-zA-Z]+//; # First char must be a letter.
s/[^-a-zA-Z0-9_:.]+/-/g; # All other chars must be valid.
s/[-:.]+$//; # Strip trailing punctuation.
}
# }
return $t;
}
}
sub format_fragment_pod_simple_html {
my ($self, $section) = @_;
# From Pod::Simple::HTML 3.28.
# section_name_tidy {
$section =~ s/^\s+//;
$section =~ s/\s+$//;
$section =~ tr/ /_/;
$section =~ tr/\x00-\x1F\x80-\x9F//d if 'A' eq chr(65); # drop crazy characters
#$section = $self->unicode_escape_url($section);
# unicode_escape_url {
$section =~ s/([^\x00-\xFF])/'('.ord($1).')'/eg;
# Turn char 1234 into "(1234)"
# }
$section = '_' unless length $section;
return $section;
# }
}
sub format_fragment_metacpan { shift->format_fragment_pod_simple_xhtml(@_); }
sub format_fragment_sco { shift->format_fragment_pod_simple_html(@_); }
1;
__END__
=pod
=encoding UTF-8
=for :stopwords Marcel Gruenauer Victor Moral Ryan C. Thompson <rct at thompsonclan d0t
org> Aristotle Pagaltzis Randy Stauner ACKNOWLEDGEMENTS ATARASHI motemen
moznion Graham Ollis Peter Vereshagin Yasutaka <aristotle@cpan.org>
<plicease@cpan.org> <veresc@cpan.org> <rthompson@cpan.org> <yakex@cpan.org>
<motemen@cpan.org> <moznion@cpan.org> textblock html cpan testmatrix url
annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata
placeholders metacpan
=head1 NAME
Pod::Markdown - Convert POD to Markdown
=head1 VERSION
version 1.500
=head1 SYNOPSIS
my $parser = Pod::Markdown->new;
$parser->parse_from_filehandle(\*STDIN);
print $parser->as_markdown;
=head1 DESCRIPTION
This module subclasses L<Pod::Parser> and converts POD to Markdown.
Literal characters in Pod that are special in Markdown
(like *asterisks*) are backslash-escaped when appropriate.
=head1 METHODS
=head2 new
Pod::Markdown->new(%options);
The constructor accepts the following named arguments:
=over 4
=item *
C<man_url_prefix>
Alters the man page urls that are created from C<< LE<lt>E<gt> >> codes.
The default is C<http://man.he.net/man>.
=item *
C<perldoc_url_prefix>
Alters the perldoc urls that are created from C<< LE<lt>E<gt> >> codes.
Can be:
=over 4
=item *
C<metacpan> (shortcut for C<https://metacpan.org/pod/>)
=item *
C<sco> (shortcut for C<http://search.cpan.org/perldoc?>)
=item *
any url
=back
The default is C<metacpan>.
Pod::Markdown->new(perldoc_url_prefix => 'http://localhost/perl/pod');
=item *
C<perldoc_fragment_format>
Alters the format of the url fragment for any C<< LE<lt>E<gt> >> links
that point to a section of an external document (C<< L<name/section> >>).
The default will be chosen according to the destination L</perldoc_url_prefix>.
Alternatively you can specify one of the following:
=over 4
=item *
C<metacpan>
=item *
C<sco>
=item *
C<pod_simple_xhtml>
=item *
C<pod_simple_html>
=item *
A code ref
=back
The code ref can expect to receive two arguments:
the parser object (C<$self>) and the section text.
For convenience the topic variable (C<$_>) is also set to the section text:
perldoc_fragment_format => sub { s/\W+/-/g; }
=item *
C<markdown_fragment_format>
Alters the format of the url fragment for any C<< LE<lt>E<gt> >> links
that point to an internal section of this document (C<< L</section> >>).
Unfortunately the format of the id attributes produced
by whatever system translates the markdown into html is unknown at the time
the markdown is generated so we do some simple clean up.
B<Note:> C<markdown_fragment_format> and C<perldoc_fragment_format> accept
the same values: a (shortcut to a) method name or a code ref.
=back
=head2 man_url_prefix
Returns the url prefix in use for man pages.
=head2 perldoc_url_prefix
Returns the url prefix in use (after resolving shortcuts to urls).
=head2 perldoc_fragment_format
Returns the coderef or format name used to format a url fragment
to a section in an external document.
=head2 markdown_fragment_format
Returns the coderef or format name used to format a url fragment
to an internal section in this document.
=head2 as_markdown
Returns the parsed POD as Markdown. Takes named arguments. If the C<with_meta>
argument is given a positive value, meta tags are generated as well.
=head2 format_man_url
Used internally to create a url (using L</man_url_prefix>)
from a string like C<man(1)>.
=head2 format_perldoc_url
# With $name and section being the two parts of L<name/section>.
my $url = $parser->format_perldoc_url($name, $section);
Used internally to create a url from
the name (of a module or script)
and a possible section (heading).
The format of the url fragment (when pointing to a section in a document)
varies depending on the destination url
so L</perldoc_fragment_format> is used (which can be customized).
If the module name portion of the link is blank
then the section is treated as an internal fragment link
(to a section of the generated markdown document)
and L</markdown_fragment_format> is used (which can be customized).
=head2 format_fragment_markdown
Format url fragment for an internal link
by replacing non-word characters with dashes.
=head2 format_fragment_pod_simple_xhtml
Format url fragment like L<Pod::Simple::XHTML/idify>.
=head2 format_fragment_pod_simple_html
Format url fragment like L<Pod::Simple::HTML/section_name_tidy>.
=head2 format_fragment_metacpan
Format fragment for L<metacpan.org>
(uses L</format_fragment_pod_simple_xhtml>).
=head2 format_fragment_sco
Format fragment for L<search.cpan.org>
(uses L</format_fragment_pod_simple_html>).
=for Pod::Coverage format_header
initialize
command interior_sequence textblock verbatim
=head1 SEE ALSO
=over 4
=item *
L<pod2markdown> - script included for command line usage
=back
=head1 SUPPORT
=head2 Perldoc
You can find documentation for this module with the perldoc command.
perldoc Pod::Markdown
=head2 Websites
The following websites have more information about this module, and may be of help to you. As always,
in addition to those websites please use your favorite search engine to discover more resources.
=over 4
=item *
MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.
L<http://metacpan.org/release/Pod-Markdown>
=back
=head2 Bugs / Feature Requests
Please report any bugs or feature requests by email to C<bug-pod-markdown at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Markdown>. You will be automatically notified of any
progress on the request by the system.
=head2 Source Code
L<https://github.com/rwstauner/Pod-Markdown>
git clone https://github.com/rwstauner/Pod-Markdown.git
=head1 AUTHORS
=over 4
=item *
Marcel Gruenauer <marcel@cpan.org>
=item *
Victor Moral <victor@taquiones.net>
=item *
Ryan C. Thompson <rct at thompsonclan d0t org>
=item *
Aristotle Pagaltzis <pagaltzis@gmx.de>
=item *
Randy Stauner <rwstauner@cpan.org>
=back
=head1 CONTRIBUTORS
=over 4
=item *
Aristotle Pagaltzis <aristotle@cpan.org>
=item *
Graham Ollis <plicease@cpan.org>
=item *
Peter Vereshagin <veresc@cpan.org>
=item *
Ryan C. Thompson <rthompson@cpan.org>
=item *
Yasutaka ATARASHI <yakex@cpan.org>
=item *
motemen <motemen@cpan.org>
=item *
moznion <moznion@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2004 by Marcel Gruenauer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|