Wikipedia:Lua/Modul/TNT

Vorlagenprogrammierung	Diskussionen	Lua		Unterseiten
		Modul	Deutsch	Modul:	Dokumentation

Das Modul erlaubt die Internationalisierung von Vorlagen, so dass deren lokalisierte Ausgabe und Dokumentation nur an einer Stelle (Wikipedia Commons) projektweit gepflegt werden muss.

Funktion msg

Die msg-Funktion benutzt eine Commons-Datentabelle um einen Text zu übersetzen. Dieser wird über einen Schlüssel angegeben, sowie weiteren optionalen Argumente, und gibt dessen dort hinterlegte Übersetzung in der aktuelle Sprache zurück. Wenn nötig kann die Sprache auch über den lang-Parameter explizit angegeben werden.

Die Datentabelle mit den Übersetzungen heißt üblicherweise I18n/<Template:Vorlagenname oder Module:Modulname>.tab (ohne die spitzen Klammern).

Beispiel:

{{#invoke:TNT|msg
 | I18n/Template:Graphs.tab       <!-- https://commons.wikimedia.org/wiki/Data:I18n/Template:Graphs.tab -->
 | source-table                   <!-- Übersetzung mit der id = "source-table" abrufen -->
 | param1}}                       <!-- optionaler Parameter -->

Ergebnis:

Rohdaten anzeigen oder bearbeiten

Funktion doc

Die doc-Funktion generiert einen übersetzten <templatedata>-Abschnitt für Vorlagen.

Das TemplateData-JSON-Element muss sich unter Data:Templatedata/<Vorlagenname>.tab auf Commons befinden.

Beispiel:

