Bonsaibauer: 1 revision imported: Import Star Citizen Modules

2026-11-04T22:22:11Z

1 revision imported: Import Star Citizen Modules

← Older revision		Revision as of 22:22, 4 November 2026
(No difference)

starcitizen>Alistar Bot: Sync from Git (adad5b3) (via update-page on MediaWiki MCP Server)

2026-09-25T03:38:19Z

Sync from Git (adad5b3) (via update-page on MediaWiki MCP Server)

New page

{{documentation|git=true}}

Renders the main page: hero, highlights, featured article, on this day, the editing invitation, two community cards, and the directory.

Editors use this through <code><nowiki>{{Mainpage}}</nowiki></code>; see [[Template:Mainpage]] for what an editor can change and where.

== For module editors ==

=== Submodules ===

{| class="wikitable"
|-
! Submodule
! Renders
|-
| <code><nowiki>Mainpage/Config</nowiki></code>
| Loads <code><nowiki>settings.json</nowiki></code>; normalises it to plain Lua and resolves which build is live.
|-
| <code><nowiki>Mainpage/Nav</nowiki></code>
| Turns a settings link entry into wikitext; the hero chips and the directory both read it.
|-
| <code><nowiki>Mainpage/Hero</nowiki></code>
| The full-bleed hero band: patch status, wiki statline, lede, search trigger, chip strip.
|-
| <code><nowiki>Mainpage/Highlights</nowiki></code>
| The band under the hero: the event card (whichever design applies) and the current-patch card.
|-
| <code><nowiki>Mainpage/Event</nowiki></code>
| The event card built on a 1080×83 banner strip.
|-
| <code><nowiki>Mainpage/Event/Legacy</nowiki></code>
| The event card built on an ordinary photograph.
|-
| <code><nowiki>Mainpage/Featured</nowiki></code>
| The featured card: a whole-card link over the featured article's picture.
|-
| <code><nowiki>Mainpage/OnThisDay</nowiki></code>
| Today's date page, transcluded as a two-panel tabber.
|-
| <code><nowiki>Mainpage/Editing</nowiki></code>
| The editing invitation; the recent-changes list beneath it is built entirely by the mainpage gadget.
|-
| <code><nowiki>Mainpage/Community</nowiki></code>
| The funding card and the Discord/follow card.
|-
| <code><nowiki>Mainpage/Directory</nowiki></code>
| The grouped text directory at the foot.
|}

<code><nowiki>Mainpage.lua</nowiki></code> composes these into the page and renders the foot row itself; that row is small enough to not need a submodule of its own. Buttons come from [[Module:ButtonLua]], the badge from [[Module:BadgeLua]], and the clock from [[Module:Countdown]]: each keeps its own look, and this module supplies only content and placement.

=== Settings contract ===

Every other submodule reads settings through <code><nowiki>Config</nowiki></code>, never through <code><nowiki>mw.loadJsonData</nowiki></code> directly:

* <code><nowiki>Config.section(name)</nowiki></code> / <code><nowiki>Config.list(name)</nowiki></code>: one top-level object or array, <code><nowiki>{}</nowiki></code>/empty when the section is missing or blank, so a caller never has to nil-check first (<code><nowiki>Config.lua:101-116</nowiki></code>).
* <code><nowiki>Config.toIso(value)</nowiki></code>: a settings date to ISO 8601 UTC, or <code><nowiki>nil</nowiki></code> for anything it can't read; it never raises (<code><nowiki>Config.lua:134-163</nowiki></code>).
* <code><nowiki>Config.livePatch()</nowiki></code>: the build every consumer agrees is "live" (the first <code><nowiki>patches</nowiki></code> entry with <code><nowiki>channel: "LIVE"</nowiki></code>, else the first with a <code><nowiki>name</nowiki></code>), resolved once so the hero's status chip and the patch card can't disagree (<code><nowiki>Config.lua:177-193</nowiki></code>).
* <code><nowiki>load()</nowiki></code> wraps <code><nowiki>mw.loadJsonData</nowiki></code> in <code><nowiki>pcall</nowiki></code>; a moved or deleted settings page degrades to <code><nowiki>{}</nowiki></code> rather than raising (<code><nowiki>Config.lua:80-90</nowiki></code>).

<code><nowiki>toPlain</nowiki></code> (<code><nowiki>Config.lua:47-77</nowiki></code>) copies the loaded page's read-only table (whose metatable breaks <code><nowiki>#</nowiki></code> and <code><nowiki>next()</nowiki></code>) into a plain one, dropping blank strings to <code><nowiki>nil</nowiki></code>, compacting arrays, and discarding every <code><nowiki>_</nowiki></code>-prefixed key as editor guidance. Read a new settings field through <code><nowiki>Config</nowiki></code>, never a second <code><nowiki>mw.loadJsonData</nowiki></code> call.

=== Styles ===

{| class="wikitable"
|-
! Page
! Holds
|-
| <code><nowiki>Mainpage/styles.css</nowiki></code>
| The hero, the bands, the grid, and the responsive stages.
|-
| <code><nowiki>Mainpage/cards.css</nowiki></code>
| The individual cards, the directory, and the foot.
|-
| <code><nowiki>Mainpage/ground.css</nowiki></code>
| The graduation tapes and the dot lattice behind the page.
|}

The page runs full bleed: <code><nowiki>MediaWiki:Citizen.css</nowiki></code> drops the body container's gutter for this page, letting the bands paint edge to edge; that rule lives outside this module and this repository (<code><nowiki>Mainpage/styles.css:11-12</nowiki></code>).

