Module:Rfx/doc - Revision history

Pppery at 13:27, 22 August 2022

2022-08-22T13:27:57Z

← Previous revision		Revision as of 13:27, 22 August 2022
Line 1:		Line 1:
	{{used in system}}
	{{module rating\|general}}		{{module rating\|general}}

Pppery: Add {{used in system}}

2022-02-02T04:50:29Z

Add {{used in system}}

← Previous revision		Revision as of 04:50, 2 February 2022
Line 1:		Line 1:
			{{used in system}}
	{{module rating\|general}}		{{module rating\|general}}

Pppery: Bump rating; being actually used to power the RfA process is clearly widespread use

2021-09-25T00:23:10Z

Bump rating; being actually used to power the RfA process is clearly widespread use

← Previous revision		Revision as of 00:23, 25 September 2021
Line 1:		Line 1:
	{{module rating\|~~alpha~~}}		{{module rating\|general}}

	This is a library for getting information about individual [[WP:RFA\|requests for adminship]] (RfA) and [[WP:RFB\|requests for bureaucratship]] (RfB) pages on the English Wikipedia. It is not meant to be used directly from wiki pages, but rather to be used by other Lua modules.		This is a library for getting information about individual [[WP:RFA\|requests for adminship]] (RfA) and [[WP:RFB\|requests for bureaucratship]] (RfB) pages on the English Wikipedia. It is not meant to be used directly from wiki pages, but rather to be used by other Lua modules.

WOSlinker: change source to syntaxhighlight

2020-07-07T13:29:34Z

change source to syntaxhighlight

