Pod::S...:Twiki(3pm)

💖 Pod::S...:Twiki(3pm) — like, the whole vibe 💖

okay bestie, you found it: this is the Pod::Simple::Wiki::Twiki page from the User Contributed Perl Documentation section of the manual (yes, the title line literally goes Pod::S...:Twiki(3pm) on both ends, she's symmetrical like that 💅). Buckle up, it's short but it's iconic.

✨ NAME ✨

Pod::Simple::Wiki::Twiki — a class for creating Pod to Twiki wiki filters. that's the whole job description, and she does it flawlessly 🎀

---

🌸 SYNOPSIS 🌸

first things first — do not try to use this module directly. it's not that kind of girl. she gets called via Pod::Simple::Wiki, like so:

#!/usr/bin/perl -w

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

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

...

see that 'twiki'? that's you telling Pod::Simple::Wiki which flavour of wiki you want. chef's kiss 🫶

and if you're the type who likes a one-liner moment (same, honestly), you can convert Pod to Twiki wiki format using the installed pod2wiki utility:

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

and that's it, that's the conversion. --style twiki in, .wiki out. periodt. ✨

---

🦋 DESCRIPTION 🦋

okay so the Pod::Simple::Wiki::Twiki module is the thing that converts Pod text into Wiki text. that's literally the entire plot. 📖

and what's Pod? Pod stands for Plain Old Documentation — it's a simple markup language used for writing Perl documentation. lowkey humble name, highkey essential. 💜

for an introduction to Twiki, see: http://twiki.org — go peek, bestie, it's giving wiki energy 🌈

now, important: this module isn't generally invoked directly. she's a behind-the-scenes main character. instead she gets called via Pod::Simple::Wiki. so if you want the real tea, go read the Pod::Simple::Wiki and pod2wiki documentation for more info. iykyk 💅

---

💅 METHODS 💅

Pod::Simple::Wiki::Twiki inherits all of the methods of Pod::Simple and Pod::Simple::Wiki. she's got generational talent, no cap.

see Pod::Simple and Pod::Simple::Wiki for more details. 👑

---

🔥 SEE ALSO 🔥

this module also installs a pod2wiki command line utility. see pod2wiki --help for details — yes, just ask her nicely. 🥺

---

🎀 ACKNOWLEDGEMENTS 🎀

thanks to Sam Tregar for TWiki support. king behaviour, we appreciate you 🫶✨

---

💀 DISCLAIMER OF WARRANTY 💀

please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki. (yeah, she's not re-typing it, go read the other page, it's all there 🫡)

---

👑 AUTHORS 👑

John McNamara jmcnamara@cpan.org

---

🌟 COPYRIGHT 🌟

MMIII-MMXV, 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. (so like, share the love, bestie 💖)

---

and that's the whole page, babes 🌸 this one shipped with perl v5.36.0, dated 2022-10-13, and honestly? it ate. now go convert some Pod to Twiki and slay 💅🦋