Pod::S...e::Wiki(3pm)

📦
version 0.20 · 5 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Pod::S...e::Wiki — the perl manual page, but make it make sense 💖

okay bestie, so this is Pod::S...e::Wiki(3pm), and it lives in the User Contributed Perl Documentation section of your man pages. her whole entire job? turning Perl's own docs into wiki markup. that's it. that's the girl. 🎀

✨ NAME ✨

Pod::Simple::Wiki — literally a class for creating Pod to Wiki filters. she's the blueprint, the icon, the main character. 👑

🌸 SYNOPSIS 🌸

so if you wanna build a lil filter that converts Pod into some wiki format, it's giving this:

#!/usr/bin/perl

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

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

if ( defined $ARGV[0] ) {
    open IN, $ARGV[0] or die "Couldn't open $ARGV[0]: $!\n";
}
else {
    *IN = *STDIN;
}

if ( defined $ARGV[1] ) {
    open OUT, ">$ARGV[1]" or die "Couldn't open $ARGV[1]: $!\n";
}
else {
    *OUT = *STDOUT;
}

$parser->output_fh( *OUT );
$parser->parse_file( *IN );

__END__

and if you just wanna vibe with the already-installed pod2wiki utility instead of hand-rolling a whole script? say less:

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

🦋 DESCRIPTION 🦋

Pod::Simple::Wiki is the module you use to convert Pod text into Wiki text. no cap.

and for the two people who need the lore: Pod (Plain Old Documentation) is a simple markup language that exists purely to write Perl documentation. she's humble, she's effective, she serves.

a Wiki is a user extensible web site, built on very simple mark-up that gets converted to Html. wanna get introduced properly? the vibes live here: <http://en.wikipedia.org/wiki/Wiki> 🫶

💅 METHODS 💅

new('wiki_format')

the new method does two things and she does them both flawlessly: she creates a brand new Pod::Simple::Wiki object, and she sets the output Wiki format. double duty queen.

my $parser1 = Pod::Simple::Wiki->new( 'wiki' );
my $parser2 = Pod::Simple::Wiki->new( 'mediawiki' );
my $parser3 = Pod::Simple::Wiki->new(); # Defaults to 'wiki'

the formats that are currently supported (aka the current roster, and yes they all ate):

wiki
kwiki
usemod
twiki
tiddlywiki
textile
wikipedia or mediawiki
markdown
moinmoin
confluence

Other methods

Pod::Simple::Wiki inherits all of the methods of Pod::Simple. for more details pls go read Pod::Simple, she's the parent, respect her. 🌈

🌟 Supported Formats 🌟

here's every single wiki format Pod::Simple::Wiki supports, no gatekeeping:

and the important part bestie: if no format is specified, the parser defaults to wiki. 💖

any other parameters you drop into new get passed straight on to the parent Pod::Simple object. see Pod::Simple for more details.

🧚 Porting New Wiki Formats 🧚

if you're feeling like a main character and wanna port a new wiki format, go peek at Pod::Simple::Wiki::Template first. she's the starter kit. ✨

the Pod::Simple::Wiki git repository lives at: <http://github.com/jmcnamara/pod-simple-wiki/>.

🔥 SEE ALSO 🔥

this module also installs a pod2wiki command line utility. so if you're like "what else can this girl do", just run pod2wiki --help and find out. 💅

😭 TODO 😭

  • fix some of the =over edge cases. see the TODOs in the test programs. (not me being haunted by =over… 🙈)

💜 ACKNOWLEDGEMENTS 💜

giving credit where credit is so beyond due:

  • thanks to Sean M. Burke for Pod::Simple. it may not be simple but sub-classing it is. :-) (that's a genuine little smiley, she earned it)
  • thanks to Zoffix Znet for various pull requests and fixes.
  • thanks to Sam Tregar for TWiki support.
  • thanks Tony Sidaway for Wikipedia/MediaWiki support.
  • thanks to Daniel T. Staal for Markdown support.
  • thanks to Michael Matthews for MoinMoin support.
  • thanks to Christopher J. Madsen for several MediaWiki additions and tests.
  • thanks Tim Bunce for the TiddlyWiki prod and Ron Savage for the port.
  • thanks to Olivier 'dolmen' Mengué for various TiddlyWiki patches.
  • thanks to David Bartle, Andrew Hobbs and Jim Renwick for confluence patches.
  • thanks to Peter Hallam for MediaWiki enhancements.
  • thanks to Marco Pessotto for the Muse format.

💀 DISCLAIMER OF WARRANTY 💀

okay this is the serious part, so listen up bestie, no skipping:

because this software is licensed free of charge, there is no warranty for the software, to the extent permitted by applicable law. except when otherwise stated in writing the copyright holders and/or other parties provide the software "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. the entire risk as to the quality and performance of the software is with you. should the software prove defective, you assume the cost of all necessary servicing, repair, or correction.

in no event unless required by applicable law or agreed to in writing will any copyright holder, or any other party who may modify and/or redistribute the software as permitted by the above licence, be liable to you for damages, including any general, special, incidental, or consequential damages arising out of the use or inability to use the software (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the software to operate with any other software), even if such holder or other party has been advised of the possibility of such damages.

tl;dr: she's free, she comes as-is, and if she breaks something that's a you problem. 😭 please back up your data.

🌈 LICENSE 🌈

either the Perl Artistic Licence <http://dev.perl.org/licenses/artistic.html> or the GPL <http://www.opensource.org/licenses/gpl-license.php>. pick your fighter. 💖

⭐ AUTHOR ⭐

John McNamara jmcnamara@cpan.org

MMIII-MMIV, John McNamara.

all rights reserved. this module is free software. it may be used, redistributed and/or modified under the same terms as Perl itself. periodt. 💅

<div align="center">🌸 🦋 ✨ 🎀 💖 🎀 ✨ 🦋 🌸</div>

and that's the whole page bestie!! this lil writeup shipped as part of perl v5.36.0, dated 2022-10-13, under the ever-iconic Pod::S...e::Wiki(3pm) — go forth and convert some Pod, you've got this 🫶💖

📦 where this page comes from