=== Gadget ===

<code><nowiki>MediaWiki:Gadget-mainpage.js</nowiki></code> enhances the rendered page: it loads the hero artwork after page load, rolls the stat digits and search-label tail, drives the clock, manages the two scrolling cards' fade cues, and builds the activity list, reading its context from <code><nowiki>data-gadget-mainpage-*</nowiki></code> attributes (so <code><nowiki>grep gadget-mainpage-</nowiki></code> finds every emitter). The page renders and reads correctly with the gadget absent, except the activity list: without the gadget it stays empty and the card offers its "See all changes" link instead.

=== Previewing ===

<syntaxhighlight lang="wikitext">
{{#invoke:Mainpage|hero}} 
{{#invoke:Mainpage|hero|noscript=yes}} 
</syntaxhighlight>

=== Gotchas ===

* <code><nowiki>Module:Mainpage/settings.json</nowiki></code> is editor-owned content, not tracked in this repository (gitignored: <code><nowiki>.gitignore:20</nowiki></code>); <code><nowiki>deploy-to-wiki</nowiki></code> skips it even if a stale copy is sitting on disk, since deploying it would silently revert an editor's changes.
* <code><nowiki>STYLESHEETS</nowiki></code> lists [[Module:CardLua]]'s <code><nowiki>styles.css</nowiki></code> explicitly: six of the seven cards use plain <code><nowiki>.t-card</nowiki></code> divs, so their surface, border, and radius would otherwise depend on the event card (the only CardLua consumer) rendering (<code><nowiki>Mainpage.lua:41-54</nowiki></code>).
* Card spans (<code><nowiki>.home-card--read</nowiki></code>, <code><nowiki>--aside</nowiki></code>, <code><nowiki>--tall</nowiki></code>) are placement properties, not display ones: a class that sets <code><nowiki>display</nowiki></code> must never share an element with <code><nowiki>t-card</nowiki></code>, since CardLua's own <code><nowiki>display</nowiki></code> would collide (<code><nowiki>Mainpage.lua:18-21</nowiki></code>).
* The split event card's clock is restyled from the page for one viewport range (640-899.98px, <code><nowiki>Mainpage/styles.css:541-603</nowiki></code>), duplicating [[Module:Countdown]]'s stacked/flat declarations by hand, since a CSS class can't be conditional on viewport width. The banner card avoids this by asking Countdown for <code><nowiki>t-countdown--flat</nowiki></code> at every width instead.
* <code><nowiki>band()</nowiki></code> takes varargs, not a table, since <code><nowiki>ipairs</nowiki></code> stops at the first <code><nowiki>nil</nowiki></code> and would let one declined card drop every card listed after it (<code><nowiki>Mainpage.lua:87-105</nowiki></code>).
* The foot row's edit link and <code><nowiki>Mainpage/OnThisDay</nowiki></code>'s "Add an event" link both use <code><nowiki>mw.uri.fullUrl</nowiki></code>, not <code><nowiki>callParserFunction</nowiki></code>: <code><nowiki>fullurl</nowiki></code> is a colon magic word (<code><nowiki>fullurl:</nowiki></code>) that <code><nowiki>callParserFunction</nowiki></code> cannot resolve (<code><nowiki>Mainpage.lua:107-130</nowiki></code>, <code><nowiki>OnThisDay.lua:94-104</nowiki></code>).
* <code><nowiki>Mainpage/Editing</nowiki></code>'s recent-changes list is built entirely by <code><nowiki>MediaWiki:Gadget-mainpage.js</nowiki></code> from <code><nowiki>list=recentchanges</nowiki></code>: without JS the container renders empty and the card falls back to its "See all changes" link (<code><nowiki>Editing.lua:10-12</nowiki></code>).
* The directory's column count isn't set in Lua: <code><nowiki>.home-dir</nowiki></code> is <code><nowiki>repeat(auto-fit, minmax(125px, 1fr))</nowiki></code>, so the groups reflow on their own and <code><nowiki>Mainpage/Directory</nowiki></code> just emits them (<code><nowiki>Directory.lua:10-13</nowiki></code>).

=== Extending ===

Every band shares one layout contract: <code><nowiki>.home-band</nowiki></code> is the full-bleed ground, <code><nowiki>.home-band__inner</nowiki></code> the measured column inside it, and a band of cards adds <code><nowiki>.home-grid</nowiki></code> on that inner element, all off one shared twelve-column grid; a band with its own column ratios breaks alignment for every other band (<code><nowiki>Mainpage.lua:11-17</nowiki></code>).

A new card is a submodule with a <code><nowiki>render()</nowiki></code> that returns <code><nowiki>nil</nowiki></code> or a string; wire its call into <code><nowiki>Mainpage.render</nowiki></code>'s band composition and, if it ships its own stylesheet, add it to <code><nowiki>STYLESHEETS</nowiki></code> explicitly. It then picks one of the three span classes (<code><nowiki>.home-card--read</nowiki></code> spans 8, <code><nowiki>.home-card--aside</nowiki></code> 4, <code><nowiki>.home-card--tall</nowiki></code> 8 across two rows); between 640 and 899.98px every span collapses to 6, and below 640 the page is one column in DOM order, so a new span value needs checking against both breakpoints.

Module:Mainpage/doc - Revision history

Bonsaibauer: 1 revision imported: Import Star Citizen Modules

starcitizen>Alistar Bot: Sync from Git (adad5b3) (via update-page on MediaWiki MCP Server)