logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Pod::Simple::Wiki::Tiddlywiki - A class for creating Pod to Tiddlywiki wiki filters.

Acknowledgements

       Submit a bugfix or test and your name will go here.

Authors

       John McNamara jmcnamara@cpan.org

       Ron Savage, ron@savage.net.au

       Olivier 'dolmen' Mengu�

Description

       The "Pod::Simple::Wiki::Tiddlywiki" 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 Tiddlywiki see: <http://tiddlywiki.com/>

       This module isn't generally invoked directly. Instead it is called via "Pod::Simple::Wiki". See the
       Pod::Simple::Wiki and pod2wiki documentation for more information.

Disclaimer Of Warranty

       Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.

Methods

       Pod::Simple::Wiki::Tiddlywiki inherits all of the methods of "Pod::Simple" and "Pod::Simple::Wiki". See
       Pod::Simple and Pod::Simple::Wiki for more details.

Name

       Pod::Simple::Wiki::Tiddlywiki - A class for creating Pod to Tiddlywiki wiki filters.

See Also

       This module also installs a "pod2wiki" command line utility. See "pod2wiki --help" for details.

Synopsis

       This module isn't used directly. Instead it is called via "Pod::Simple::Wiki":

           #!/usr/bin/perl -w

           use strict;
           use Pod::Simple::Wiki;

           my $parser = Pod::Simple::Wiki->new('tiddlywiki');

           ...

       Convert Pod to a Tiddlywiki wiki format using the installed "pod2wiki" utility:

           pod2wiki --style tiddlywiki file.pod > file.wiki

Tiddlywiki Specific Information

See Also