Wikipedia:Lua/Modul/Tutorial

Vorlagenprogrammierung	Diskussionen	Lua			Unterseiten
		Modul	Deutsch	English	Modul:	Dokumentation

Tutorial – Modul zur Navigation und Verwaltung strukturierter interaktiver mehrseitiger Dokumente.

Seitenstruktur

In einem Wiki sind beliebig viele „Pakete“ (packages) möglich, die jedes beliebig viele Stränge (trails) enthalten kann, deren jeder aus beliebig viele Einzelseiten (lessons) bestehen kann.

Für das Wiki ist eine gemeinschaftliche lokalsprachige Anpassung möglich.

• Modul:Tutorial/config – deutsch

Paket

Das Paket definiert, welche Stränge hinzugehören, und ein Design.

Alle Wikitext-Seiten müssen Unterseiten ein und derselben Oberseite sein.

• Unter-Unterseiten davon sind nicht zulässig.

Das Definitionsmodul des Pakets trägt den gleichen Unterseiten-Namen wie die Oberseite.

• Es legt fest, welche Stränge bestehend aus welchen Einzelseiten dazugehören sollen.

Beispiel:

• Wikipedia:Tutorial – gemeinsame Oberseite des Pakets
• Modul:Tutorial/Wikipedia:Tutorial – Definitionsmodul des Pakets

Das Definitionsmodul des Pakets muss eine table mit folgenden (mehr oder weniger optionalen) Komponenten ergeben:

bottom

Definition einer Legende für das Navigationselement

table mit folgenden Komponenten:

service

Linkziel

show

Linktitel

cat

Titel einer Kategorie, in die alle Seiten eingeordnet werden

show

Titel für das Navigationselement

style

Dekorative Anpassungen

table mit folgenden Komponenten:

bgc

Hexcode der Hintergrundfarbe

border

Rahmen des Navigationselements

table

border-Eigenschaften (CSS)

fgc

Hexcode der Vordergrundfarbe

h1

Seitenüberschrift

table

CSS-Eigenschaften

icon

Titel eines Icon für das Navigationselement

size

Höhe des Titels für das Navigationselement

supreme

Oberseite des Pakets

trails

Definition der Stränge und Einzelseiten

sequence table mit folgenden Komponenten:

• Strang
• Reihenfolge entsprechend der Gesamtübersicht
• sequence table mit folgenden Komponenten:
  1. Seitentitel des Strangs
  2. Einzelseiten
     • sequence table mit Seitentiteln der Einzelseiten
     • Reihenfolge entsprechend der Abfolge

Strang

Der Strang wird durch trails definiert.

Jeder Strang kann auf zwei Arten präsentiert werden:

• Abfolge von Einzelseiten
• Zusammenstellung aller Einzelseiten auf einer Seite
  • Der Seitentitel ist der in trails definiert Wert.
  • Die Zusammenstellungsseite wird mit start gekennzeichnet.

Einzelseite

Jede (inhaltliche) Einzelseite kann in einem, mehreren oder keinem Strang verwertet werden.

Jede inhaltliche Einzelseite wird mit single gekennzeichnet.

Virtuelle Seiten

Die angezeigten Seiten in der Abfolge eines Strangs erhalten einen Seitentitel, der aus zwei Zahlen besteht:

• Nummer des Strangs
• Nummer der Einzelseite

In die virtuellen Seiten werden die momentan vorgesehenen Einzelseiten projiziert.

Jede virtuelle Seite wird mit page gekennzeichnet.

Funktionen für Vorlagen

begin

Seitenname der Startseite eines Themas

1

Kennung des Themas

2

(optional) Kennung des Pakets

gadget

GUI-Element abrufen

1

Kennung des Pakets

2

Art des Elements

index

Liste aller Seiten aller Stränge oder eines Strangs

less

(boolean optional) Nur Zusammenfassung, nicht gleichzeitig Name zeigen

isVirtual

Ist dies eine virtuelle Seite?

not

(boolean optional) Negation

page

Virtuelle Seite mit einer Einheit

single

Einzelne Inhaltsseite

summary

Zusammenfassung

start

Startseite eines Strangs

summary

Zusammenfassung

style

Standard-Stil abrufen

1

Kennung des Pakets

2

Art des Stils

failsafe

Versionsinformation

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Tutorial | 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.

1. Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
2. Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
3. 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.