Module:Current RfX/doc - Revision history

John of Reading: /* RfxNames */ Typo fixing, replaced: reqeuests → requests

2025-02-24T11:48:59Z

RfxNames: Typo fixing, replaced: reqeuests → requests

← Previous revision		Revision as of 11:48, 24 February 2025
Line 19:		Line 19:
	</syntaxhighlight>		</syntaxhighlight>

	This returns an array containing the page names of all current requests for adminship and bureaucratship. They are sorted by the order they appear on [[Wikipedia:Requests for adminship]], and ~~reqeuests~~ for adminship (RfAs) and requests for bureaucratship (RfBs) are treated identically. For the example users, the table returned would be as follows:		This returns an array containing the page names of all current requests for adminship and bureaucratship. They are sorted by the order they appear on [[Wikipedia:Requests for adminship]], and requests for adminship (RfAs) and requests for bureaucratship (RfBs) are treated identically. For the example users, the table returned would be as follows:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:01:22Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:01, 29 August 2024
Line 47:		Line 47:
	}		}
	}		}
	</syntaxhighlight>		</syntaxhighlight><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

WOSlinker: change source to syntaxhighlight

2020-07-07T16:27:24Z

change source to syntaxhighlight

← Previous revision		Revision as of 16:27, 7 July 2020
Line 5:		Line 5:
	First, load the module.		First, load the module.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local currentRfx = require('Module:Current RfX')		local currentRfx = require('Module:Current RfX')
			</syntaxhighlight>
	</source>

	Then, choose the function that you wish to use. The functions are outlined in the subsections below.		Then, choose the function that you wish to use. The functions are outlined in the subsections below.
Line 15:		Line 15:
	=== RfxNames ===		=== RfxNames ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	currentRfx.rfxnames()		currentRfx.rfxnames()
			</syntaxhighlight>
	</source>

	This returns an array containing the page names of all current requests for adminship and bureaucratship. They are sorted by the order they appear on [[Wikipedia:Requests for adminship]], and reqeuests for adminship (RfAs) and requests for bureaucratship (RfBs) are treated identically. For the example users, the table returned would be as follows:		This returns an array containing the page names of all current requests for adminship and bureaucratship. They are sorted by the order they appear on [[Wikipedia:Requests for adminship]], and reqeuests for adminship (RfAs) and requests for bureaucratship (RfBs) are treated identically. For the example users, the table returned would be as follows:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	{		{
	'Wikipedia:Requests for adminship/Example',		'Wikipedia:Requests for adminship/Example',
Line 27:		Line 27:
	'Wikipedia:Requests for bureaucratship/Example3'		'Wikipedia:Requests for bureaucratship/Example3'
	}		}
			</syntaxhighlight>
	</source>

	=== Rfx ===		=== Rfx ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	currentRfx.rfx()		currentRfx.rfx()
			</syntaxhighlight>
	</source>

	This returns a table containing two arrays, <code>''rfa''</code> and <code>''rfb''</code>; <code>''rfa''</code> contains rfx objects for currently open RfAs, and <code>''rfb''</code> contains rfx objects for currently open RfBs. In the case that there are multiple RfAs or multiple RfBs they will appear in the same order as they do on [[Wikipedia:Requests for adminship]]. For a description of rfx objects and what they can do, please see [[Module:Rfx]]. For the example users, the table returned would be as follows:		This returns a table containing two arrays, <code>''rfa''</code> and <code>''rfb''</code>; <code>''rfa''</code> contains rfx objects for currently open RfAs, and <code>''rfb''</code> contains rfx objects for currently open RfBs. In the case that there are multiple RfAs or multiple RfBs they will appear in the same order as they do on [[Wikipedia:Requests for adminship]]. For a description of rfx objects and what they can do, please see [[Module:Rfx]]. For the example users, the table returned would be as follows:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	{		{
	rfa = {		rfa = {
Line 47:		Line 47:
	}		}
	}		}
			</syntaxhighlight>
	</source>

Mr. Stradivarius: create

2014-01-30T07:18:16Z

create

New page

This module returns information about currently open [[WP:RFA|requests for adminship]] and [[WP:RFB|requests for bureaucratship]] (RfX). It has two functions, <code>rfxNames</code>, which returns a table containing the page names of currently open RfX, and <code>rfx</code>, which returns a table of rfx objects created using [[Module:Rfx]].

== Usage ==

First, load the module.

<source lang="lua">
local currentRfx = require('Module:Current RfX')
</source>

Then, choose the function that you wish to use. The functions are outlined in the subsections below.

For the purpose of explanation, in the examples below we will assume that there are currently two users running for adminship, ''Example'' and ''Example2''. We will also assume that there is currently one user running for bureaucratship, ''Example3''.

=== RfxNames ===

<source lang="lua">
currentRfx.rfxnames()
</source>

This returns an array containing the page names of all current requests for adminship and bureaucratship. They are sorted by the order they appear on [[Wikipedia:Requests for adminship]], and reqeuests for adminship (RfAs) and requests for bureaucratship (RfBs) are treated identically. For the example users, the table returned would be as follows:

<source lang="lua">
{
'Wikipedia:Requests for adminship/Example',
'Wikipedia:Requests for adminship/Example2',
'Wikipedia:Requests for bureaucratship/Example3'
}
</source>

=== Rfx ===

<source lang="lua">
currentRfx.rfx()
</source>

This returns a table containing two arrays, <code>''rfa''</code> and <code>''rfb''</code>; <code>''rfa''</code> contains rfx objects for currently open RfAs, and <code>''rfb''</code> contains rfx objects for currently open RfBs. In the case that there are multiple RfAs or multiple RfBs they will appear in the same order as they do on [[Wikipedia:Requests for adminship]]. For a description of rfx objects and what they can do, please see [[Module:Rfx]]. For the example users, the table returned would be as follows:

<source lang="lua">
{
rfa = {
-- Example's rfx object,
-- Example2's rfx object
},
rfb = {
-- Example3's rfx object
}
}
</source>