Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | |||
Modul | Deutsch | English
|
Modul: | Dokumentation |
Shortcuts
– Modul zur zentralen Verwaltung von Shortcut-Verlinkungen auf häufig benutzte Seiten.
Funktionen für Vorlagen
- template
- Unterstützung einer {{Shortcut}} – Hinweis auf der Zielseite darstellen
- Parameter der Vorlageneinbindung:
1
- Liste von Shortcuts auf diese Seite, durch Kommata getrennt
- HTML-Tags wie
<s>
sind möglich und werden ignoriert. - Optional – Vorgabe: aus zentraler Registrierung entnehmen; geht dem Vorlagenparameter vor
light
- Styling des Hinweises unterdrücken
- Optional – Vorgabe: Hinweis an bestimmter Position platzieren:
style
- Überprüft:
- Ist jeder Shortcut in der Liste eine Weiterleitungsseite?
- Verweist diese Weiterleitungsseite effektiv auf die momentane Zielseite?
- Ist die Weiterleitungsseite richtig kategorisiert?
- (geplant) Wenn eine Diskussionsseite existiert: Ist diese mit {{Shortcut}} ausgestattet?
- total
- Tabellenrumpf aller Shortcuts, primär nach Abkürzungstitel sortiert
- Parameter des
#invoke
:nsn
- Nummer eines Namensraums
- Optional – Vorgabe: alle
- Muss durch zweispaltigen Tabellenkopf Shortcut / Zielseite ergänzt werden.
- trows
- Unterstützung einer oder mehrerer {{Shortcuts}} – Tabellenzeile(n) (zwei Spalten) in einer Übersicht generieren
- Parameter der Vorlageneinbindung:
1
- Kanonischer Name einer registrierten Zielseite (Leerzeichen-Format)
- Pflichtparameter
2 3 4 5 6 7 8 9
…- Weitere Seitennamen (beliebig viele)
- Optional
space
- Kanonischer Name eines Namensraums, der allen registrierten Zielseiten vorangestellt wird; dann sind nur noch die Seitentitel anzugeben.
- Optional
story
- Wikitext mit Zusatz zum Namen der Zielseite
- Optional
suffix
- Wikitext mit Zusatz zur Liste der Shortcuts
- Optional
- twoletters
- Matrix aller Zwei-Buchstaben-Abkürzungen im Namensraum mit Hervorhebung registrierter Shortcuts.
- Noch nicht implementiert.
- Parameter des
#invoke
:nsn
- Nummer eines Namensraums
- Pflichtparameter
Konfiguration
Die in der deutschsprachigen Wikipedia gültigen Einstellungen werden unter /config beschrieben.
Allgemeine Hinweise zur Einbindung von Modulen
Eine Einbindung erfolgt jeweils im Format
{{#invoke: Shortcuts |
Funktionsname | Wert1 | Wert2 | NameX=Wert … }}
Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; deren Regeln gelten analog.
Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=
Wert gearbeitet werden.
Zu allgemeinen Problemen beachte die Abhilfen wie bei Vorlagen.
Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer die Vorlage:Dokumentation/Lua in der Dokumentationsseite eingebunden werden.
- Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
- Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
- Die Vorlage wird zur Übersicht kategorisiert in Kategorie:Vorlage:mit Lua-Programmierung.
Zu weiteren Informationen siehe Hilfe:Lua.
Bei Problemen wende dich bitte an die Vorlagen-Werkstatt, in schweren Fällen hilft auch die Lua-Werkstatt.