Modul:Common/Doku: Unterschied zwischen den Versionen

Aktuelle Version vom 11. Oktober 2025, 13:53 Uhr

Das Commons-Modul ist ein reines Import-Modul, welches immer wieder kehrende Funktionen beinhaltet, die über das Ganze Projekt hinweg immer wieder gebraucht werden.

`istJahrestag()`

Überprüft den Namen des beinhaltenden Artikels auf:

mit 1 oder 2 Ziffern beginnt (%d%d?)
gefolgt ist von einem Punkt (%.)
optionalem Leerzeichen (%s*),
und einem Monatsnamen (%a+ = Buchstaben).

Wenn das zutreffend ist, wird das erste Argument zurückgegeben. Wenn nicht, wird das zweite Argument zurückgegeben. Sind keine Argumente gegeben, wird true oder "" zurückgegeben.

`istJahreszahl()`

Überprüft den Namen des beinhaltenden Artikels auf:

Ist der Artikelname eine Ganzzahl, positiv oder negativ? (^%-?%d+$)
Oder ist der Artikelname eine positive Ganzzahl, gefolgt von "v. Chr." oder "n. Chr." (^%d+%s+[vn]%.%s+Chr%.$)

Wenn das zutreffend ist, wird das erste Argument zurückgegeben. Wenn nicht, wird das zweite Argument zurückgegeben. Sind keine Argumente gegeben, wird "" oder true zurückgegeben.

`shallowcopy()`

Erzeugt eine echte Kopie einer Tabelle.

`TemplateTranscludeWithArgs()`

Diese Funktion erlaubt es einer Vorlage, eine beliebige andere Vorlage aufzurufen und dabei alle Parameter (frame) implizit zu vererben. Zusätzlich können dabei weitere Parameter (dem frame) hinzugefügt werden.

Beispiele

Anmerkung: Die Vorlage:TemplateTranscludeWithArgsTest1 Vorlage:TemplateTranscludeWithArgsTest2 dienen nur der Anzeige, mit welchen Parametern es aufgerufen wurde (verwendet print_template_args() von Modul:Development).

