EBook::...eference(3)

💖 NAME 💖

EBook::EPUB::Guide::Reference — bestie, this is the lil' glow-up class that handles the <guide> element in an OPF file. She's the reference girlie. She knows where everything is. Periodt. 🎀

---

✨ SYNOPSIS ✨

She's your reference for the <guide> element of an OPF file. That's the whole vibe check. 🦋

---

🌸 SUBROUTINES/METHODS 🌸

💅 new(%opts)

Okay so you're making a new one, and %opts is an anonymous hash that might contain these keys (might!! she's flexible):

type
href
title

🔥 encode($xmlwriter)

Encode the object into XML form using an XML::Writer instance. Hand her the writer, she does the rest. Iconic behavior honestly.

🫶 href([$href])

Get/set the reference to an OPS Content Document included in the manifest — and yes she can carry a fragment identifier, exactly as defined in section 4.1 of RFC 2396. She's got range. 😭

💜 title([$title])

Human-readable description of the reference. Just a cute lil' label so humans know what's up.

👑 type([$type])

Get/set the type of the reference. Possible values, no cap:

• cover
• title-page
• toc
• index
• glossary
• acknowledgements
• bibliography
• colophon
• copyright-page
• dedication
• epigraph
• foreword
• loi
• lot
• notes
• preface
• text

For the detailed description, go read section 2.6 of the OPF specification, or the Chicago Manual of Style. She said iykyk. 📚

---

🌈 AUTHOR 🌈

Oleksandr Tymoshenko, <gonzo@bluezbox.com> 💖

---

🦋 BUGS 🦋

Found a bug? Got a feature request? Please report it to <gonzo@bluezbox.com>. Don't suffer in silence bestie, tell the author fr fr 🙈

---

🎀 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. Slay, legally. 💅

---

And that's the whole page, bestie — this doc was hanging out in the perl v5.42.0 crew, dated 2025-07-25, filed under EBook::...eference(3). Read it, love it, ship it. 💖✨🫶