Modul:FileUtil/Doku

Aus Wikivoyage

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

Funktionen für Vorlagen[Bearbeiten]

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)[Bearbeiten]

Eine Testseite illustriert praktische Beispiele.

Funktionen für Lua-Module[Bearbeiten]

Alle oben dokumentierten Funktionen können auch über require() in andere Module eingebunden werden:

local lucky, URLutil = pcall( require, "Modul:FileUtil" )
if type( FileUtil ) == "table" then
    FileUtil = FileUtil.FileUtil()
else
    -- Fehlerfall; FileUtil enthält Fehlermeldung
    return "<span class='error'>" .. FileUtil .. "</span>"
end


Danach stehen zur Verfügung:

  • newFile = FileUtil.addParameter( file, parameter, value )"value" ist optional
  • newFile = FileUtil.replaceParameter( file, parameter, value )"value" ist optional
  • newFile,n = FileUtil.removeParameter( file, parameter)"n" = Anzahl der entfernten Parameter (normalerweise 0 oder 1)

Verwendung[Bearbeiten]

Allgemeine Bibliothek; nicht eingegrenzt.

Abhängigkeiten[Bearbeiten]

Keine.