Pod::S...i::Muse(3pm)

πŸ“¦
version 0.20 Β· 5 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– Pod::Simple::Wiki::Muse β€” the moment you knew ✨

okay so bestie, welcome to Pod::Simple::Wiki::Muse, which lives in the perl manual pages (3pm section, section 3 for the module girlies πŸ’…). It's a class for creating Pod to Muse wiki filters. yes really. slay.


🌸 NAME 🌸

Pod::Simple::Wiki::Muse β€” a class for creating Pod to Muse wiki filters. that's it, that's the name, iconic πŸŽ€


✨ SYNOPSIS ✨

okay so real talk: you do not use this module directly. like, ever. it gets called via Pod::Simple::Wiki instead. periodt.

#!/usr/bin/perl -w

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

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

...

and if you wanna convert Pod to a Muse wiki format using the installed pod2wiki utility, it's giving:

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

look at that redirect. chef's kiss. 🧚


πŸ¦‹ DESCRIPTION πŸ¦‹

The Pod::Simple::Wiki::Muse module is used for converting Pod text to Wiki text. that's its whole job and it does it beautifully, no cap.

Pod (Plain Old Documentation) is a simple markup language used for writing Perl documentation. lowkey legendary, fr fr.

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 β€” yes those are the real names, go look them up iykyk πŸ’œ

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

and again, and i cannot stress this enough: 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. all of them. the whole inheritance situation is giving family reunion. See Pod::Simple and Pod::Simple::Wiki for more details.

🌈 Muse Specific information 🌈

(yes bestie, this heading is here and it is, in fact, vibes only ✨)


⭐ SEE ALSO ⭐

This module also installs a pod2wiki command line utility. See pod2wiki --help for details. go on, ask it for help, it's nice πŸ’–


πŸŽ€ ACKNOWLEDGEMENTS πŸŽ€

This module was written during the Perl Dancer Conference in Vienna, October 19 2015 at the Metalab. like. imagine writing a perl module at a conference in Vienna. main character energy fr. πŸ”₯


πŸ’€ DISCLAIMER OF WARRANTY πŸ’€

Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki. no warranty here bestie, we're just vibing, read the other page πŸ‘‘


πŸ‘‘ AUTHORS πŸ‘‘

  • John McNamara jmcnamara@cpan.org
  • Marco Pessotto melmothx@gmail.com

two legends, one module, we love to see it πŸ™ˆ


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.

free software babyyy 🌈


so that's the whole page. and for the cute sign-off: this was perl v5.36.0, dated 2022-10-13, and it's the Pod::S...i::Muse page from the User Contributed Perl Documentation, 3pm girlies rise up πŸ’–βœ¨πŸŽ€ (yes the title got abbreviated, the terminal has a width limit, we forgive her πŸ’…)

πŸ“¦ where this page comes from