Scroll to navigation

Pod::Simple::Wiki::Muse(3pm) User Contributed Perl Documentation Pod::Simple::Wiki::Muse(3pm)

NAME

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

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

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.

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

SEE ALSO

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

ACKNOWLEDGEMENTS

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

DISCLAIMER OF WARRANTY

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

AUTHORS

John McNamara jmcnamara@cpan.org

Marco Pessotto melmothx@gmail.com

COPYRIGHT

MMIII-MMXV, John McNamara. 2015, Marco Pessotto.

All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.

2015-11-09 perl v5.20.2