Template:Static row numbers/doc
This is a documentation subpage for Template:Static row numbers. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses TemplateStyles: |
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. It works with wikitable, sortable, and plain tables, although the implementation may differ slightly.
Usage
[change source]Include this template above the table and add the static-row-numbers
class to the table start wikitext. Note, other classes such as wikitable
and sortable
are frequently added to data tables, as {| class="class1 class2"
.
Wikitext:
{{Static row numbers}}
{| class="static-row-numbers"
This template uses TemplateStyles:
|
This template (re)enables row hover highlighting via wikitable class modifier mw-datatable.
How to use
[change source]Just add {{row hover highlight}}
(or {{mw-datatable}}
), in any side before table with the class mw-datatable. For example:
{{mw-datatable}} {| class="wikitable mw-datatable" ⫶ |}
For more information: Help:Table#mw-datatable – row highlighting via cursor hover. White background
Table class | Summary |
---|---|
static-row-numbers | Required. Displays a column of row numbers. Requires at least one header row. |
static-row-header-text | Displays "No." text in column label. |
static-row-header-hash | Displays hash ("#") symbol in column label. |
This template uses TemplateStyles:
|
This template (re)enables row hover highlighting via wikitable class modifier mw-datatable.
How to use
[change source]Just add {{row hover highlight}}
(or {{mw-datatable}}
), in any side before table with the class mw-datatable. For example:
{{mw-datatable}} {| class="wikitable mw-datatable" ⫶ |}
For more information: Help:Table#mw-datatable – row highlighting via cursor hover. White background
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, but not needed on sortable tables and not needed on first row of borderless tables (plain tables).
|
static-row-numbers-norank | Disables a row number. Maintains borders between consecutive row usages. Optionally add to data rows. |
Used with wikitable and sortable
[change source]A sortable table does not need the static-row-header
class added to header rows, but it is needed on rows that use the sorttop
or sortbottom
class, described at #Disable number on specific rows.
Wikitext:
{{Static row numbers}}
{| class="wikitable sortable static-row-numbers"
|-
! rowspan="2" | Color
! colspan="3" | Data
|-
! A !! B !! C
|-
| Red || 1 || 2 || 3
|-
| Lime || 4 || 5 || 6
|-
| Gold || 7 || 8 || 9
|}
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Used with wikitable
[change source]A non-sortable table requires at least one row of column headers for the numbers to display properly.
Multiple header rows in a non-sortable table with cell borders (example, uses wikitable
class) should have the static-row-header
class added to all header rows below the first one. Add the class to the first row to remove its border and simulate a rowspan
. More info at #Disable number on specific rows.
Wikitext:
{{Static row numbers}}
{| class="wikitable static-row-numbers"
|-
! rowspan="2" | Color
! colspan="3" | Data
|- class="static-row-header"
! A !! B !! C
|-
...
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Wikitext:
{{Static row numbers}}
{| class="wikitable static-row-numbers"
|- class="static-row-header"
! rowspan="2" | Color
! colspan="3" | Data
|- class="static-row-header"
! A !! B !! C
|-
...
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Used with sortable
[change source]A sortable table does not need the static-row-header
class added to header rows, but it is needed on rows that use the sorttop
or sortbottom
class, described at #Disable number on specific rows.
Wikitext:
{{Static row numbers}}
{| class="sortable static-row-numbers"
|-
! rowspan="2" | Color
! colspan="3" | Data
|-
! A !! B !! C
|-
...
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Used with plain tables
[change source]A non-sortable table requires at least one row of column headers for the numbers to display properly.
Multiple header rows in a non-sortable table without cell borders (example, not using wikitable
class) should have the static-row-header
class added to all header rows except the first one, described at #Disable number on specific rows.
Wikitext:
{{Static row numbers}}
{| class="static-row-numbers"
|-
! rowspan="2" | Color
! colspan="3" | Data
|- class="static-row-header"
! A !! B !! C
|-
...
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Display "No." text in column label
[change source]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:
{{Static row numbers}}
{| class="wikitable sortable static-row-numbers static-row-header-text"
|-
! rowspan="2" | Color
! colspan="3" | Data
|-
! A !! B !! C
|-
...
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Display hash ("#") symbol in column label
[change source]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:
{{Static row numbers}}
{| class="wikitable sortable static-row-numbers static-row-header-hash"
|-
! rowspan="2" | Color
! colspan="3" | Data
|-
! A !! B !! C
|-
...
Produces:
Color | Data | ||
---|---|---|---|
A | B | C | |
Red | 1 | 2 | 3 |
Lime | 4 | 5 | 6 |
Gold | 7 | 8 | 9 |
Disable number on specific rows
[change source]This section details how to disable numbers on specific rows by adding either the static-row-header
or static-row-numbers-norank
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). This class is not needed on header rows when the table uses the sortable
class. It should be added to:
- Rows using the
sorttop
orsortbottom
class. - Header rows on non-sortable tables that have cell borders (example, uses
wikitable
class). - Header rows excluding the first on non-sortable tables that have no cell borders (plain tables; example, not using
wikitable
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:
{{Static row numbers}}
{| class="wikitable sortable static-row-numbers"
|-
! rowspan="2" | Color
! colspan="3" | Data
|-
! A !! B !! C
|- class="sorttop static-row-header"
| '''Min''' || 1 || 2 || 3
|- class="sorttop static-row-header"
| '''Max''' || 10 || 11 || 12
|-
| Red || 1 || 2 || 3
|- class="static-row-numbers-norank"
| Lime || 4 || 5 || 6
|- class="static-row-numbers-norank"
| Gold || 7 || 8 || 9
|-
| Blue || 10 || 11 || 12
|- class="sortbottom static-row-header"
| '''Total''' || 22 || 26 || 30
|- class="sortbottom static-row-header"
| '''Average''' || 5.5 || 6.5 || 7.5
|}
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 |
Redirects
[change source]- {{Srn}}
- {{Fixed row numbers}}
See also
[change source]- {{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
- {{Sorting row}} - Adds a sorting row; not usable with
data-sort-type
attribute. - {{Sticky header}} - Makes column headers stick to the top of the page while scrolling through table data. When a table uses both {{Static row numbers}} and {{Sticky header}} then the use of
sorttop
andsortbottom
classes is more complex. See the examples using this template.