Wikipedia:Lua/Modul/FileUtil

Vorlagenprogrammierung	Diskussionen	Lua			Test	Unterseiten
		Modul	Deutsch	English		Modul:	Dokumentation

FileUtil – Modul mit Funktionen, die das Arbeiten mit Mediendatein (z.B. Bilder, Videos, etc.) erleichtern sollen.

Funktionen für Vorlagen

addParameter – fügt einer vorhandenen Medieneinbindung einen neuen Parameter hinzu.

Parameter:

• 1 oder file – Die Medieneinbindung (z.B. "[[Datei:Name.ext]]")
• 2 oder parameter – Neuer Parametername (z.B. "link")
• 3 oder value (optional) – Neuer Wert (z.B. "Hauptseite")

Rückgabewert:

• Eine neue Medieneinbindung mit hinzugefügtem Parameter (und Wert) (z.B. [[Datei:Name.ext|link=Hauptseite]])
• Die alte Medieneinbindung wenn der neue Parameter bereits vorhanden ist
• nichts – wenn Medieneinbindung unzulässig

replaceParameter – fügt einer vorhandenen Medieneinbindung einen neuen Parameter hinzu bzw. ersetzt den Wert eines vorhandenen Parameters

Parameter:

• 1 oder file – Die Medieneinbindung (z.B. "[[Datei:Name.ext|parameter=alter Wert]]")
• 2 oder parameter – Neuer oder vorhandener Parametername (z.B. "parameter")
• 3 oder value (optional) – Neuer Wert (z.B. "neuer Wert")

Rückgabewert:

• Eine neue Medieneinbindung mit hinzugefügtem Parameter bzw. ersetztem Wert, (z.B. [[Datei:Name.ext|parameter=neuer Wert]])
• nichts – wenn Medieneinbindung unzulässig

removeParameter – entfernt einen Parameter aus einer vorhandenen Medieneinbindung

Parameter:

• 1 oder file – Die Medieneinbindung (z.B. "[[Datei:Name.ext|link=test]]")
• 2 oder parameter – Name des Parameters der entfernt werden soll (z.B. "link")

Rückgabewert:

• Eine neue Medieneinbindung mit entferntem Parameter (z.B. [[Datei:Name.ext]])
• nichts – wenn Medieneinbindung unzulässig

Beispiele (Testseite)

Eine Testseite illustriert praktische Beispiele.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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