Quelltext der Seite Modul:IsIn/Doku

{{DU}}
{{high-use}}
{{module rating|r}}
{{Benutzt Wikidata|P31}}

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

{{Modulversion}}

== Funktionen ==

<syntaxhighlight lang="lua">
function isIn.isDisambig( frame )
</syntaxhighlight>

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

Es gibt zwei Parameterformen:

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

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

<syntaxhighlight lang="lua">
function isIn.checkTarget( frame )
</syntaxhighlight>

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

Vorgabeparameter:
* {{Para|page}} Name der zu testenden Seite.
* {{Para|enterTarget}} Dummy-Seitenname, der auf einen fehlenden Eintrag hinweist.

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

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

<syntaxhighlight lang="lua">
function isIn.addCategories( frame )
</syntaxhighlight>

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 <code>Kategorie</code>), gerade das Sortierkriterium.

<syntaxhighlight lang="lua">
function isIn.addPageCategory( frame )
</syntaxhighlight>

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

{{Benötigt Submodule|Failsafe|FastWikidata}}
<includeonly>[[Kategorie:Vorlagen:Organisation]]</includeonly>