{{#invoke:TNT|doc|Graph:Lines}}

Verwendet https://commons.wikimedia.org/wiki/Data:Templatedata/Graph:Lines.tab und erzeugt folgende <templatedata>-Vorlage:

Diese Vorlage gibt eine oder mehrere unabhängige numerische Datenreihen als Liniendiagramm aus. Die Daten müssen entweder aus dem Commons-Data-Namensraum oder dem Wikidata-Abfragedienst kommen.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Tabellentyp	tabletype	Gibt den Typ der Tabellendaten an. "tab" (Standard) verwendet den Data-Namensraum von Commons ohne den data:-Präfix. "query" sendet eine Abfrage an den Wikidata-Abfragedienst. Standard tab	Mehrzeiliger Text	optional
Tabelle	table	Name der Datenseite auf Commons ohne den data:-Präfix. Die Tabelle sollte eine xField-Spalte besitzen, sowie eine oder mehrere weitere Spalten die als Datenreihen dargestellt werden. Wenn der tableType-Parameter "query" ist dann wird hier die Abfrage eingetragen.	Mehrzeiliger Text	erforderlich
Typ der X-Achse	type	Typ der X-Achse - time (z.B. "2015-10" oder "2013-03-08"), year (Ganzzahl die als Jahr behandelt wird), linear (Zahlen), ordinal (Sonstiges). Standard year	Mehrzeiliger Text	vorgeschlagen
X-Feld	xField	Id der Datenspalte die Werte der X-Achse enthält. Wenn type=year dann ist xField standardmäßig auch "year".	Mehrzeiliger Text	erforderlich
Datenreihen	series	Namen der Spalten die die Datenreihen enthalten. Diese müssen in Anführungszeichen gesetzt werden und durch ihre Feld-Ids wie sie auf der .tab-Seite angegeben sind referenziert werden: "field1", "field2", "field3".	Mehrzeiliger Text	optional
Gruppe	group	Wenn die Linienfarbe nur von einer Spalte abhängt, kann deren Id hier angegeben werden anstelle des Datenreihen-Parameters.	Mehrzeiliger Text	optional
Wert	value	Wenn die Linienfarbe nur von einer Spalte abhängt, kann hier die Spalte mit den Werten angegeben werden.	Mehrzeiliger Text	optional
Filter	filter	Optionally filter data with an template expression parameter e.g. `filter = datum.some_dataset_field > 1900 && datum.some_dataset_field < 2000` where `some_dataset_field` means some valid field of displayed dataset	Mehrzeiliger Text	optional
X-Achse startet mit 0	xAxisZero, xZero	Erzwingt, ob die X-Achse mit dem Nullwert anfängt ("true") oder nicht ("false").	Mehrzeiliger Text	optional
Y-Achse startet mit 0	yAxisZero, yZero	Erzwingt, ob die Y-Achse mit dem Nullwert anfängt ("true") oder nicht ("false").	Mehrzeiliger Text	optional
X axis scale clamp	xAxisClamp	Épingle sur l'échelle de l'axe X. Les courbes au delà de cette épingle seront cachées.	Wahrheitswert	optional
Y axis scale clamp	yAxisClamp	Épingle sur l'échelle de l'axe Y. Les courbes au delà de cette épingle seront cachées.	Wahrheitswert	optional
X-Achse, Minimum	xAxisMin, xMin	Erzwingt das X-Achse mit dem angegeben Wert anfängt.	Zahlenwert	optional
X-Achse, Maximum	xAxisMax, xMax	Erzwingt das X-Achse mit dem angegeben Wert endet.	Zahlenwert	optional
Y-Achse, Minimum	yAxisMin, yMin	Erzwingt das Y-Achse mit dem angegeben Wert anfängt.	Zahlenwert	optional
Y-Achse, Maximum	yAxisMax, yMax	Erzwingt das Y-Achse mit dem angegeben Wert endet.	Zahlenwert	optional
Y axis scale	yScale	Set Y axis scaling type - linear, log and sqrt. Standard linear	Mehrzeiliger Text	optional
Replace zero values	replaceZerosWith	Replaces 0 values in Y data field. Recommended to be use alongside with yScale=log (else zeros will be filtered out).	Zahlenwert	optional
Titel	title	Titel des Diagramms.	Mehrzeiliger Text	optional
Title horizontal alignment	titleXAlign	Horizontal alignment of title, could be one of: left, center, right	Mehrzeiliger Text	optional
Title horizontal offset	titleXOffset	Horizontal offset of title position, could be negative, to shift title to the left, or positive to shift title to the right	Zahlenwert	optional
X-Achse, Titel	xAxisTitle	Titel der X-Achse.	Mehrzeiliger Text	optional
Y-Achse, Titel	yAxisTitle	Titel der Y-Achse.	Mehrzeiliger Text	optional
X axis format	xAxisFormat	Changes the formatting of the X axis labels Standard %b %y (for dates)	Mehrzeiliger Text	optional
Y axis format	yAxisFormat	Changes the formatting of the Y axis labels Standard ,d (for numbers)	Mehrzeiliger Text	optional
X axis labels angle	xAxisAngle	Rotates the x axis labels by the specified angle. Recommended values are: -45, +45, -90, +90.	Zahlenwert	optional
Y axis labels angle	yAxisAngle	Rotates the y axis labels by the specified angle.	Zahlenwert	optional
X axis labels font size	xAxisFontSize	keine Beschreibung	Zahlenwert	optional
Y axis labels font size	yAxisFontSize	keine Beschreibung	Zahlenwert	optional
X-Achse, Raster	xGrid	Zeigt die Hilfslinien für die X-Achse.	Wahrheitswert	optional
Y-Achse, Raster	yGrid	Zeigt die Hilfslinien für die Y-Achse.	Wahrheitswert	optional
X-Achse, Markierungsanzahl	xTicks, xAxisTicks	Wie viele Markierungen sollen an der X-Achse gezeigt werden. '-' ermittelt die Anzahl automatisch. Standard 7	Zahlenwert	optional
Y-Achse, Markierungsanzahl	yTicks, yAxisTicks	Wie viele Markierungen sollen an der Y-Achse gezeigt werden. Standardmäßig auf automatisch '-' gesetzt. Standard -	Zahlenwert	optional
Raw vertical annotation values	vAnnotationsValues	Supply all annotation values as a list of JSON objects: {"text": "Big event", "x": 1980}, ...	Mehrzeiliger Text	optional
Raw horizontal annotation values	hAnnotationsValues	Supply all horizontal annotation values as a list of JSON objects: {"text":"Big event", "y": 980}, ...	Mehrzeiliger Text	optional
Vertical annotation table	vAnnotationsTable	Data page name on Commons, without the Data: prefix. The table must contain "x" column, and optional "text" and "color" columns.	Mehrzeiliger Text	optional
Horizontal annotation table	hAnnotationsTable	Data page name on Commons, without the Data: prefix. The table must contain "y" column, and optional "text" and "color" columns.	Mehrzeiliger Text	optional
Vertical annotation data transforms	vAnnotationsTransforms	keine Beschreibung	Mehrzeiliger Text	optional
Horizontal annotation data transforms	hAnnotationsTransforms	keine Beschreibung	Mehrzeiliger Text	optional
Legende	legend	Titel der Legende.	Mehrzeiliger Text	optional
Breite	width	keine Beschreibung	Zahlenwert	optional
Höhe	height	keine Beschreibung	Zahlenwert	optional
Chart sizing mode	chartSizing	Chart sizing mode, could be one of: fit, pad. Use `fit` to force resulting chart canvas sizes to be exactly equal to provided width and height values. Use `pad` to define prefered plotting size with provided width and height values, and let Vega increase overall chart size to include legend and title (if any) Standard fit	Mehrzeiliger Text	optional
Palette	colors	Die zu verwendende Farbpalette für die Linien. Dies kann eine Liste wie red, green sein.	Mehrzeiliger Text	optional
Palette prédéfinie	colorscheme	Die zu verwendende Farbpalette für die Linien. Standard category10	Mehrzeiliger Text	optional
Line width	linewidth	Line width for line charts or distance between the pie segments for pie charts. Standard 2.5	Zahlenwert	optional
Debug	debug	Debugausgabe: wenn gesetzt wird das erzeugte JSON ausgegeben.	Mehrzeiliger Text	optional

Parameterübersetzungen bearbeiten

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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