MKDoc::XML(3pm)

💖 MKDoc::XML 💖

okay bestie, this is MKDoc::XML from the User Contributed Perl Documentation manual — the whole MKDoc XML Toolkit in one page. strap in, it's giving very "we're breaking up a monolith and it's a whole saga" energy 🦋

---

✨ NAME ✨

MKDoc::XML — The MKDoc XML Toolkit. that's the whole name. iconic, brief, no notes 💅

---

🌸 SYNOPSIS 🌸

real talk, this one's a little different:

This is an article, not a module.

literally. it's an article. not a module. adjust your expectations accordingly, bestie 😭

---

🎀 SUMMARY 🎀

so MKDoc is a web content management system written in Perl. it's obsessed (positively) with standards compliance, accessibility and usability issues, and multilingual websites. main character concerns only ✨

at MKDoc Ltd, the plan is to gradually break up their existing commercial software into a collection of completely independent, well-documented, well-tested open-source CPAN modules. it's a glow-up arc, not a demolition 🌈

the ultimate goal: MKDoc code should be a coherent collection of module distributions, but every single distribution should be usable and useful all on its own. no codependency, we don't do that here 💜

and MKDoc::XML is part of this effort. periodt.

you could help! turn some of MKDoc's code into a CPAN module — truly a group project moment 🫶 you can peek at the existing code at:

http://download.mkdoc.org/

if there's some functionality you'd love to see as a standalone CPAN module, send an email to:

<mkdoc-modules@lists.webarch.co.uk>

do it. we believe in you. 💖

---

🔥 DISCLAIMER 🔥

okay this is the serious part, listen up:

• MKDoc::XML is a low level XML library. lowkey, not highkey.
• MKDoc::XML::* modules do not make sure your XML is well-formed. not their job, not their problem 💀
• MKDoc::XML::* modules can be used to work with somehow broken XML. yes, broken. we said what we said.
• MKDoc::XML::* modules should not be used as high-level parsers with general purpose XML unless you know what you're doing.

so like… if you don't know what you're doing, bestie, maybe don't 🙈 that's the whole warning.

---

🎁 WHAT'S IN THE BOX 🎁

🧚 XML tokenizer

MKDoc::XML::Tokenizer splits your XML / XHTML files into a list of MKDoc::XML::Token objects using a single regex. one regex. one. slay 💅

🌸 XML tree builder

MKDoc::XML::TreeBuilder sits on top of MKDoc::XML::Tokenizer and builds parsed trees out of your XML / XHTML data. it's the tokenizer's glow-up 🌳

✂️ XML stripper

MKDoc::XML::Stripper objects removes unwanted markup from your XML / HTML data. super useful to remove all those nasty presentational tags, or 'style' attributes from your XHTML data for example. cleansing ritual, honestly 🧼

🏷️ XML tagger

MKDoc::XML::Tagger matches expressions in XML / XHTML documents and tags them appropriately. for example, you could automatically hyperlink certain glossary words, or add <abbr> tags based on a dictionary of abbreviations and acronyms. it's giving ✨automation✨

🔤 XML entity decoder

MKDoc::XML::Decode is a pluggable, configurable entity expander module which currently supports html entities, numerical entities and basic xml entities. pluggable! configurable! multi-talented! 💜

🔡 XML entity encoder

MKDoc::XML::Encode does the exact reverse operation as MKDoc::XML::Decode. mirror behaviour, no cap 🪞

📦 XML Dumper

MKDoc::XML::Dumper serializes arbitrarily complex perl structures into XML strings. it is also able of doing the reverse operation, i.e. deserializing an XML string into a perl structure. both directions, no crumbs left behind 🔥

---

👑 AUTHOR 👑

Copyright 2003 - MKDoc Holdings Ltd.

Author: Jean-Michel Hiver

This module is free software and is distributed under the same license as Perl itself. Use it at your own risk. (yes, at your own risk. we're not your lawyer, we're your Perl modules 😭)

---

⭐ SEE ALSO ⭐

• Petal: http://search.cpan.org/dist/Petal/
• MKDoc: http://www.mkdoc.com/

Help us open-source MKDoc. Join the mkdoc-modules mailing list:

mkdoc-modules@lists.webarch.co.uk

---

and that's the whole vibe check 🦋 this came to you courtesy of perl v5.36.0, dated 2022-10-13, and the MKDoc::XML(3pm) manual page. go forth and tokenize responsibly, bestie 💖✨🎀