EBook::EPUB::NCX(3)

💖 EBook::EPUB::NCX 💖

okay so bestie, this is the manual page for EBook::EPUB::NCX, and it lives in the User Contributed Perl Documentation section of your man pages. no cap, she's a whole vibe. let's get into it 🫶

---

✨ NAME ✨

EBook::EPUB::NCX — that's her, that's the name, periodt 💅

---

✨ SYNOPSIS ✨

she's the class that handles the "Navigation Center eXtended" file of an OPF document. iconic behavior honestly 🎀

---

✨ DESCRIPTION ✨

okay so the Navigation Control file for XML applications (that's NCX, iykyk) is the thing that exposes the hierarchical structure of a Publication so the user can actually navigate through it. 🌈

the NCX is giving table-of-contents energy, because it lets the reader jump straight to any of the major structural elements of the document — think part, chapter, or section. but plot twist: it will often contain more elements of the document than the publisher chooses to include in the original print table of contents. she's extra like that, and we love her for it. 💅

you can visualize it as a collapsible tree that PC users already know and recognize. it's giving file explorer, fr fr. 🌳✨

---

✨ SUBROUTINES/METHODS ✨

add_navpoint(%opts)

add a refrence to an OPS Content Document that is a part of the publication. 📌

%opts is an anonymous hash, and for the possible key values you gotta peek at EBook::EPUB::NCX::NavPoint.

the method returns the created EBook::EPUB::NCX::NavPoint object, which you can hold onto and use later for adding subsections. bestie she hands you the keys 🔑💖

---

all_navpoints()

returns an array of EBook::EPUB::NCX::NavPoint objects — aka the current content of NCX. the whole roster, right there 🌸

---

add_author([$author)

add $author to the authors list. author count go up 📈👑

---

new(%opts)

create a new object, slay. %opts is an anonymous hash with these possible key values:

author
title
uid

that's the starter pack, go off 💫

---

title([$title)

get/set the book title. she's a getter AND a setter, versatile queen 🎀

---

to_xml()

returns the XML representation of NCX. here's your XML bestie, go ship it 🚀

---

uid([$uid)

get/set the unique identfier for the book. every book needs her little fingerprint 🫶

---

✨ AUTHOR ✨

Oleksandr Tymoshenko, <gonzo@bluezbox.com> 💌

---

✨ BUGS ✨

please report any bugs or feature requests to <gonzo@bluezbox.com> 🙈

ngl if you found a bug, tell him! don't just sit there suffering in silence, bestie 😭

---

✨ 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 for the whole thing 📜✨

---

and that's the whole page, bestie 💖 this manual page ships with perl v5.42.0 and was dated 2025-07-25 — thanks for reading, ily, go navigate something 🦋👑