Editing Module:Current RfX/doc (section)

== Usage ==

First, load the module.

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

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 ===

<syntaxhighlight lang="lua">
currentRfx.rfxnames()
</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:

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

=== Rfx ===

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

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:

<syntaxhighlight lang="lua">
{
	rfa = {
		-- Example's rfx object,
		-- Example2's rfx object
	},
	rfb = {
		-- Example3's rfx object
	}
}
</syntaxhighlight><noinclude>
[[Category:Module documentation pages]]
</noinclude>