EBook::EPUB::Guide(3)

💖 EBook::EPUB::Guide — the perl manpage, but make it cute 💖

okay bestie, so this is EBook::EPUB::Guide, a page from the User Contributed Perl Documentation. it lives in the perl manual pages, section 3, and it's all about one lil' class that holds the guide element of an OPF document. iconic behavior, honestly. 🎀

---

✨ SYNOPSIS ✨

Class that represents guide element of OPF document

that's it. that's the whole vibe. a class. it represents the guide element. we love a one-line synopsis that doesn't overexplain. 👑

---

🌸 DESCRIPTION 🌸

so the guide element is the part of your publication that's like "hey, here are the fundamental structural components of this book," which lets Reading Systems give readers convenient access to them. it's giving helpful tour guide energy. 🧚

all those structural components? they get listed out in reference elements that live inside the guide element. and those components can point at stuff like the table of contents, the list of illustrations, the foreword, the bibliography, and literally so many other standard parts of a book. the whole classic lineup. 📚

⚠️ important caveat, no cap: Reading Systems are not required to use the guide element in any way. so like… it's optional-optional. don't come for it if nothing happens. 💀

if you wanna go deeper, check section 2.6 of the OPF specification. iykyk. 🔥

---

💅 SUBROUTINES/METHODS 💅

• add_reference(%opts) — adds a reference to the guide element. %opts is an anonymous hash, and for the possible key values you should go peek at EBook::EPUB::Guide::Reference. that's where the tea is. 🍓
• all_references() — returns an array of EBook::EPUB::Guide::Reference objects, aka the current content of the guide element. all of them. every single one. ✨
• encode($xmlwriter) — encodes the object into XML form using an XML::Writer instance. you hand it the writer, it does the encoding. simple as. 🦋
• new() — creates a new object. the classic. the moment of birth. main character origin story. 👑

---

💜 AUTHOR 💜

Oleksandr Tymoshenko, <gonzo@bluezbox.com>

---

🙈 BUGS 🙈

found a bug? want a feature? please report any bugs or feature requests to <gonzo@bluezbox.com>. they wanna hear it, fr fr. don't be shy. 💌

---

🌈 LICENSE AND COPYRIGHT 🌈

Copyright 2009, 2010 Oleksandr Tymoshenko.

<http://bluezbox.com>

This module is free software; you can redistribute it and/or modify it under the terms of the BSD license. See the LICENSE file included with this distribution. 📄

---

and that's the whole page, bestie!! this was pulled from perl v5.42.0, dated 2025-07-25, and it's the EBook::EPUB::Guide(3) manpage. slay, go build some epubs, ily 🫶💖✨