Wikipedia:Lua/Modul/Pinging

Vorlagenprogrammierung	Diskussionen	Lua			Test	Unterseiten
		Modul	Deutsch	English		Modul:	Dokumentation

Pinging – Modul mit Funktionen für alle Arten von Benutzerauflistungen, insbesondere „pings“ für Echo.

Funktionen für Vorlagen

Alle Funktionen erwarten die Parameterliste aus der umschließenden Vorlageneinbindung. #invoke hat keine Parameter, wenn nicht ausdrücklich erwähnt. Alles ist optional, wenn nicht ausdrücklich erwähnt.

Leerzeichen usw. vor und nach allen Werten werden ignoriert.

Gemeinsame Optionsparameter

Alle Funktionen zur Benutzerauflistung (ping, noping, massmessage) unterstützen gemeinsame optionale Parameter. Sie können sowohl beim #invoke als Standardvorgabe einer bestimmten Vorlage gesetzt werden wie auch bei einer einzelnen Einbindung; Letzteres hat Vorrang.

:: Nachfolgendes Zeichen/Zeichenkette.; Vorgabe: :; Leere Zuweisung lässt es wegfallen.; Ein _ am Anfang oder Ende wird in ein gewöhnliches Leerzeichen umgewandelt.
p: Wie : (Kompatibilität).
@: Vorangehendes Zeichen/Zeichenkette.; Vorgabe: @; Leere Zuweisung lässt es wegfallen.; Ein _ am Anfang oder Ende wird in ein gewöhnliches Leerzeichen umgewandelt.
/: Trennzeichen oder -zeichenkette.; Vorgabe: ähnlich  |_; Ein _ am Anfang oder Ende wird in ein gewöhnliches Leerzeichen umgewandelt.; 
 wird in Zeilenumbrüche umgewandelt.

ping

Generiert eine Liste von Verlinkungen auf Benutzerseiten (Wikilinks), die eine Echo-Benachrichtigung auslösen, wenn sie in einem geeignet signierten Abschnitt eingebunden werden.

1: Benutzername (ohne Benutzer: am Anfang).
2 3 4 5 6 7 8 9 ...: Beliebige Zahl von Benutzernamen.; Leere Werte möglich; werden ignoriert.
labeln: Weise unterschiedlichen Linktitel dem Benutzernamen n zu.; Kompatibilität für die englischsprachige Wikipedia; nicht zu empfehlen.
max: 0 – Zeige keinen Fehlerhinweis, wenn maxecho überschritten.; Eine andere Begrenzung als vom System vorgegeben kann gewählt werden; sinnvollerweise dann kleiner.; Kann die Ping-Liste in eine Linkliste zu anderen Zwecken wandeln.; Kann sowohl in der Vorlageneinbindung wie auch im #invoke zugewiesen werden. Zuweisung in der Vorlage hat Vorrang.; Vorgabe: Fehler anzeigen, wenn 50 überschritten.

noping

Wie ping, nur alle Verlinkungen als URL und max demzufolge bedeutungslos.

massmessage

Generiert eine Liste von Verlinkungen auf Benutzerseiten (Wikilinks) aus einer Versandliste für Massennachrichten.

Diese Funktion ist „teuer“. Die Nutzung teurer Funktionen pro Seite ist auf 500 begrenzt.

1

Quellseite (Versandliste), eine von

Lokaler Seitenname
Führendes # gefolgt von Seitenkennnummer curid (pageid) überlebt Seitenverschiebungen.

Nur für #invoke verfügbar.

Pflichtparameter

2

Listentitel; wird mit der Quellseite verlinkt.

Darf keine Links enthalten.

Listenmitglieder werden gezeigt, wenn weggelassen.

Wenn als _ angegeben, erfolgt keinerlei optische Darstellung.

Nur für #invoke verfügbar.

@

Parameter kann genutzt werden, um sowohl einen Listentitel wie auch die Mitgliederliste zu zeigen.

max

0 – Zeige keinen Fehlerhinweis, wenn maxecho überschritten.

Eine andere Begrenzung als vom System vorgegeben kann gewählt werden; sinnvollerweise dann kleiner.

Kann die Ping-Liste in eine Linkliste zu anderen Zwecken wandeln.

Kann sowohl in der Vorlageneinbindung wie auch im #invoke zugewiesen werden. Zuweisung in der Vorlage hat Vorrang.

Vorgabe: Fehler anzeigen, wenn 50 überschritten.

subst

Erfordert, dass #invoke direkt ein subst: vorangestellt wird, wenn auf irgendeine Weise gesetzt.

Nur für #invoke verfügbar.

Es wird der Name der obersten einzubindenden und zu substituierenden Vorlage erwartet und in der Fehlermeldung angezeigt.

Auf definierenden Seiten (Versandlisten) muss der Aufruf der Parserfunktion {{#target: in Kleinbuchstaben ohne Leerzeichen geschrieben werden.

Die Parserfunktionen müssen in der Quellseite selbst vorhanden sein und dürfen nicht indirekt durch Vorlageneinbindung generiert werden.

{{#target:Benutzer:PerfektesChaos}}
{{#target:Project:Noticeboard|en.wiki.x.io}}

maxecho

Anzeige der Maximalzahl bei einer einzelnen Bearbeitung anpingbarer Benutzer: 50

failsafe

Versionsidentifzierung auf diesem Wiki: 2022-11-14

Beispiele (Testseite)

Eine Testseite illustriert praktische Beispiele.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Pinging | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; deren Regeln gelten analog.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Zu allgemeinen Problemen beachte die Abhilfen wie bei Vorlagen.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer die Vorlage:Dokumentation/Lua in der Dokumentationsseite eingebunden werden.

Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
Die Vorlage wird zur Übersicht kategorisiert in Kategorie:Vorlage:mit Lua-Programmierung.

Zu weiteren Informationen siehe Hilfe:Lua.

Bei Problemen wende dich bitte an die Vorlagen-Werkstatt, in schweren Fällen hilft auch die Lua-Werkstatt.