Willow: the mass documenting

2026-06-20T11:54:57Z

the mass documenting

New page

'''Module:Equipment re-renders every {{tl|ItemInfobox}} block from a section of a category template, so class pages and listing pages stay automatically in sync with the item templates.'''
__TOC__

== Overview ==

The wiki keeps each item's infobox once, inside a category template such as <code>Template:Swords/Weapons</code> or <code>Template:Untiered/Heavy/Armours</code>. Those templates are split into named sections (e.g. <code>Untiered</code>, <code>Helmets</code>, <code>Chestplates</code>) separated by <code>|-|</code> table-row markers.

This module lets another page pull just one section of one of those templates and display all the {{tl|ItemInfobox}} blocks it contains. The main use is on class pages (Knight, Assassin, Huntress, Arcanist, Necromancer, Samurai, etc.), which list the gear a class can use by pointing at the relevant section of each category template. Because the items are read live from the source template, the class page never needs to be edited when an item is added or changed — it always mirrors the template.

== Functions / entry points ==

{| class="wikitable"
! Function (#invoke) !! What it does !! Called by
|-
| <code>p.section</code> || Loads <code>Template:<arg1></code>, optionally narrows it to the section named by <code>arg2</code>, finds every <code>{{ItemInfobox...}}</code> block in that range, wraps them in a <code><div class="display-items"></code>, and renders them. Returns <code>''No items.''</code> if the template/section is missing or empty. || Class pages, e.g. {{tl|Knight}}, {{tl|Assassin}}, {{tl|Huntress}}, {{tl|Arcanist}}, {{tl|Necromancer}}, {{tl|Samurai}}
|}

== How it's used ==

<code>{{#invoke:Equipment|section|<TemplateName>|<SectionName>}}</code>

Real examples from class pages:

<pre>
{{#invoke:Equipment|section|Swords/Weapons|Untiered}}
{{#invoke:Equipment|section|Untiered/Heavy/Armours|Helmets}}
{{#invoke:Equipment|section|Cloaks/Abilities|Untiered}}
</pre>

* '''Argument 1''' is the category template title without the <code>Template:</code> prefix (the module adds it). Slashes are kept as-is, so <code>Swords/Weapons</code> means <code>Template:Swords/Weapons</code>.
* '''Argument 2''' is the section name to extract. If omitted (or empty) the whole template is scanned. The section is delimited by a line matching <code><Section> =</code> at the start and the next <code>|-|</code> row marker.

Editors normally just place these invoke lines on a class/listing page (or inside a tabber). The actual item data is edited in the category templates, not here.

== Notes ==

* Section extraction is purely text-based: it looks for a line beginning with the section name followed by <code>=</code>, then cuts off at the next <code>\n|-|</code> marker. The section names therefore must match the labels used in the category template's tabber rows.
* It collects content by matching <code>{{ItemInfobox(.-)}}</code>, so only {{tl|ItemInfobox}} blocks are picked up. Each block is then expanded normally, so it renders through {{ml|Infobox}} like any other item infobox.
* Output is wrapped in <code><div class="display-items"></code> for the grid styling used on listing pages.
* '''Related modules:''' {{ml|Shinies}} (same pattern, but only emits the Shiny version of untiered items), {{ml|Reskins}} (lists/renders reskin variants), and {{ml|Infobox}} (the engine that actually renders each block).

Module:Equipment/doc - Revision history

Willow: the mass documenting