{{#invoke:{{#replace:{{PAGENAME}}|/Doku|}}|TemplateTranscludeWithArgs|TemplateTranscludeWithArgsTest1|22|33|44=44|Test=55}} ergibt folgende Vorlagen-Einbettung: <nowiki>{{Vorlage:TemplateTranscludeWithArgsTest1|1=22|2=33|Test=55|43=44}}</nowiki>
Der Aufruf von {{#invoke:{{#replace:{{PAGENAME}}|/Doku|}}|TemplateTranscludeWithArgs|TemplateTranscludeWithArgsTest1|22|33|44=44|Test=55}} mit zuvor gesetzten |a=aaa|B=BbB ergibt folgende Vorlagen-Einbettung: <nowiki>{{Vorlage:TemplateTranscludeWithArgsTest1|43=44|2=33|B=BbB|1=22|Test=55|a=aaa}}</nowiki>

`isTrue()`

Testet String auf True-Werte verschiedenster Schreibweisen.

`returnStringCheck()`

Setzt Attribut:LuaReturnLength und gibt Kategorie:Lua-String-Länge problematisch zurück, wenn String-Länge potenziell problematische Größe erreicht. Kann direkt vor ein return einer obersten Lua-Funktion eingefügt werden, die String an ein #invoke: rückgibt.

Unterseiten

Common/Doku

@@ Zeile 1: / Zeile 1: @@
 Das Commons-Modul ist ein reines Import-Modul, welches immer wieder kehrende Funktionen beinhaltet, die über das Ganze Projekt hinweg immer wieder gebraucht werden.
-=== istJahrestag ===
+=== <code>istJahrestag()</code> ===
 Überprüft den Namen des beinhaltenden Artikels auf:
 * mit 1 oder 2 Ziffern beginnt (<code>%d%d?</code>)
@@ Zeile 8: / Zeile 8: @@
 * und einem Monatsnamen (<code>%a+</code> = Buchstaben).
-Wenn das zutreffend ist, wird das erste Argument zurückgegeben. Wenn nicht, wird das zweite Argument zurückgegeben. Sind keine Argumente gegeben, wird <code>true</code> oder <code>false</code> zurückgegeben.
+Wenn das zutreffend ist, wird das erste Argument zurückgegeben. Wenn nicht, wird das zweite Argument zurückgegeben. Sind keine Argumente gegeben, wird <code>true</code> oder <code>""</code> zurückgegeben.
-=== istJahreszahl ===
+=== <code>istJahreszahl()</code> ===
 Überprüft den Namen des beinhaltenden Artikels auf:
 * Ist der Artikelname eine Ganzzahl, positiv oder negativ? (<code>^%-?%d+$</code>)
 * Oder ist der Artikelname eine positive Ganzzahl, gefolgt von "v. Chr." oder "n. Chr." (<code>^%d+%s+[vn]%.%s+Chr%.$</code>)
-Wenn das zutreffend ist, wird das erste Argument zurückgegeben. Wenn nicht, wird das zweite Argument zurückgegeben. Sind keine Argumente gegeben, wird <code>true</code> oder <code>false</code> zurückgegeben.
+Wenn das zutreffend ist, wird das erste Argument zurückgegeben. Wenn nicht, wird das zweite Argument zurückgegeben. Sind keine Argumente gegeben, wird <code>""</code> oder <code>true</code> zurückgegeben.
+=== <code>shallowcopy()</code> ===
+Erzeugt eine ''echte'' Kopie einer Tabelle.
+=== <code>TemplateTranscludeWithArgs()</code> ===
+Diese Funktion erlaubt es einer Vorlage, eine beliebige andere Vorlage aufzurufen und dabei alle Parameter (frame) implizit zu vererben.
+Zusätzlich können dabei weitere Parameter (dem frame) hinzugefügt werden.
+==== Beispiele ====
+Anmerkung: Die [[Vorlage:TemplateTranscludeWithArgsTest1]] [[Vorlage:TemplateTranscludeWithArgsTest2]] dienen nur der Anzeige, mit welchen Parametern es aufgerufen wurde (verwendet <code>print_template_args()</code> von [[Modul:Development]]).
+* <code><nowiki>{{#invoke:{{#replace:{{PAGENAME}}|/Doku|}}|TemplateTranscludeWithArgs|TemplateTranscludeWithArgsTest1|22|33|44=44|Test=55}}</nowiki></code> ergibt folgende Vorlagen-Einbettung: <code>{{#invoke:{{#replace:{{PAGENAME}}|/Doku|}}|TemplateTranscludeWithArgs|TemplateTranscludeWithArgsTest1|22|33|44=44|Test=55}}</code>
+* Der Aufruf von <code><nowiki>{{#invoke:{{#replace:{{PAGENAME}}|/Doku|}}|TemplateTranscludeWithArgs|TemplateTranscludeWithArgsTest1|22|33|44=44|Test=55}}</nowiki></code> mit zuvor gesetzten <code>|a=aaa|B=BbB</code> ergibt folgende Vorlagen-Einbettung: <code>{{#invoke:{{#replace:{{PAGENAME}}|/Doku|}}|TemplateTranscludeWithArgs|TemplateTranscludeWithArgsTest2|a=aaa|B=BbB}}</code>
+=== <code>isTrue()</code> ===
+Testet String auf True-Werte verschiedenster Schreibweisen.
+=== <code>returnStringCheck()</code> ===
+Setzt [[Attribut:LuaReturnLength]] und gibt [[:Kategorie:Lua-String-Länge problematisch]] zurück, wenn String-Länge potenziell problematische Größe erreicht.
+Kann direkt vor ein return einer obersten Lua-Funktion eingefügt werden, die String an ein #invoke: rückgibt.
+== Unterseiten ==
+{{Unterseitenliste|Modul:Common}}