aephea-ref(7)

🎀 NAME 🎀

aephea-ref — A description of the Aephea definitions for referencing

okay bestie, welcome to aephea-ref(7) 💖 this one lives in the MISCELLANEOUS section of the manual, and it's literally just the full rundown of the Aephea referencing definitions. no cap.

✨ DESCRIPTION ✨

so here's the tea 🫖 — the definitions on this page are used by the Aephea simpledocument class, and also by the Portable Unix Documentation (pud) manual and faq classes (peep pud-man(7) and pud-faq(7) if you wanna go deeper, iykyk).

🌸 MACROS 🌸

• \refload#2
• \refloadx#2

okay so both of these macros take, as their first argument, a label that uniquely defines the reference. the second argument is a vararg holding key-value pairs.

these macros are usually not needed in Aephea classes — they're lower level facilities, fr fr. like, the plumbing, not the faucet. 🔧

• \ref#2

first argument = a label. second argument = a key associated with that label. the result? the value associated with the label/key pair. slay.

again: usually not needed in Aephea classes. these are lower level facilities used by high level Aephea definitions (e.g. \iref#2, and \secref#1). so they're the backstage crew, not the main character 💅

• \refcaption#1
• \refnumber#1
• \reflevel#1

the argument is a label. the result is, respectively, the caption, the number, or the level associated with that label. three little icons, three little vibes ✨

• \reference#1
• \refer#1

okay so the first one associates a number with the label that's in the first argument, and prints it inbetween square brackets. the label is anchored to this location. the second one outputs the associated number inbetween brackets, and makes it carry a link to the anchor. for example, I am about to create a link [1] and another link [2] to the items appearing below. 👑

[1] The first reference.

[2] The second reference.

if you prefer another bibliography style, find the macros and adapt them according to your needs — they are very simple. go off, customize your little heart out 🎀

\reference#2 currently writes data to the file \__fnbase__.zmr, to be read back in using a \load{\__fnbase__.zmr} statement. this is automatically done when using any of the Aephea classes. so like, it's handled for you, don't stress 💖

and that's the whole page, bestie 🌈 no notes, ate and left no crumbs.

this was aephea-ref 1.002, 10-008, dated 8 Jan 2010 — yes she's an elder but she's still iconic, periodt. 💜🦋