Module:AbilitySection/doc: Difference between revisions

Vergir (talk | contribs)
m fix example
Vergir (talk | contribs)
Docs: document the interaction-hint rail rendered via Module:AbilityHints (with help from vergir-bot LLM)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:


Lua backend for [[Template:AbilitySection]]. Renders a two-column layout with the ability card on the left and an optional tabbed details panel on the right.
Lua backend for [[Template:AbilitySection]]. Renders a two-column layout with the ability card on the left and an optional tabbed details panel on the right.
Between the card and the details panel, an interaction-hint rail of small item icons is rendered via [[Module:AbilityHints]] (showing how the ability interacts with items — dispellable, reduced, blocked, etc.). When a rail is present, the card and rail are grouped in a <code>.ability-section-main</code> wrapper so the rail always wraps together with the card rather than onto the details' line; abilities with no interactions keep the flat single-card structure.


Only tabs with non-empty content are shown. If two or more tabs have content, a Show All tab is automatically appended that stacks all content in sequence with section headers between them.
Only tabs with non-empty content are shown. If two or more tabs have content, a Show All tab is automatically appended that stacks all content in sequence with section headers between them.
Line 7: Line 9:
The Notes tab is height-constrained with a scrollbar when content overflows (see [[Template:AbilitySection/styles.css]]). Other tabs are unconstrained.
The Notes tab is height-constrained with a scrollbar when content overflows (see [[Template:AbilitySection/styles.css]]). Other tabs are unconstrained.


If no content params are provided, no details panel is rendered at all — only the ability card.
If no content params are provided, no details panel is rendered at all — only the ability card (and its hint rail, if any).


== Entry point ==
== Entry point ==
Line 22: Line 24:
|-
|-
| <code>notes</code> || No || Wikitext for the Notes tab.
| <code>notes</code> || No || Wikitext for the Notes tab.
|-
| <code>interactions</code> || No || Wikitext for the Interactions tab.
|-
|-
| <code>tips</code> || No || Wikitext for the Tips tab.
| <code>tips</code> || No || Wikitext for the Tips tab.
Line 36: Line 36:
local TABS = {
local TABS = {
     { key = 'notes',        label = 'Notes'        },
     { key = 'notes',        label = 'Notes'        },
    { key = 'interactions', label = 'Interactions' },
     { key = 'tips',        label = 'Tips'        },
     { key = 'tips',        label = 'Tips'        },
}
}
Line 49: Line 48:
| notes =
| notes =
* This is an example of a note.
* This is an example of a note.
| interactions =
* This is an example of an interaction.
| tips =
| tips =
* This is an example of a tip.
* This is an example of a tip.
Line 61: Line 58:
| notes =
| notes =
* This is an example of a note.
* This is an example of a note.
| interactions =
* This is an example of an interaction.
| tips =
| tips =
* This is an example of a tip.
* This is an example of a tip.
Line 70: Line 65:


* [[Template:AbilitySection]] — template that invokes this module
* [[Template:AbilitySection]] — template that invokes this module
* [[Module:AbilityHints]] — interaction-hint icons rendered beside the card
* [[Template:AbilitySection/styles.css]] — CSS for the layout
* [[Template:AbilitySection/styles.css]] — CSS for the layout