Pod::T...erlFunc(3pm)

💖 Pod::Tree::PerlFunc 💖

okay bestie, pull up a chair, because this is the manual page for Pod::Tree::PerlFunc, straight out of the User Contributed Perl Documentation collection. it does one (1) thing and it does it gorgeously. let's get into it 🫶

---

✨ NAME ✨

Pod::Tree::PerlFunc — translate perlfunc.pod to HTML. that's the whole vibe. iconic. no notes. 💅

---

🌸 SYNOPSIS 🌸

here's the little ritual you perform, in order, no skipping steps:

  $perl_map  = Pod::Tree::PerlMap->new;
  $perl_func = Pod::Tree::PerlFunc->new($perl_dir, $HTML_dir, $perl_map, %opts);

  $perl_func->scan;
  $perl_func->index;
  $perl_func->translate;

---

🦋 DESCRIPTION 🦋

so Pod::Tree::PerlFunc translates perlfunc.pod to HTML. like, it takes that one giant pod file and it splits it into a whole separate HTML page for every single function description in it. yes, every one. she's thorough.

the pages for the individual descriptions are named after the function and written to a func/ subdirectory. and then perlfunc.html is generated as an index to all the pages in func/.

Pod::Tree::PerlFunc also generates and uses an index of the functions that it finds in perlfunc.pod to construct HTML links. and here's the bestie part: other modules can use this index too. sharing is caring fr fr.

---

🎀 METHODS 🎀

$perl_func = "new" "Pod::Tree::PerlFunc" $perl_dir, $HTML_dir, $perl_map, %options

creates and returns a shiny new Pod::Tree::PerlFunc object. new object smell ✨

• $perl_dir is the root of the Perl source tree. 🌳
• $HTML_dir is the directory where HTML files will be written. 📁
• $perl_map maps function names to URLs. 🗺️
• %options are passed through to Pod::Tree::HTML. 🎁

$perl_func->"scan"

reads perlfunc.pod and identifies all the functions in it. every function that gets identified is entered into $perl_map. she's taking attendance and nobody's escaping it. 📋

$perl_func->"index"

generates a top-level index of all the functions. the index is written to HTML_dir/pod/perlfunc.html. that's the table of contents, the whole map, the moment. 🗂️

$perl_func->"translate"

translates each function found by scan to HTML. the HTML pages are written to HTML_dir/pod/func/. 💫

---

🔗 LINKING 🔗

Pod::Tree::PerlFunc indexes every =item paragraph in perlfunc.html. so if you wanna link, for example, to the abs function, you write:

  L<func/abs>

that's it. that's the link. go forth and hyperlink. 🌈

---

📦 REQUIRES 📦

• 5.005;
• Pod::Tree;
• Pod::Tree::HTML;
• Pod::Tree::PerlUtil;

---

🙈 EXPORTS 🙈

Nothing. she gives you nothing and expects nothing back. low maintenance queen. 👑

---

👀 SEE ALSO 👀

Pod::Tree::HTML, Pod::Tree::PerlMap

---

💜 AUTHOR 💜

Steven McDougall, swmcd@world.std.com

---

📜 COPYRIGHT 📜

Copyright (c) 2000 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page bestie!! no cap, every single detail preserved, every option and path intact, nothing skipped. 💀

perl v5.36.0 · 2022-11-19 — mwah, that's the version and date this lil doc came from. stay slaying, go read perlfunc.pod, ily 🫶💖✨