Wikipedia:Lua/Modul/FileUtil/de
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
[Quelltext bearbeiten]- addParameter – fügt einer vorhandenen Medieneinbindung einen neuen Parameter hinzu.
- Parameter:
1
oderfile
– Die Medieneinbindung (z.B."[[Datei:Name.ext]]"
)2
oderparameter
– Neuer Parametername (z.B."link"
)3
odervalue
(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
- Eine neue Medieneinbindung mit hinzugefügtem Parameter (und Wert) (z.B.
- replaceParameter – fügt einer vorhandenen Medieneinbindung einen neuen Parameter hinzu bzw. ersetzt den Wert eines vorhandenen Parameters
- Parameter:
1
oderfile
– Die Medieneinbindung (z.B."[[Datei:Name.ext|parameter=alter Wert]]"
)2
oderparameter
– Neuer oder vorhandener Parametername (z.B."parameter"
)3
odervalue
(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
- Eine neue Medieneinbindung mit hinzugefügtem Parameter bzw. ersetztem Wert, (z.B.
- removeParameter – entfernt einen Parameter aus einer vorhandenen Medieneinbindung
- Parameter:
1
oderfile
– Die Medieneinbindung (z.B."[[Datei:Name.ext|link=test]]"
)2
oderparameter
– 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
- Eine neue Medieneinbindung mit entferntem Parameter (z.B.
Beispiele (Testseite)
[Quelltext bearbeiten]Eine Testseite illustriert praktische Beispiele.
Funktionen für Lua-Module
[Quelltext 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 optionalnewFile = FileUtil.replaceParameter( file, parameter, value )
– "value" ist optionalnewFile,n = FileUtil.removeParameter( file, parameter)
– "n" = Anzahl der entfernten Parameter (normalerweise 0 oder 1)
Verwendung
[Quelltext bearbeiten]Allgemeine Bibliothek; nicht eingegrenzt.
Abhängigkeiten
[Quelltext bearbeiten]Keine.