.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 >0, 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 .\" ======================================================================== .\" .IX Title "Pod::Simple::Wiki::Twiki 3pm" .TH Pod::Simple::Wiki::Twiki 3pm "2022-10-13" "perl v5.34.0" "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" Pod::Simple::Wiki::Twiki \- A class for creating Pod to Twiki wiki filters. .SH "SYNOPSIS" .IX Header "SYNOPSIS" This module isn't used directly. Instead it is called via \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR: .PP .Vb 1 \& #!/usr/bin/perl \-w \& \& use strict; \& use Pod::Simple::Wiki; \& \& \& my $parser = Pod::Simple::Wiki\->new(\*(Aqtwiki\*(Aq); \& \& ... .Ve .PP Convert Pod to a Twiki wiki format using the installed \f(CW\*(C`pod2wiki\*(C'\fR utility: .PP .Vb 1 \& pod2wiki \-\-style twiki file.pod > file.wiki .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \f(CW\*(C`Pod::Simple::Wiki::Twiki\*(C'\fR module is used for converting Pod text to Wiki text. .PP Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation. .PP For an introduction to Twiki see: .PP This module isn't generally invoked directly. Instead it is called via \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR. See the Pod::Simple::Wiki and pod2wiki documentation for more information. .SH "METHODS" .IX Header "METHODS" Pod::Simple::Wiki::Twiki inherits all of the methods of \f(CW\*(C`Pod::Simple\*(C'\fR and \f(CW\*(C`Pod::Simple::Wiki\*(C'\fR. See Pod::Simple and Pod::Simple::Wiki for more details. .SH "SEE ALSO" .IX Header "SEE ALSO" This module also installs a \f(CW\*(C`pod2wiki\*(C'\fR command line utility. See \f(CW\*(C`pod2wiki \-\-help\*(C'\fR for details. .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" Thanks to Sam Tregar for TWiki support. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" Please refer to the \s-1DISCLAIMER OF WARRANTY\s0 in Pod::Simple::Wiki. .SH "AUTHORS" .IX Header "AUTHORS" John McNamara jmcnamara@cpan.org .SH "COPYRIGHT" .IX Header "COPYRIGHT" MMIII-MMXV, John McNamara. .PP All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.