Modul:IsIn/Doku

Verwendung

Dieses Modul enthält Funktionen zur Unterstützung der Vorlagen {{IstIn}} und {{IstInKat}}. Die Funktionen des Moduls werden nicht direkt aufgerufen, sondern über die genannten Vorlagen.

Versionsbezeichnung auf Wikidata: 2022-10-22

Funktionen

function isIn.isDisambig( frame )

Die Funktion bestimmt, ob es sich bei der angegebenen Seite um eine Begriffsklärungsseite (Wegweiser) handelt oder nicht. Es gibt zwar das Schlüsselwort __DISAMBIG__, das aber von Vorlagen und Lua-Modulen nicht ausgewertet werden kann. Deshalb wird der Status aus Wikidata bezogen.

Es gibt zwei Parameterformen:

• frame: string. Die zu testende Seite wird direkt als Zeichenkette übergeben.
• frame: table. Der Aufruf erfolgt über invoke in der Form: {{#invoke: IsIn | isDisambig | page = <Titel> }}. Der Artikelname wird über die Parameter page oder 1 übergeben.

Das Ergebnis wird als eine Zeichenkette übergeben. Einzige Werte sind true (ist eine Begriffsklärungsseite) oder false (ist keine Begriffsklärungsseite).

function isIn.checkTarget( frame )

Die Funktion liefert den Typ der zu testenden Seite als Zeichenkette zurück. Der Aufruf erfolgt über invoke in der Form: {{#invoke: IsIn | checkTarget | page = {{{1}}} | enterTarget = Ist-In eintragen }}.

Vorgabeparameter:

• |page= Name der zu testenden Seite.
• |enterTarget= Dummy-Seitenname, der auf einen fehlenden Eintrag hinweist.

Mögliche Rückgabewerte:

• emptyTarget: Es wurde eine leere Zeichenkette übergeben.
• enterTarget: Die übergebene Zeichenkette ist identisch zu enterTarget.
• invalidTitle: Die Zeichenkette enthält unerlaubte Zeichen.
• isDisambig: Bei der zu testenden Seite handelt es sich um eine Begriffsklärungsseite.
• isItself: Die zu testende Seite ist identisch zur aufrufenden Artikelseite.
• isRedirect: Bei der zu testenden Seite handelt es sich um eine Weiterleitungsseite.
• notExisting: Die angegebene Seite existiert nicht.

In allen anderen Fällen wird der Seitenname mit dem Namensraum zurückgegeben.

function isIn.addCategories( frame )

Die Funktion liefert einen Satz von Kategorieaufrufen als Zeichenkette zurück, die der Elternvorlage als nummerierte Parameter übergeben wurden. Ungerade Parameter bezeichnen den Kategoriennamen (ohne Kategorie), gerade das Sortierkriterium.

function isIn.addPageCategory( frame )

Die Funktion liefert einen Kategorieaufruf als Zeichenkette zur aufrufenden Seite zurück, wenn die Kategorie existiert.

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: Wikidata utilities