Template:Static row numbers

File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

This template adds a column of row numbers to a table. The numbers do not sort with the rest of the table, remaining static. Optional classes are provided to display a column label or disable numbers on specific rows.

It works on desktop and mobile versions of Wikipedia pages.

Usage

Include this template by adding {{static row numbers}} or its redirect {{static-row-numbers}} above a table. Add the static-row-numbers class to the table start wikitext. Optionally add the other classes listed below.

Wikitext: <syntaxhighlight lang=wikitext>

</syntaxhighlight>

Classes for table start wikitext: {| class="class1 class2".

Table class	Summary
static-row-numbers	Required. Displays a column of row numbers aligned right. Requires at least one header row.
static-row-numbers-center	Center aligns numbers. Default right.
static-row-numbers-left	Left aligns numbers. Default right.
static-row-header-text	Displays "No." text in column label.
static-row-header-hash	Displays hash ("#") symbol in column label.

Other attributes for table start wikitext: {| attribute="value".

Table attribute	Summary
data-srn-limit="N"	Remove numbers beyond row N of the sortable data where N is the number 10. Requires sortable table. Unpredictable results when adding sorttop (uses static-row-header) rows above or static-row-numbers-norank rows in the sortable data. Example: {| class="static-row-numbers" data-srn-limit="10".

Classes for row wikitext: |- class="class1 class2".

Row class	Summary
static-row-header	Disables a row number. Disables borders between consecutive row usages (simulates rowspan). Add to sorttop and sortbottom rows. Add to header rows except the first.
static-row-numbers-norank	Disables a row number. Maintains borders between consecutive row usages. Optionally add to data rows.

Used with sortable

Multiple header rows in a sortable table should have the static-row-header class added to all header rows except the first one so that they are not numbered when JavaScript is disabled. It is also needed on rows that use the sorttop or sortbottom class, described at #Disable number on specific rows.

Wikitext: <syntaxhighlight lang="wikitext" highlight=1-2,6,14,16>

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9
Total	12	15	18
Average	4	5	6

</syntaxhighlight>

Produces:

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9
Total	12	15	18
Average	4	5	6

Used without sortable

Multiple header rows in a non-sortable table should have the static-row-header class added to all header rows except the first one, described at #Disable number on specific rows.

Wikitext: <syntaxhighlight lang="wikitext" highlight=1-2,6>

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9

</syntaxhighlight>

Produces:

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9

Display "No." text in column label

• Note. This does not improve accessibility. A blind person said it does nothing for screen reader users. [1].

To display the "No." text in the number column's header (label), add the static-row-header-text class to the table start wikitext.

Wikitext: <syntaxhighlight lang="wikitext" highlight=1-2,6>

... </syntaxhighlight>

Produces:

Color	Data
	A	B	C

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9

Display hash ("#") symbol in column label

• Note. This does not improve accessibility. A blind person said it does nothing for screen reader users. [2].

To display a hash ("#") symbol in the number column's header (label), add the static-row-header-hash class to the table start wikitext.

Wikitext: <syntaxhighlight lang="wikitext" highlight=1-2,6>

... </syntaxhighlight>

Produces:

Color	Data
	A	B	C

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9

Disable number on specific rows

This section details how to disable numbers on specific rows by adding either the static-row-numbers-norank or static-row-header class to the row wikitext.

The static-row-numbers-norank class can be added to data rows to disable the number.

The static-row-header class disables the number and border between other rows that use this class consecutively, simulating a rowspan (see Help:Table#Colspan and rowspan). It should be added to:

• Header rows excluding the first. For sortable tables, it prevents numbering when JavaScript is disabled.
• Rows using the sorttop or sortbottom class.

Note, the sorttop or sortbottom class is added to a row so it stays at the top or bottom of a sorted list, per Help:Sortable tables.

Wikitext: <syntaxhighlight lang="wikitext" highlight=1-2,6,8,10,14,16,20,22>

Color	Data
	A	B	C
Min	1	2	3
Max	10	11	12
Red	1	2	3
Lime	4	5	6
Gold	7	8	9
Blue	10	11	12
Total	22	26	30
Average	5.5	6.5	7.5

</syntaxhighlight>

Produces:

Color	Data
	A	B	C
Min	1	2	3
Max	10	11	12
Red	1	2	3
Lime	4	5	6
Gold	7	8	9
Blue	10	11	12
Total	22	26	30
Average	5.5	6.5	7.5

Limit numbers

Tracked in Phabricator
Task T6740

This section details how to remove numbers beyond a certain limit by adding the data-srn-limit="N" attribute and value to the table wikitext, where N is a number limited to certain values according to the "Usage" section above. 10 is one allowed value used in this section.

Due to limitations in CSS (styles), there are some restrictions to make it work properly. The table needs to use the sortable class so column headers are moved out of the sortable area (<tbody> element) to exclude them from the count. Avoid adding sorttop (uses static-row-header) rows above the sortable data since they aren't excluded from the count before sorting. Avoid adding static-row-numbers-norank rows in the sortable data since they aren't excluded from the count when ordered within the numbered limit.

Wikitext: <syntaxhighlight lang="wikitext" highlight=1-2,6,32,34>

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9
Blue	10	11	12
Orange	2	9	5
Yellow	3	7	4
Green	5	6	2
Purple	6	4	1
Pink	8	3	7
Black	9	2	8
White	11	1	10
Gray	12	12	11
Total	78	70	78
Average	6.5	5.8	6.5

</syntaxhighlight>

Produces:

Color	Data
	A	B	C
Red	1	2	3
Lime	4	5	6
Gold	7	8	9
Blue	10	11	12
Orange	2	9	5
Yellow	3	7	4
Green	5	6	2
Purple	6	4	1
Pink	8	3	7
Black	9	2	8
White	11	1	10
Gray	12	12	11
Total	78	70	78
Average	6.5	5.8	6.5

Redirects

• {{Srn}}
• {{Fixed row numbers}}

See also

• {{Row numbers}} - Alternative method to add row numbers that are sortable and adjust when rows are deleted/inserted.
• Help:Sortable tables#Maintaining tables sorted alphabetically or by rank
• {{shy}} – Can be used to help narrow columns by adding a soft hyphen to a word to allow it to wrap.

More template styles for tables:

• {{sticky header}} - makes column headers stick to the top of the page while scrolling through table data.
• {{sticky table start}} - makes row and/or column headers stick to the top and/or left of the page while scrolling through table data.
• {{sort under}} - moves the sorting arrows under the headers.
• {{row hover highlight}} - adds row hover highlighting, and option for white background.
• {{table alignment}} - aligns the cells in a column, or a whole table.

The above documentation is transcluded from Template:Static row numbers/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.