Wikipedia:Lua/Modul/Pinging/en - Versionsgeschichte

PerfektesChaos: + Mediawiki:Echo-notification-count

2015-11-01T17:31:47Z

← Nächstältere Version		Version vom 1. November 2015, 19:31 Uhr
Zeile 116:		Zeile 116:

	== Dependencies ==		== Dependencies ==
			* [[Mediawiki:Echo-notification-count]] – Message if number of echo recipients exceeded
	None.

	[[Kategorie:Wikipedia:Lua/Modul/Dokumentation\|Pinging/en]]		[[Kategorie:Wikipedia:Lua/Modul/Dokumentation\|Pinging/en]]

PerfektesChaos: +

2015-10-31T19:32:00Z

← Nächstältere Version		Version vom 31. Oktober 2015, 21:32 Uhr
Zeile 7:		Zeile 7:
	Whitespace ahead and after any content is ignored.		Whitespace ahead and after any content is ignored.

	: Common ~~option~~ parameters ~~for all user list functions:~~		=== Common optional parameters ===
			All functions listing users ([[#ping\|ping]], [[#noping\|noping]], [[#massmessage\|massmessage]]) support common optional parameters. They may be provided both with <code>#invoke</code> as default for a certain template as well as for a particular transclusion – the latter takes precedence.
	:; :		; :
	:: ~~postfix~~ character/string		: Postfix character/string.
	:: ''~~default~~:'' <code>:</code>		: ''Default:'' <code>:</code>
	:: ~~empty~~ assignment makes it disappear		: Empty assignment makes it disappear.
⚫	:; p
	:: ~~like~~ <code>:</code> ~~(legacy)~~		: Terminating or leading <code>_</code> will be displayed as simple space.
	:; @		; p
			: Like <code>:</code> (legacy).
⚫	:: ~~prefix~~ character/string
		⚫	; @
⚫	:: ''~~default~~:'' <code>@</code>
		⚫	: Prefix character/string.
⚫	:: ~~empty~~ assignment makes it disappear
		⚫	: ''Default:'' <code>@</code>
⚫	:; /
		⚫	: Empty assignment makes it disappear.
⚫	:: ~~separator~~ character/string
		⚫	: Terminating or leading <code>_</code> will be displayed as simple space.
	:: ''default:'' <code>&nbsp;\|_</code>
		⚫	; /
	:: May be set both in template and <code>#invoke</code>. Assignment in template takes precedence.
		⚫	: Separator character/string.
⚫	:: Terminating or leading <code>_</code> will be displayed as space ~~which might be escaped by HTML entity~~.
	:: <code>&~~#10~~;</code> ~~will be turned into line breaks.~~		: ''Default:'' like <code>&nbsp;\|_</code>
			: Terminating or leading <code>_</code> will be displayed as simple space.
			: <code>&#10;</code> will be turned into line breaks.

	=== ping ===		=== ping ===
Zeile 35:		Zeile 37:
	: Legacy for enwiki.		: Legacy for enwiki.
	; max		; max
	: <code>0</code> – Do not show error message if [[#maxecho\|maxecho]] exceeded.		: <code>0</code> – Do not show error message if ''[[#maxecho\|maxecho]]'' exceeded.
	: Chose another limit than by system.		: Chose another limit than by system.
	: May turn user name list into linklist for other purposes.		: May turn user name list into linklist for other purposes.
	: Available for both <code>#invoke</code> and template transclusion; the latter takes precedence.		: Available for both <code>#invoke</code> and template transclusion; the latter takes precedence.
	: ''~~default~~:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded.		: ''Default:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded.

	=== noping ===		=== noping ===
Zeile 51:		Zeile 53:
	: Source page, one of		: Source page, one of
	:* local page name		:* local page name
	:* heading <code>#</code>, followed by curid (pageid) surviving page moves		:* heading <code>#</code>, followed by curid (pageid) surviving page moves.
			: Available for <code>#invoke</code> only.
	: ''mandatory''
			: ''Mandatory''.
	; 2		; 2
	: List title		: List title, will be linked to source page.
	: Must not contain links		: Must not contain links.
	: Members will be shown if omitted		: Members will be shown if omitted.
			: If <code>_</code> provided nothing visual will be displayed.
			: Available for <code>#invoke</code> only.
	; @		; @
	: Parameter may be used to show both list title and members		: Parameter may be used to show both list title and members.
	; max		; max
	: <code>0</code> – Do not show error message if [[#maxecho\|maxecho]] exceeded		: <code>0</code> – Do not show error message if ''[[#maxecho\|maxecho]]'' exceeded.
	: Chose another limit than by system.		: Chose another limit than by system.
	: May turn user name list into linklist for other purposes.		: May turn user name list into linklist for other purposes.
	: Available for both <code>#invoke</code> and template transclusion; the latter takes precedence.		: Available for both <code>#invoke</code> and template transclusion; the latter takes precedence.
	: ''~~default~~:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded.		: ''Default:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded.
	; subst		; subst
	: Requires that <code>#invoke</code> is directly preceeded by <code>subst:</code> if set in any mode.		: Requires that <code>#invoke</code> is directly preceeded by <code>subst:</code> if set in any mode.
Zeile 87:		Zeile 92:

	== {{Anker\|Lua}} Functions for Lua modules (API) ==		== {{Anker\|Lua}} Functions for Lua modules (API) ==
			Some functions may be used by other modules:

			<syntaxhighlight lang="lua">
	Currently none.
			local lucky, Pinging = pcall( require, "Module:Pinging" )
			if type( Pinging ) == "table" then
			mw.log( Pinging.maxecho() )
			else
			-- error; Pinging contains error message
			return "<span class=\"error\">" .. Pinging .. "</span>"
			end
			</syntaxhighlight>
			If succeeded there are available:
			; [[#failsafe\|failsafe]]()
			: Returns ''string'' with ID.
			; [[#massmessage\|massmessage]]( args, args2 )
			: args – ''table'' with parameters for <code>#invoke</code> as listed above
			: args2 – optional ''table'' with parameters like for a transclusion
			: Returns ''string''.
			; [[#maxecho\|maxecho]]()
			: Returns ''string'' with digits.

	== Usage ==		== Usage ==

PerfektesChaos: +

2015-10-30T13:43:51Z

← Nächstältere Version		Version vom 30. Oktober 2015, 15:43 Uhr
Zeile 38:		Zeile 38:
	: Chose another limit than by system.		: Chose another limit than by system.
	: May turn user name list into linklist for other purposes.		: May turn user name list into linklist for other purposes.
			: Available for both <code>#invoke</code> and template transclusion; the latter takes precedence.
	: ''default:'' Show error if {{#invoke:Pinging\|maxecho}} exceeded.		: ''default:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded.

	=== noping ===		=== noping ===
	Like [[#ping\|ping]], but all links as URL. No mentioning by echo.		Like [[#ping\|ping]], but all links as URL. No mentioning by echo, therefore ''max'' out of scope.

	=== massmessage ===		=== massmessage ===
Zeile 53:		Zeile 54:
	: ''mandatory''		: ''mandatory''
	; 2		; 2
	: ~~list~~ title		: List title
	: ~~must~~ not contain links		: Must not contain links
	: ~~members~~ will be shown if omitted		: Members will be shown if omitted
	; @		; @
	: ~~parameter~~ may be used to show both list title and members		: Parameter may be used to show both list title and members
	; max		; max
	: <code>0</code> – Do not show error message if [[#maxecho\|maxecho]] exceeded		: <code>0</code> – Do not show error message if [[#maxecho\|maxecho]] exceeded
	: Chose another limit than by system.		: Chose another limit than by system.
	: May turn user name list into linklist for other purposes.		: May turn user name list into linklist for other purposes.
			: Available for both <code>#invoke</code> and template transclusion; the latter takes precedence.
	: ''default:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded		: ''default:'' Show error if ''{{#invoke:Pinging\|maxecho}}'' exceeded.
	; subst		; subst
	: Requires that <code>#invoke</code> is directly preceeded by <code>subst:</code> if set in any mode.		: Requires that <code>#invoke</code> is directly preceeded by <code>subst:</code> if set in any mode.

PerfektesChaos: Setup

2015-10-30T11:44:12Z

Setup

Neue Seite

{{LuaModuleDoc}}
<onlyinclude>'''<code>Pinging</code>''' – Module with functions for any kind of user lists, especially for echo pings.

== {{Anker|template}} Functions for templates ==
All functions expect the parameter list from the template transclusion which will embed them. <code>#invoke</code> has no parameters, if not explicitly mentioned. Anything is optional if not explicitly mentioned.

Whitespace ahead and after any content is ignored.

: Common option parameters for all user list functions:
:; :
:: postfix character/string
:: ''default:'' <code>:</code>
:: empty assignment makes it disappear
:; p
:: like <code>:</code> (legacy)
:; @
:: prefix character/string
:: ''default:'' <code>@</code>
:: empty assignment makes it disappear
:; /
:: separator character/string
:: ''default:'' <code>&nbsp;|_</code>
:: May be set both in template and <code>#invoke</code>. Assignment in template takes precedence.
:: Terminating or leading <code>_</code> will be displayed as space which might be escaped by HTML entity.
:: <code>&#10;</code> will be turned into line breaks.

=== ping ===
Create a list of user page links from a list of nicks, which should trigger echo mention if occurring in a signed section.
; 1
: User nick (no leading <code>user:</code>).
; 2 3 4 5 6 7 8 9 ...
: Any number of user nicks.
; label''n''
: Assign different displayed link title to nick ''n''.
: Legacy for enwiki.
; max
: <code>0</code> – Do not show error message if [[#maxecho|maxecho]] exceeded.
: Chose another limit than by system.
: May turn user name list into linklist for other purposes.
: ''default:'' Show error if {{#invoke:Pinging|maxecho}} exceeded.

=== noping ===
Like [[#ping|ping]], but all links as URL. No mentioning by echo.

=== massmessage ===
Retrieve a list of recipients from a list of massmessage targets.
This function is „expensive“. The usage of expensive functions per page is limited to 500.

; 1
: Source page, one of
:* local page name
:* heading <code>#</code>, followed by curid (pageid) surviving page moves
: ''mandatory''
; 2
: list title
: must not contain links
: members will be shown if omitted
; @
: parameter may be used to show both list title and members
; max
: <code>0</code> – Do not show error message if [[#maxecho|maxecho]] exceeded
: Chose another limit than by system.
: May turn user name list into linklist for other purposes.
: ''default:'' Show error if ''{{#invoke:Pinging|maxecho}}'' exceeded
; subst
: Requires that <code>#invoke</code> is directly preceeded by <code>subst:</code> if set in any mode.
: Available for <code>#invoke</code> only.
: Supposed to be the name of the top including page (template title) which will be shown in error message.
On defining pages, the parser function call <code>{{#target:</code> is supposed to be downcased, with no spaces within.

The parser functions need to be present within the page source itself, not indirectly via templates.
<syntaxhighlight lang="text" style="margin-left:2em">
{{#target:Benutzer:PerfektesChaos}}
{{#target:Project:Noticeboard|en.wikipedia.org}}
</syntaxhighlight>

=== maxecho ===
Just tell the current limitation for pinged users by a single edit: <code>{{#invoke:Pinging|maxecho}}</code>

=== failsafe ===
Version identification on this wiki: <code>{{#invoke:Pinging|failsafe}}</code>

=== Examples (test page) ===
A [[Wikipedia:Lua/Modul/Pinging/Test|test page]] illustrates practical use.</onlyinclude>

== {{Anker|Lua}} Functions for Lua modules (API) ==

Currently none.

== Usage ==
General library; no limitations.

== Dependencies ==
None.

[[Kategorie:Wikipedia:Lua/Modul/Dokumentation|Pinging/en]]