Das offizielle Minecraft Wiki twittert hier: Wiki-Twitter  –  Chatte im Wiki-Discord  –  Noch keinen Server gefunden? Es gibt einen Wiki-Server

Hello there! We are conducting a survey to better understand the user experience in making a first edit. If you have ever made an edit on Gamepedia, please fill out the survey. Thank you!

Minecraft Wiki:Projekte/Vorlagendoku-Umstellung

Aus Minecraft Wiki
Wechseln zu: Navigation, Suche
Diese Seite ist Teil eines Projektes. Für die Bearbeitung brauchst Du die Erlaubnis des Projektleiters violine1101 oder eines Administrators.

Ziel[Bearbeiten]

Das Ziel dieses Projektes ist es, das bisherige System für Vorlagendokumenationen auf ein Lua-Modul umzustellen.

Bisher haben wir folgendes System:

  • /doc - Zu jeder Vorlage gibt es die Unterseite "/doc", die in die Vorlage mit <noinclude>{{/doc}}</noinclude> eingebunden ist (zusammen mit der Navigationsbox).
  • Vorlage:Doku/Start - Jede Unterseite "/doc" bindet am Anfang diese Vorlage ein. Sie erzeugt in allen Vorlagendokumentationen einen einheitlichen Dokumentationskopf.
  • Vorlage:Doku/Ende - Jede Unterseite "/doc" bindet am Ende diese Vorlage ein. Sie erzeugt in allen Vorlagendokumentationen einen einheitlichen Dokumentationsfuß.
  • Vorlage:Doku - Keine übliche Skriptvorlage, sondern ein Textbaustein. Er ist die Dokumentation für die Vorlagen "Doku/Start" und "Doku/Ende" und wird in diesen beiden Vorlagen am Ende mit {{Doku}} eingebunden.

Neu soll folgendes System sein:

  • /Dokumentation - Zu jeder Vorlage gibt es die Unterseite "/Dokumentation". Die Vorlage bindet sie durch den Aufruf der Vorlage <noinclude>{{Dokumentation}}</noinclude> ein (ohne Navigationsbox). Die Dokumentation selbst ruft die Vorlage {{Dokumentationskopf}} auf und enthält jetzt auch die Navigationsbox und evtl. Interwikilinks (mit <includeonly>-Tags).
  • Vorlage:Dokumentation - Sie ruft das neue "Modul:Dokumentation" auf (Wrapper-Funktion wie bei anderen Vorlagen mit Lua-Modulen).
  • Vorlage:Dokumentationskopf - Sie ersetzt "Doku/Start" und "Doku/Ende" und ruft ebenfalls das "Modul:Dokumentation" auf.
  • Modul:Dokumentation - Ein Lua-Modul, das nicht nur die bisherige Funktionalität von "Doku/Start" und "Doku/Ende" übernimmt, sondern weitere einheitliche Darstellungen für Vorlagen und Module übernimmt.

Vorteil:

  • Die neue Vorlage "Dokumentation" ist durch ihr Lua-Modul flexibler als es eine normale Vorlage sein kann und ermöglicht eine einheitliche Dokumenation von Vorlagen und Modulen (und ggf. auch Skripten).

Arbeitsschritte[Bearbeiten]

Vorlagen und Module erstellen oder anpassen[Bearbeiten]

Vorbereitung[Bearbeiten]

  • Verschiebung der Vorlage:Grid2 und Unterseiten nach Vorlage:Grid
  • Alle Vorlagendokumentationen prüfen:
    • clear enthalten?
    • nodoc=1 enthalten?
    • baddoc=1 enthalten?

Umstellen des Dokusystems[Bearbeiten]

Siehe auch hier.

  • In allen Vorlagen
    • {{/doc}} durch {{Dokumentation}} oder (bei Vorlagen, die ein Modul verwenden) {{Dokumentation|lua=Modulname}} ersetzen
    • Die Interwikilinks und die Navbox in die Dokumentation verschieben (s.u.)
  • Alle Vorlagendokumentationen von /doc nach /Dokumentation verschieben
  • In allen Dokumentationen (auch in Moduldokumentationen)
    • {{Doku/Start}} durch {{Dokumentationskopf}} ersetzen
    • {{Doku/Ende}} ersetzen durch:
<includeonly>
Navbox aus der Vorlage
Interwikilinks aus der Vorlage
</includeonly>

Nicht mehr benötigte Vorlagen löschen[Bearbeiten]

  • Doku löschen
  • Doku/Start löschen
  • Doku/Ende löschen
  • Hilfe:Vorlagen anpassen

Weiterführend[Bearbeiten]

  • Wichtigste Stylesheets und Skripte dokumentieren (wenn möglich)

Zu ändernde Vorlagen und Module[Bearbeiten]

Legende: Die Vorlage bzw. das Modul...


  • wird nicht umgestellt.

  • ist oder wird (noch) nicht umgestellt. Siehe Diskussion.

  • ist noch nicht umgestellt.

  • wird gerade umgestellt.

  • ist teilweise umgestellt.

  • ist umgestellt.

Babel[Bearbeiten]

Daten und Zahlen[Bearbeiten]

Module[Bearbeiten]

Formatierung[Bearbeiten]

Module[Bearbeiten]

Hinweise[Bearbeiten]

Navigation[Bearbeiten]

Rezepte[Bearbeiten]

Steckbriefe[Bearbeiten]

Module[Bearbeiten]

Symbole und Grafiken[Bearbeiten]

Module[Bearbeiten]

Tabellen[Bearbeiten]

Verlinkung[Bearbeiten]

Widgets[Bearbeiten]

Versionen[Bearbeiten]

Module[Bearbeiten]

Neu[Bearbeiten]

Module[Bearbeiten]