Modul:CommLinkList
Weitere Optionen
- Module:CommLinkList
Rendert die Comm-Link-Liste als sortier- und filterbare AG-Grid-Tabelle über die SMW-Backend-Anbindung der [AGGrid-Erweiterung](https://www.mediawiki.org/wiki/Extension:AGGrid). Aufgerufen durch [Vorlage:Comm-Link list](https://star-citizen.wiki/Vorlage:Comm-Link_list); die einzige einbindende Seite ist [Comm-Link:Übersicht](https://star-citizen.wiki/Comm-Link:%C3%9Cbersicht).
- Für Bearbeiter
`
` auf einer Seite platzieren. Jede Zeile kommt aus einer serverseitigen SMW-Abfrage über `Kategorie:Comm-Link` (nur Basisseiten, per `+depth=0` und gesetzter Comm-Link-ID): eine Comm-Link-Seite erscheint also allein dadurch, dass `Vorlage:CommLink` ihre Metadaten schreibt - ohne Bearbeitung dieses Moduls.
Die Tabelle lädt seitenweise vom REST-Endpunkt der Erweiterung; Sortierung, Spaltenfilter, Schnellsuche und der Gesamtzähler laufen serverseitig über die gesamte Treffermenge, nicht nur über die geladene Seite. Standardmäßig absteigend nach Veröffentlichung sortiert.
- Parameter
| Name | Beschreibung | | --- | --- | | serie | Optional. Nur Comm-Links dieser Serie (Attribut:Comm-Link-Serie). | | kanal | Optional. Nur Comm-Links dieses Kanals (Attribut:Comm-Link-Channel). |
- Für Modul-Bearbeiter
- API
- `p.main(frame)`: Einstiegspunkt; baut die `source`-Beschreibung (`type = 'smw'`, Bedingungsfragmente, Printouts mit deutschen Spaltenaliasen) und übergibt sie an `mw.ext.aggrid.render`.
- Gotchas
- Die Anfangssortierung läuft über AG Grids `initialState.sortModel`, nicht über den Quell-Deskriptor (der SMW-Quelltyp hat kein `orderBy`); `colId` ist der Printout-Alias. Wird `Erstelldatum=Veröffentlichung` umbenannt, endet die Anfangssortierung still. - Filterwerte (`serie`, `kanal`) werden von `[`/`]` befreit; ein Wert bleibt sonst eine eigene Bedingung innerhalb der Abfrage. - Seiten ohne gespeicherte `Comm-Link-ID` (nie geparste Importe) fehlen in der Liste bis zu ihrem Reparse; gleiches gilt für veraltete Feldinhalte, bis die Seite neu geparst wird.
require('strict')
--- @module CommLinkList
--- Renders the Comm-Link list as an AGGrid source grid over the AGGrid
--- extension's SMW backend (gridOptions.source). Rows, sorting, filters,
--- quick search, and paging all run server-side through the extension's
--- cacheable REST endpoint, keeping the page light and the parse cheap.
--- Invoked by {{Comm-Link list}}.
---
--- Initial sort: source.orderBy sorts server-side from the very first
--- block fetch, descending by Veröffentlichung (newest first). The
--- initialState.sortModel only mirrors that as the header sort arrow; the
--- data arrives sorted at every stage. colId = field name = printout
--- alias; renaming the alias silently breaks both.
local p = {}
--- The SMW properties {{CommLink}} writes on every base page.
local SMW = {
series = 'Comm-Link-Serie',
channel = 'Comm-Link-Channel',
}
--- Template and #invoke arguments; #invoke wins so
--- `{{#invoke:CommLinkList|main|serie=...}}` stays testable.
--- @param frame frame
--- @return table
local function readArgs(frame)
local args = {}
local parent = frame.getParent and frame:getParent()
if parent and parent.args then
for k, v in pairs(parent.args) do
args[k] = v
end
end
for k, v in pairs(frame.args or {}) do
args[k] = v
end
return args
end
--- {{Comm-Link list}} entry point.
--- @param frame frame optional arguments: `serie`, `kanal`
--- @return string
function p.main(frame)
local aggrid = require('mw.ext.aggrid')
local args = readArgs(frame)
-- Filter values are our own data, but brackets would break out of the
-- query condition; strip them entirely.
local function safe(value)
return value ~= nil and value:gsub('[%[%]]', '') or nil
end
local query = { '[[Kategorie:Comm-Link|+depth=0]]', '[[Comm-Link-ID::+]]' }
local serie, kanal = safe(args.serie), safe(args.kanal)
if serie ~= nil and serie ~= '' then
query[#query + 1] = '[[' .. SMW.series .. '::' .. serie .. ']]'
end
if kanal ~= nil and kanal ~= '' then
query[#query + 1] = '[[' .. SMW.channel .. '::' .. kanal .. ']]'
end
return aggrid.render{
source = {
type = 'smw',
query = query,
printouts = {
'Comm-Link-Titel=Titel',
'Comm-Link-Channel=Kanal',
'Comm-Link-Serie=Serie',
'Erstelldatum=Veröffentlichung',
},
mainlabel = 'Comm-Link',
orderBy = { field = 'Veröffentlichung', direction = 'DESC' },
},
initialState = {
sortModel = {
{ colId = 'Veröffentlichung', sort = 'desc' },
},
},
quickSearch = true,
pagination = true,
}
end
return p