wml::std::toc(3)

💖 wml::std::toc — Table of Contents Generation 💖

okay bestie, welcome to wml::std::toc(3) from the EN Tools crew ✨ this is the one that builds you a whole Table of Contents like it's nothing. no cap.

---

🌸 NAME 🌸

wml::std::toc — Table of Contents Generation. yes, the name literally says what it does, we love a transparent queen 👑

---

✨ SYNOPSIS ✨

 #use wml::std::toc [style={pre,nbsp,hspace,ul,ol} [type=...]]

 <toc>

 <hN>...</hN>

 <toc_hN ...>...</toc_hN>

---

🦋 DESCRIPTION 🦋

so here's the tea, bestie: this thing creates a table of contents, and you can drop it in anywhere you want using the <toc> tag — and lowkey you can do it more than once if that's the vibe you're going for 💅

The contents get built out of all your header tags, aka <hN> — and here's the cute part: that N also controls the indention in the table of contents. so <h1> is your main character energy and <h2> sits all nicely nested under it. iconic. ✨

Alternatively — plot twist! — you can use the <toc_hN> tags to insert their body (which, yes, can be empty!) at the current location and into the Table Of Contents. Two places, one tag, we love efficiency.

And if you specify it, the alt attribute gets included into the ToC instead of the body. so if your body is giving nothing, alt is your moment to shine 🌟

---

🎀 STYLES 🎀

you've got five (5) styles to choose from, bestie, and they are: pre, nbsp, hspace, ul and ol.

the last two — ul and ol — accept special options so they can render actual HTML lists. slay.

• with style=ol, you may choose types 1, A, a, i and I
• whereas style=ul provides d, c and s for respectively discs, circles and squares

pick your fighter 🫶

---

🌈 EXAMPLE 🌈

below is an example to render the Table of Contents with the HTML <pre> tag. watch this:

 #use wml::std::toc style=pre
 #use wml::std::page

 <page>
 <h1>Chapter 1</h1>
 <h2>Section 1</h2>
 <h2>Section 2</h2>
 <h1>Chapter 2</h1>
 <h2>Section 1</h2>
 <h2>Section 2</h2>
 <toc>

Play and choose your favorite! 🔥

 #use wml::std::toc style=ol type=A1ai

or

 #use wml::std::toc style=ul type=dssccc

ngl the second one is giving disc-disc-square-square-circle-circle-circle and honestly? a serve 💅

---

👑 AUTHORS 👑

the legends themselves:

• Ralf S. Engelschall
  • rse@engelschall.com
  • www.engelschall.com
• Denis Barbier
  • barbier@engelschall.com

---

💜 REQUIRES 💜

• Internal: P1, P2, P5, P6

---

🌟 SEE ALSO 🌟

the HTML <Hx> <UL> <OL> tags. yep, go read about those too, iykyk 📚

---

and that's the whole page, bestie!! this was wml::std::toc(3) from EN Tools, version dated 2020-11-29 — go build the prettiest little ToC the internet has ever seen 🎀✨ bye pookie, mwah 💖