.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Text::Trac 3pm" .TH Text::Trac 3pm "2015-04-05" "perl v5.20.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Text::Trac \- Perl extension for formatting text with Trac Wiki Style. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Text::Trac; \& \& my $parser = Text::Trac\->new( \& trac_url => \*(Aqhttp://trac.mizzy.org/public/\*(Aq, \& disable_links => [ qw( changeset ticket ) ], \& ); \& \& $parser\->parse($text); \& \& print $parser\->html; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Text::Trac parses text with Trac WikiFormatting and convert it to html format. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" Constructs Text::Trac object. .PP Available arguments are: .PP \fItrac_url\fR .IX Subsection "trac_url" .PP Base \s-1URL\s0 for TracLinks.Default is /. You can specify each type of \s-1URL\s0 individually. Available URLs are: .IP "trac_attachment_url" 4 .IX Item "trac_attachment_url" .PD 0 .IP "trac_changeset_url" 4 .IX Item "trac_changeset_url" .IP "trac_log_url" 4 .IX Item "trac_log_url" .IP "trac_milestone_url" 4 .IX Item "trac_milestone_url" .IP "trac_report_url" 4 .IX Item "trac_report_url" .IP "trac_source_url" 4 .IX Item "trac_source_url" .IP "trac_ticket_url" 4 .IX Item "trac_ticket_url" .IP "trac_wiki_url" 4 .IX Item "trac_wiki_url" .PD .PP \fIdisable_links\fR .IX Subsection "disable_links" .PP Specify TracLink types you want to disable. All types are enabled if you don't specify this option. .PP .Vb 3 \& my $parser = Text::Trac\->new( \& disable_links => [ qw( changeset ticket ) ], \& ); .Ve .PP \fIenable_links\fR .IX Subsection "enable_links" .PP Specify TracLink types you want to enable.Other types are disabled. You cannot use both disable_links and enable_links at once. .PP .Vb 3 \& my $parser = Text::Trac\->new( \& enable_links => [ qw( changeset ticket ) ], \& ); .Ve .SS "parse" .IX Subsection "parse" Parses text and converts it to html format. .SS "process" .IX Subsection "process" An alias of parse method. .SS "html" .IX Subsection "html" Return converted html string. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "Text::Hatena" 3 .IX Item "Text::Hatena" .PD 0 .IP "Trac " 3 .IX Item "Trac " .IP "Trac WikiFormatting " 3 .IX Item "Trac WikiFormatting " .PD .SH "AUTHORS" .IX Header "AUTHORS" Gosuke Miyashita, \f(CW\*(C`\*(C'\fR .PP Hideaki Tanaka, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \&\f(CW\*(C`bug\-text\-trac at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc Text::Trac .Ve .PP You can also look for information at: .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2006 Gosuke Miyashita, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.