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

💖 NAME 💖

Pod::Tree::PerlTop — bestie, this one generates a top-level index for Perl PODs. That's the whole job and she does it flawlessly. ✨

(oh and hi, you're reading a page from the User Contributed Perl Documentation collection, just so you know where you are 🫶)

---

🌸 SYNOPSIS 🌸

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

  $perl_top->index(@translators);
  $perl_top->translate;

  $top = $perl_top->get_top_entry;

like. look at her. so clean. 😭💅

---

🦋 DESCRIPTION 🦋

okay so Pod::Tree::PerlTop generates a top-level index for Perl PODs. main character behavior honestly.

she also translates perl.pod to perl.html. and here's the cute part — the translator is specially hacked to insert links into the big verbatim paragraph that lists all the other Perl PODs. no cap, that's the whole trick and it ate. 🔥

---

👑 METHODS 👑

✨ $perl_top = "new" "Pod::Tree::PerlTop" $perl_dir, $HTML_dir, $perl_map, %options

Creates and returns a brand new Pod::Tree::PerlTop object. it's giving fresh start, new era. 🌈

• $perl_dir — the root of the Perl source tree. the whole vibe starts here.
• $HTML_dir — the directory where HTML files will be written. her little home. 🎀
• $perl_map — maps POD names to URLs. Pod::Tree::PerlTop uses it to resolve links in the perl.pod page. iykyk.
• %options — these get passed through to Pod::Tree::HTML. not her business, she just forwards them. 💅

---

🌟 $perl_top->"index"(@translators)

Generates a top-level index of all the PODs. the index gets written to HTML_dir"/index.html". iconic output location, honestly.

@translators is a list of other Pod::Tree::Perl* translator objects. index makes a get_top_entry call on each of them to obtain the URLs and descriptions of the pages that it links to. she's networking. she's building community. periodt. 🫶

---

💜 $perl_top->"translate"

Translates the perl.pod file to HTML. the HTML page gets written to HTML_dir"/pod/perl.html". slay. ✨

---

🎀 $perl_top->"get_top_entry"

Returns a hash reference of the form

  { URL         => $URL,
    description => $description }

Pod::Tree::PerlTop uses this to build a top-level index of all the Perl PODs. it's a whole system and she is the architect. 👑

---

🌈 REQUIRES 🌈

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

no 5.005, no vibes. 🦋

---

🍓 EXPORTS 🍓

Nothing. she gives you nothing and that's exactly what you wanted. 💀✨

---

🌸 SEE ALSO 🌸

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

go say hi to her friends, they're all lovely. 🫶

---

💖 AUTHOR 💖

Steven McDougall, swmcd@world.std.com

the legend. the icon. the moment. 👑

---

⭐ 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.

---

bestie this whole page is from perl v5.36.0, dated 2022-11-19 — that's the source and the date, and that's your sign-off 💖 mwah, go index something gorgeous 🎀✨