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::Muse - A class for creating Pod to Muse wiki filters.

Acknowledgements

       This module was written during the Perl Dancer Conference in Vienna, October 19 2015 at the Metalab.

Authors

       John McNamara jmcnamara@cpan.org

       Marco Pessotto melmothx@gmail.com

Description

       The "Pod::Simple::Wiki::Muse" 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 Muse see: <http://www.gnu.org/software/emacs-muse/>.

       For a Muse parser you may want to look at Text::Amuse and Text::Amuse::Compile

       For a wiki engine written in perl using this markup, please see <https://amusewiki.org>.

       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::Muse inherits all of the methods of "Pod::Simple" and "Pod::Simple::Wiki". See
       Pod::Simple and Pod::Simple::Wiki for more details.

Muse Specific Information

Name

       Pod::Simple::Wiki::Muse - A class for creating Pod to Muse 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('muse');

           ...

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

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

See Also