Willow: the mass documenting

2026-06-20T11:54:59Z

the mass documenting

New page

'''Module:Shinies pulls the {{tl|ItemInfobox}} blocks from a category template and re-renders only the items that have a "Shiny" sprite, swapping in the Shiny image so a page can show a gallery of shiny variants.'''
__TOC__

== Overview ==

Some untiered items have a rarer "Shiny" version. The shiny version isn't stored as a separate infobox; instead its image is the normal item image with a <code>Shiny</code> prefix (e.g. <code>File:Ut-Onyxblade.png</code> → <code>File:ShinyUt-Onyxblade.png</code>).

This module scans a category template (like <code>Template:Swords/Weapons</code>), finds every {{tl|ItemInfobox}} whose image is an untiered <code>Ut-...png</code> file '''and''' for which a matching <code>File:ShinyUt-...png</code> exists, and re-renders just those items with the shiny image substituted. The result is a gallery of all shiny variants for that category, used on the Shinies overview page. Items without a shiny file are skipped.

It is the same "read the source template live" pattern as {{ml|Equipment}}, so the Shinies page stays in sync with the item templates automatically.

== Functions / entry points ==

{| class="wikitable"
! Function (#invoke) !! What it does !! Called by
|-
| <code>p.fromTemplate</code> || Loads <code>Template:<arg1></code> (optionally narrowed to section <code>arg2</code>), finds each {{tl|ItemInfobox}} with a <code>Ut-...png</code> image that has a corresponding <code>File:ShinyUt-...png</code>, rewrites the image to the Shiny file, wraps the results in <code><div class="display-items shiny-frame"></code> and renders them. Returns <code>''No shinies yet.''</code> if none qualify. || The {{tl|Shinies}} listing page
|}

== How it's used ==

<code>{{#invoke:Shinies|fromTemplate|<TemplateName>|<SectionName>}}</code>

Real examples (from the Shinies listing template/page):

<pre>
Swords={{#invoke:Shinies|fromTemplate|Swords/Weapons}}
Katanas={{#invoke:Shinies|fromTemplate|Katanas/Weapons}}
Emblems={{#invoke:Shinies|fromTemplate|Emblems/Abilities}}
</pre>

* '''Argument 1''' — category template title without <code>Template:</code> (e.g. <code>Swords/Weapons</code>).
* '''Argument 2''' (optional) — section name to narrow to, same delimiting rules as {{ml|Equipment}} (line starting <code><Section> =</code>, cut at the next <code>|-|</code>).

Editors add the items themselves to the category templates; the Shinies page just invokes this module per category. You do not maintain a separate shiny list — uploading a correctly named <code>ShinyUt-...png</code> file is what makes an item appear here.

== Notes ==

* '''File-naming scheme is load-bearing.''' Detection relies on the untiered-item naming convention: the base image must be <code>Ut-<Name>.png</code>, and the shiny must be the same name prefixed with <code>Shiny</code>, i.e. <code>ShinyUt-<Name>.png</code>. The image regex specifically matches <code>Images = Ut-...png</code> and rewrites only the first occurrence in the block.
* Only items with an existing shiny file are emitted; everything else in the template is silently ignored.
* Output carries the extra <code>shiny-frame</code> CSS class (on top of <code>display-items</code>) for the shiny gallery styling.
* {{ml|Infobox}} itself also auto-adds a Shiny tab to a single-image untiered infobox (same <code>ShinyUt-</code> rule). This module is the bulk/gallery counterpart: it lists shinies across a whole category rather than per item.
* '''Related:''' {{ml|Equipment}} (renders all items in a section), {{ml|Infobox}} (the rendering engine and the per-infobox Shiny tab), {{tl|ItemInfobox}}.

Module:Shinies/doc - Revision history

Willow: the mass documenting