← Previous revision		Revision as of 13:29, 7 July 2020
Line 7:		Line 7:
	First of all, the library must be loaded, like this:		First of all, the library must be loaded, like this:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local rfx = require( 'Module:Rfx' )		local rfx = require( 'Module:Rfx' )
			</syntaxhighlight>
	</source>

	Once the library is loaded, you can make a new rfx object using <code>rfx.new()</code>. {{red\|Caution - this function is expensive}} (see [[#Expensive functions\|below]]).		Once the library is loaded, you can make a new rfx object using <code>rfx.new()</code>. {{red\|Caution - this function is expensive}} (see [[#Expensive functions\|below]]).
Line 15:		Line 15:
	<code>rfx.new()</code> is used like this:		<code>rfx.new()</code> is used like this:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local myRfx = rfx.new( pagename )		local myRfx = rfx.new( pagename )
			</syntaxhighlight>
	</source>

	The <code>pagename</code> variable should be the name of a valid RfA or RfB page, for example:		The <code>pagename</code> variable should be the name of a valid RfA or RfB page, for example:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local exampleRfa = rfx.new( 'Wikipedia:Requests for adminship/Example' )		local exampleRfa = rfx.new( 'Wikipedia:Requests for adminship/Example' )
			</syntaxhighlight>
	</source>

	If <code>pagename</code> is not specified, or the page is not a subpage of [[Wikipedia:Requests for adminship]] or [[Wikipedia:Requests for bureaucratship]], then <code>rfx.new</code> will return <code>nil</code>.		If <code>pagename</code> is not specified, or the page is not a subpage of [[Wikipedia:Requests for adminship]] or [[Wikipedia:Requests for bureaucratship]], then <code>rfx.new</code> will return <code>nil</code>.
Line 45:		Line 45:
	Methods must be called with the colon syntax:		Methods must be called with the colon syntax:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local titleObject = exampleRfa:getTitleObject()		local titleObject = exampleRfa:getTitleObject()
			</syntaxhighlight>
	</source>

	* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.		* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.

Mr. Stradivarius: update to reflect changes in Scribunto

2015-06-25T12:00:45Z

update to reflect changes in Scribunto

← Previous revision		Revision as of 12:00, 25 June 2015
Line 63:		Line 63:
	=== Expensive functions ===		=== Expensive functions ===

	This module makes use of the [[:mw:Extension:Scribunto/Lua reference manual#~~mw.title.new~~\|~~mw.~~title~~.new~~]] ~~function~~ to ~~create~~ ~~title~~ ~~objects.~~ ~~<code>rfx~~.~~new</code>~~ ~~calls~~ ~~this~~ ~~function~~ ~~three~~ ~~times - once~~ for ~~[[Wikipedia:Requests for adminship]], once for [[Wikipedia:Requests for bureaucratship]], and once for the~~ RfX page being looked up. ~~Each~~ of ~~these~~ ~~calls~~ ~~counts~~ as an [[:mw:Manual:$wgExpensiveParserFunctionLimit\|expensive function call]]. ~~Any~~ ~~further~~ ~~RfX~~ ~~objects created also count as one expensive function call, so~~ the library may fail for scripts which create many different RfX objects. (The current limit for the English Wikipedia is 500 expensive function calls per page.) ~~However~~, ~~please~~ ~~note~~ that ~~using~~ ~~the~~ ~~<code>getTitleObject()</code> method~~ will ~~''not'' increase the expensive function~~ count, as ~~<code>rfx.new</code>~~ ~~will~~ ~~have~~ ~~already made the title object for that page~~.		This module makes use of the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|title:getContent]] method to fetch RfX page sources. This method will be called for each RfX page being looked up, so each use of <code>rfx.new</code> will count as an [[:mw:Manual:$wgExpensiveParserFunctionLimit\|expensive function call]]. Please be aware that the library may fail for scripts which create many different RfX objects. (The current limit for the English Wikipedia is 500 expensive function calls per page.) Also, each RfX page that is looked up will count as a [[WP:TRANSCLUSION\|transclusion]] in [[Special:WhatLinksHere]].

Mr. Stradivarius: /* Expensive functions */ copy edit

2013-07-17T11:49:31Z

Expensive functions: copy edit

← Previous revision		Revision as of 11:49, 17 July 2013
Line 63:		Line 63:
	=== Expensive functions ===		=== Expensive functions ===

	This module makes use of the [[:mw:Extension:Scribunto/Lua reference manual#mw.title.new\|mw.title.new]] function. <code>rfx.new()</code> calls this function three times - once for [[Wikipedia:Requests for adminship]], once for [[Wikipedia:Requests for bureaucratship]], and once for the RfX page being looked up. Each of these calls counts as an [[:mw:Manual:$wgExpensiveParserFunctionLimit\|expensive function call]]. Any further RfX objects created also count as an expensive function call, so the library may fail for scripts which create many different RfX objects. (The current limit for the English Wikipedia is 500 expensive function calls per page.) However, please note that using the <code>getTitleObject()</code> method will ''not'' increase the expensive function count, as ~~it will have already loaded from~~ <code>rfx.new()</code>.		This module makes use of the [[:mw:Extension:Scribunto/Lua reference manual#mw.title.new\|mw.title.new]] function to create title objects. <code>rfx.new</code> calls this function three times - once for [[Wikipedia:Requests for adminship]], once for [[Wikipedia:Requests for bureaucratship]], and once for the RfX page being looked up. Each of these calls counts as an [[:mw:Manual:$wgExpensiveParserFunctionLimit\|expensive function call]]. Any further RfX objects created also count as one expensive function call, so the library may fail for scripts which create many different RfX objects. (The current limit for the English Wikipedia is 500 expensive function calls per page.) However, please note that using the <code>getTitleObject()</code> method will ''not'' increase the expensive function count, as <code>rfx.new</code> will have already made the title object for that page.

Mr. Stradivarius: add getStatus() and update getSupportUsers()

2013-07-16T14:31:26Z

add getStatus() and update getSupportUsers()

← Previous revision		Revision as of 14:31, 16 July 2013
Line 50:		Line 50:

	* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.		* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.
	* <code>getSupportUsers()</code>: gets an array containing the usernames that supported the RfX. If any usernames could not be processed, the text "Error parsing signature" is used instead, along with the text of the comment in question. N.b. this technique relies on the comment text being unique - if it is not unique then <code>dupesExist()</code> will treat the identical comments as duplicate votes.		* <code>getSupportUsers()</code>: gets an array containing the usernames that supported the RfX. If any usernames could not be processed, the text "Error parsing signature" is used instead, along with the text of the comment in question. N.b. this technique relies on the text of comment text being unique - if it is not unique then <code>dupesExist()</code> will treat the identical comments as duplicate votes. If the page content could not be parsed at all, this method returns <code>nil</code>.
	* <code>getOpposeUsers()</code>: gets an array containing the usernames that opposed the RfX. Functions similarly to <code>getSupportUsers()</code>.		* <code>getOpposeUsers()</code>: gets an array containing the usernames that opposed the RfX. Functions similarly to <code>getSupportUsers()</code>.
	* <code>getNeutralUsers()</code>: gets an array containing the usernames that were neutral at the RfX. Functions similarly to <code>getSupportUsers()</code>.		* <code>getNeutralUsers()</code>: gets an array containing the usernames that were neutral at the RfX. Functions similarly to <code>getSupportUsers()</code>.
Line 57:		Line 57:
	* <code>getTimeLeft()</code>: returns a string showing the time left before the RfX is due to close. The string is in the format "<code>x days, y hours</code>".		* <code>getTimeLeft()</code>: returns a string showing the time left before the RfX is due to close. The string is in the format "<code>x days, y hours</code>".
	* <code>getReport()</code>: returns a [[rev:https://www.mediawiki.org/wiki/Extension:Scribunto/Lua reference manual#URI object#URI object\|URI object]] for X!'s RfA Analysis tool at Wikimedia Labs, preloaded with the RfX page.		* <code>getReport()</code>: returns a [[rev:https://www.mediawiki.org/wiki/Extension:Scribunto/Lua reference manual#URI object#URI object\|URI object]] for X!'s RfA Analysis tool at Wikimedia Labs, preloaded with the RfX page.
			* <code>getStatus()</code>: returns a string showing the current status of the RfX. This can be "successful", "unsuccessful", "open", or "pending closure". Returns <code>nil</code> if the status could not be determined.

	You can compare <code>rfx</code> objects with the <code>==</code> operator. This will return true only if the two objects point to the same page. <code>tostring( rfx )</code> will return <code>prefixedTitle</code> from the RfX page's title object (see the [[:mw:Extension:Scribunto/Lua reference manual#Title objects#Title objects\|reference manual]]).		You can compare <code>rfx</code> objects with the <code>==</code> operator. This will return true only if the two objects point to the same page. <code>tostring( rfx )</code> will return <code>prefixedTitle</code> from the RfX page's title object (see the [[:mw:Extension:Scribunto/Lua reference manual#Title objects#Title objects\|reference manual]]).

Mr. Stradivarius: add getReport()

2013-07-16T13:34:37Z

add getReport()

← Previous revision		Revision as of 13:34, 16 July 2013
Line 56:		Line 56:
	* <code>getSecondsLeft()</code>: returns the number of seconds left before the RfX is due to close. Once it is due to close, shows zero. If the ending time cannot be found, returns <code>nil</code>.		* <code>getSecondsLeft()</code>: returns the number of seconds left before the RfX is due to close. Once it is due to close, shows zero. If the ending time cannot be found, returns <code>nil</code>.
	* <code>getTimeLeft()</code>: returns a string showing the time left before the RfX is due to close. The string is in the format "<code>x days, y hours</code>".		* <code>getTimeLeft()</code>: returns a string showing the time left before the RfX is due to close. The string is in the format "<code>x days, y hours</code>".
			* <code>getReport()</code>: returns a [[rev:https://www.mediawiki.org/wiki/Extension:Scribunto/Lua reference manual#URI object#URI object\|URI object]] for X!'s RfA Analysis tool at Wikimedia Labs, preloaded with the RfX page.

	You can compare <code>rfx</code> objects with the <code>==</code> operator. This will return true only if the two objects point to the same page. <code>tostring( rfx )</code> will return <code>prefixedTitle</code> from the RfX page's title object (see the [[:mw:Extension:Scribunto/Lua reference manual#Title objects#Title objects\|reference manual]]).		You can compare <code>rfx</code> objects with the <code>==</code> operator. This will return true only if the two objects point to the same page. <code>tostring( rfx )</code> will return <code>prefixedTitle</code> from the RfX page's title object (see the [[:mw:Extension:Scribunto/Lua reference manual#Title objects#Title objects\|reference manual]]).

Mr. Stradivarius: update getSupportUsers() description

2013-07-16T11:46:15Z

update getSupportUsers() description

← Previous revision		Revision as of 11:46, 16 July 2013
Line 50:		Line 50:

	* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.		* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.
	* <code>getSupportUsers()</code>: gets an array containing the usernames that supported the RfX. If any usernames could not be processed, the text "Error ~~processing~~ ~~vote no. n~~" is ~~inserted~~ instead, ~~a long~~ with a ~~random~~ ~~number~~ to ~~prevent~~ the ~~error~~ text being ~~confused~~ as a duplicate ~~vote~~.		* <code>getSupportUsers()</code>: gets an array containing the usernames that supported the RfX. If any usernames could not be processed, the text "Error parsing signature" is used instead, along with the text of the comment in question. N.b. this technique relies on the comment text being unique - if it is not unique then <code>dupesExist()</code> will treat the identical comments as duplicate votes.
	* <code>getOpposeUsers()</code>: gets an array containing the usernames that opposed the RfX. Functions similarly to <code>getSupportUsers()</code>.		* <code>getOpposeUsers()</code>: gets an array containing the usernames that opposed the RfX. Functions similarly to <code>getSupportUsers()</code>.
	* <code>getNeutralUsers()</code>: gets an array containing the usernames that were neutral at the RfX. Functions similarly to <code>getSupportUsers()</code>.		* <code>getNeutralUsers()</code>: gets an array containing the usernames that were neutral at the RfX. Functions similarly to <code>getSupportUsers()</code>.

Mr. Stradivarius: update

2013-07-16T11:00:37Z

update

← Previous revision		Revision as of 11:00, 16 July 2013
Line 11:		Line 11:
	</source>		</source>

	Once the library is loaded, you can make a new rfx object ~~like~~ this:		Once the library is loaded, you can make a new rfx object using <code>rfx.new()</code>. {{red\|Caution - this function is expensive}} (see [[#Expensive functions\|below]]).

			<code>rfx.new()</code> is used like this:

	<source lang="lua">		<source lang="lua">
Line 32:		Line 34:

	* <code>type</code>: the type of the rfx. This is either "<code>rfa</code>" or "<code>rfb</code>".		* <code>type</code>: the type of the rfx. This is either "<code>rfa</code>" or "<code>rfb</code>".
⚫	* <code>~~page~~</code>: the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual~~#Title objects~~#Title objects\|reference manual]] for details on how to use title objects.
	* <code>supports</code>: the number of supports in the RfX. <code>nil</code> if the supports could not be processed.		* <code>supports</code>: the number of supports in the RfX. <code>nil</code> if the supports could not be processed.
	* <code>opposes</code>: the number of opposes in the RfX. <code>nil</code> if the opposes could not be processed.		* <code>opposes</code>: the number of opposes in the RfX. <code>nil</code> if the opposes could not be processed.
Line 45:		Line 46:

	<source lang="lua">		<source lang="lua">
	local ~~supportUsers~~ = exampleRfa:~~getSupportUsers~~()		local titleObject = exampleRfa:getTitleObject()
	</source>		</source>

		⚫	* <code>getTitleObject()</code>: gets the title object for the RfX page. See the [[:mw:Extension:Scribunto/Lua reference manual#Title objects\|reference manual]] for details on how to use title objects.
	* <code>getSupportUsers()</code>: gets an array containing the usernames that supported the RfX. If any usernames could not be processed, the text "Error processing vote no. n" is inserted instead, a long with a random number to prevent the error text being confused as a duplicate vote.		* <code>getSupportUsers()</code>: gets an array containing the usernames that supported the RfX. If any usernames could not be processed, the text "Error processing vote no. n" is inserted instead, a long with a random number to prevent the error text being confused as a duplicate vote.
	* <code>getOpposeUsers()</code>: gets an array containing the usernames that opposed the RfX. Functions similarly to <code>getSupportUsers()</code>.		* <code>getOpposeUsers()</code>: gets an array containing the usernames that opposed the RfX. Functions similarly to <code>getSupportUsers()</code>.
Line 56:		Line 58:

	You can compare <code>rfx</code> objects with the <code>==</code> operator. This will return true only if the two objects point to the same page. <code>tostring( rfx )</code> will return <code>prefixedTitle</code> from the RfX page's title object (see the [[:mw:Extension:Scribunto/Lua reference manual#Title objects#Title objects\|reference manual]]).		You can compare <code>rfx</code> objects with the <code>==</code> operator. This will return true only if the two objects point to the same page. <code>tostring( rfx )</code> will return <code>prefixedTitle</code> from the RfX page's title object (see the [[:mw:Extension:Scribunto/Lua reference manual#Title objects#Title objects\|reference manual]]).

			=== Expensive functions ===

			This module makes use of the [[:mw:Extension:Scribunto/Lua reference manual#mw.title.new\|mw.title.new]] function. <code>rfx.new()</code> calls this function three times - once for [[Wikipedia:Requests for adminship]], once for [[Wikipedia:Requests for bureaucratship]], and once for the RfX page being looked up. Each of these calls counts as an [[:mw:Manual:$wgExpensiveParserFunctionLimit\|expensive function call]]. Any further RfX objects created also count as an expensive function call, so the library may fail for scripts which create many different RfX objects. (The current limit for the English Wikipedia is 500 expensive function calls per page.) However, please note that using the <code>getTitleObject()</code> method will ''not'' increase the expensive function count, as it will have already loaded from <code>rfx.new()</code>.