EBook::...avPoint(3)

✨ NAME ✨

EBook::EPUB::NCX::NavPoint — bestie, this is the manual page for it, sitting in the User Contributed Perl Documentation section, third section, so like... NavPoint(3) iykyk 💖

---

🌸 SYNOPSIS 🌸

It's an entry in the Navigation Center that points at a part of a document (a chapter, for example). Literally its whole job. Iconic of it. 👑

---

🎀 SUBROUTINES/METHODS 🎀

new(%opts)

Okay so %opts is an anonymous hash, and it might contain the following keys, no cap:

• class
• content
• id
• play_order
• label

add_navpoint(%opts)

This one adds a reference to an OPS Content Document that's part of the publication — specifically a subsection of the part that the current object references. So it's giving "nested chapter energy" 🪆

%opts is an anonymous hash, and for the possible key values you wanna go peek at the new() method description above. This method returns the freshly created EBook::EPUB::NCX::NavPoint object, which you can totally hold onto and use later for adding even more subsections. Recursion? Slay. 💅

all_navpoints()

Returns an array of EBook::EPUB::NCX::NavPoint objects — all the subsections of the current one. Your little navpoint children 🥹

encode($xmlwriter)

Encodes the object into XML form, using an XML::Writer instance. That's the whole vibe.

class([$class])

Get or set the class of the navigation point. 🏷️

content([$content])

Get or set the URI to the part that this navPoint references. 🔗

id([$id])

Get or set the ID of the navigation point. Every queen needs an identifier fr fr.

label([$label])

Get or set the human-readable description of the part that this navPoint references. This is the part humans actually read, so, highkey important. 👀

play_order([$play_order])

Get or set the play order (a number) of the text part. Number go in, number come out, order established. 🔢

---

👑 AUTHOR 👑

Oleksandr Tymoshenko, <gonzo@bluezbox.com> — the author, the moment, the main character of this module.

---

💀 BUGS 💀

Please report any bugs or feature requests to <gonzo@bluezbox.com>. Spotted something cursed? Tell them, don't suffer 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.

---

🌈 and that's the whole page, we ate and left no crumbs 🍓

This was written for perl v5.42.0, and the page itself is dated 2025-07-25 — mwah, bye bestie 💖✨