Module:AutosortTable/doc

Usage

This module helps create data tables in an automatically sorted order. As of this writing it is used primarily for the generation of the huge, dynamic tables at list of Wikipedias and Wikipedia:List of Wikipedias. For the Wikipedia editions table, the module is invoked directly to create the framework for the table, followed by content for the rows within the module's invocation. For the Edition details table, the module is invoked directly to create the framework for the table while the template {{Wikipedia stats}} generates content for the individual rows, also within the module's invocation. The template {{Wikipedia stats}} is intended to be called as an argument within the module's invocation, as it does not produce the regular wikitable (or any standard table) code itself.

The module's arguments are:

{{#invoke:AutosortTable|create|class=|style=|separator=|order=|numeric=|descending=|hidden=|caption=|rowheader=
|header = 
|footer = 
|colstyle = 
}}

Module arguments

Argument	Example	Notes
function	create	The argument create is the only function of this module, and is required.
class	class=wikitable	Class for the entire table. Table can be made user-sortable by including the class "sortable", but does not need to be.
style	style=width: 50%;	CSS for the entire table
separator	separator=--	Separator string used to separate cells in the data definition. The pipe (|) is an invalid separator for this module.
order	order=3, 2	Order for auto-sorting preference, takes a comma-separated list of column numbers. In the example here, the table will be sorted by column 3 first, then by column 2.
numeric	numeric=2	Columns which use numeric sorting when auto-sorted. Takes comma-separated list of column numbers.
descending	descending=3	Columns for which the auto-sort order should be descending (otherwise, ascending is used). Takes comma-separated list of column numbers. Here, only the third column will be auto-sorted in descending order (e.g., Zebra, Walrus, Muskrat, Emu, etc., or 12, 9, 6, 4).
hidden	hidden=2	Columns which are not to be displayed (even though they may be used for row-sorting purposes). Takes comma-separated list of column numbers. Here, the second column will not be shown.
caption	caption=Notable people by age	Caption to be used for the table, per MOS:ACCESS
rowheader	rowheader=1	Cell(s) in each non-header row to be emitted as row header, per MOS:ACCESS. Usually 1, and only 1, but accepts comma-separated list of column numbers. Causes !scope="row" to be used in the HTML for the cells specified.
header	header = -- Name -- Age	These are the column headings. In this example there are two columns with headings, the first is "Name", the second, "Age". Note the separators (--) which match the separator value above.
footer	footer =-- Country -- Population -- Density	Table footer, typically a duplication of header (see header argument above). Here, the first three columns have the footer labels shown.
colstyle	colstyle = -- text-align:left; -- text-align:right; -- -- --	Adds the specified CSS styling to entire columns. Here, the first column will be left-aligned, the second column will be right-aligned, and the next three columns (with no CSS specified) will use the default styling. Note the separators (--) which match the separator value above.

Styling tricks

While there appear to be no ways to style an individual cell when using this module, styling particular rows, columns, or the entire table can be done using CSS.

Styling the table

The style argument allows the entire table to use a default styling. For example, |style=width:70%; text-align:center; would constrain the table width to 70% of the available window, and center the text (not including column and row headers) by default. When using multiple properties, the semicolon is necessary to separate them. Do not use the quotation marks ordinarily required in CSS or wikitable markup (as in "|style=width:70%; text-align:center;"), as it causes the CSS to be disregarded. A reminder: use CSS to constrain tables sparingly, as reduced font-size or unexpected table widths may cause accessibility problems or irritate readers.

Styling a row

An individual row can be styled separately by including CSS prior to the first data cell. Consider this example table:

{{#invoke:AutosortTable|create|class=wikitable plainrowheaders sortable|separator=--|order=2|numeric=2|descending=2|caption=Old friends|rowheader=1
|header = -- Name -- Age -- Diet                    <!-- Table header -->
| -- Maria -- 36 -- Vegan                           <!-- Row 1 -->
| -- Peter -- 35 -- Vegetarian                      <!-- Row 2 -->
| -- Julia -- 35 -- Meat                            <!-- Row 3 -->
| -- James -- 50 -- Vegan                           <!-- Row 4 -->
| background-color: #FFDDDD -- Henry -- 45 -- Meat  <!-- Row 5, with CSS -->
| -- Ireni -- 47 -- Fish, no meat                   <!-- Row 6 -->
|colstyle = -- text-align:left; -- text-align:right; --  --  --
}}

Old friends

Name	Age	Diet
James	50	Vegan
Ireni	47	Fish, no meat
Henry	45	Meat
Maria	36	Vegan
Peter	35	Vegetarian
Julia	35	Meat

The row for "Henry" gets a pink color (#FFDDDD), while the row header appropriately retains the gray formatting wikitables use for headers.

Styling a column

An individual column can be styled separately by using CSS in the colstyle argument. In the Old friends example just above, the alignment has been set to text-align:left; and text-align:right;, respectively. Consider this similar table:

{{#invoke:AutosortTable|create|class=wikitable plainrowheaders sortable|separator=--|order=2|numeric=2|descending=2|caption=Old friends again|rowheader=1
|header = -- Name -- Age -- Diet    <!-- Table header -->
| -- Maria -- 36 -- Vegan           <!-- Row 1 -->
| -- Peter -- 35 -- Vegetarian      <!-- Row 2 -->
| -- Julia -- 35 -- Meat            <!-- Row 3 -->
| -- James -- 50 -- Vegan           <!-- Row 4 -->
| -- Henry -- 45 -- Meat            <!-- Row 5 -->
| -- Ireni -- 47 -- Fish, no meat   <!-- Row 6 -->
|colstyle = --  -- font-weight:bold; color:brown -- background-color:yellow
}}

Old friends again

Name	Age	Diet
James	50	Vegan
Ireni	47	Fish, no meat
Henry	45	Meat
Maria	36	Vegan
Peter	35	Vegetarian
Julia	35	Meat

The "Age" column entries are now in bolded brown and no longer left-aligned as in the previous example. The "Diet" column here has the specified yellow background.

Sample tables

"Wikipedia editions" example

Here is an abbreviated version of the Wikipedia editions table at list of Wikipedias. It is a manually sortable wikitable which uses the class "plainrowheaders" (no bold, not centered) for row headers (specified here as only column 1). It is auto-sorted by the sixth column ("Active users"), which is a numeric field and should be auto-sorted in descending order (highest at the top). The content of each row in the table is entered as a separate argument (starting with a pipe [|] symbol) and includes text, wikilinks, and image file links. Please view the wikicode to see the details.

Wikipedia editions

Wikipedia name in English	Wikipedia name in native language	Language	Script (ISO 15924 code)	WP code	Active users	Launch date	Logo
English Wikipedia	English Wikipedia	English	Latn	en	122,190	15 January 2001
French Wikipedia	Wikipédia en français	French	Latn	fr	17,608	23 March 2001
German Wikipedia	Deutschsprachige Wikipedia	German	Latn	de	17,272	16 March 2001

"Edition details" example

Here is an abbreviated version of the Edition details table at Wikipedia:List of Wikipedias. This table uses templates (using this module) to produce the individual rows for the table which this module will generate.

Like the above example, this is a manually sortable wikitable which uses the class "plainrowheaders" (no bold, not centered) for row headers (specified here as only column 1). However, this table is auto-sorted by the thirteenth column (based on the number of articles) which is hidden (although the same values are used again — and shown — in column 4 as "Articles"), and which is a numeric field and should be used for auto-sorting in descending order (highest at the top). The content of each row in the table is generated by the template {{Wikipedia stats}} and the call to that template is entered as a separate argument (starting with a pipe [|] symbol).

This table has some special alignment requirements, as it contains several columns containing large numbers, so the colstyle argument is used extensively. Please view the wikicode to see the details.

Details of Wikipedia editions

Language	Language (local)	Wiki	Articles	All pages	Edits	Admins	Users	Active users	Files	Depth	Percentage
English	English	en	6,913,667	61,878,307	1,253,915,255	851	48,294,719	122,190	930,129	1280.79	10.81%
French	français	fr	2,648,398	13,282,695	219,992,609	145	5,053,351	17,608	72,545	267.04	4.14%
Dutch	Nederlands	nl	2,172,202	4,665,658	68,244,643	30	1,374,457	3,490	20	19.27	3.4%
Russian	русский	ru	2,010,785	8,089,862	141,331,080	66	3,663,408	9,288	256,328	159.68	3.14%
Spanish	español	es	1,990,728	8,297,712	163,223,415	57	7,281,590	14,081	0	197.44	3.11%
Chinese	中文	zh	1,451,564	7,870,615	84,733,252	65	3,620,286	7,166	68,265	210.53	2.27%
Japanese	日本語	ja	1,437,721	4,222,774	102,443,316	40	2,257,984	12,545	4,731	91.03	2.25%
Arabic	العربية	ar	1,246,101	8,563,774	68,507,766	25	2,653,388	4,415	53,479	275.88	1.95%
Portuguese	português	pt	1,138,398	5,797,235	68,846,101	51	3,152,196	8,885	64,023	198.9	1.78%
Korean	한국어	ko	690,474	3,316,762	38,119,986	28	868,005	2,231	14,642	166.28	1.08%