Template:Row numbers/doc
 | This is a documentation subpage for Template:Row numbers. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
This is a stop-gap template that serves as an interface to Module:Row numbers.
This template makes it possible, in many cases, to have an incrementing row indexer/counter in a table so that adding or removing rows automatically adjusts the numbering of subsequent rows. This template will become obsolete if and when MediaWiki supports automatically adding row numbers via WikiTable syntax. See Phab: T42618 - "jquery.tablesorter: Add support for a 'fixed' column of row numbers." And see Help:Sortable tables, and the sections on row numbering and auto-ranking. Using Template:Row numbers is one of the methods described on that page.
Usage
[edit]TemplateData for Row numbers
{{row numbers|wikitable|index = }}| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| The wikitable | 1 | Either the whole wiki table surrounded by <nowiki>...</nowiki> tags, or the first section, when split by | characters | String | required |
| Starting index | index | Starting index of row count which is useful when table is split by headings. See List of highest-funded crowdfunding projects
| Number | optional |
This template takes an arbitrary number of parameters: the table and the starting index. There is a caveat: the table is wrapped in the template without escaping the | characters. The module is capable of dealing with this, but it is not capable of dealing with bare equals signs in the table syntax at the same time. As such, bare equals signs must be escaped with {{=}}:
{| class{{=}}"wikitable" |- ! scope{{=}}col |...
Internally, the Module maintains a monotonically increasing counter. The Module looks for the keywords _row_count and _row_count_hold in the table. Keyword _row_count is replaced with the next counter value; keyword _row_count_hold is replaced with the value from the last _row_count replacement.
Examples
[edit]| Visual effect | Markup | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
{{Row numbers|
{| class{{=}}"wikitable"
|+ Test incrementor
! Count !! Text
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|123}}
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|27}}
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|5}}
|-
|_row_count_hold || {{Str left|{{Lorem ipsum span}}|11}}
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|123}}
|} }}
| ||||||||||||
|
{{Row numbers|
{| class{{=}}"wikitable"
|+ Test incrementor
! Count !! Text
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|123}}
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|27}}
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|5}}
|-
|_row_count_hold || {{Str left|{{Lorem ipsum span}}|11}}
|-
|_row_count || {{Str left|{{Lorem ipsum span}}|123}}
|} |index =50}}
|
See also
[edit]- {{Static row numbers}} - alternative method to add row numbers. Static, unsortable ones.
- Help:Sortable tables#Maintaining tables sorted alphabetically or by rank
- {{Soft hyphen}} – Can be used to help narrow columns by adding a soft hyphen to a word to allow it to wrap.
TemplateStyles for tables:
- {{Sticky header}} - makes column headers stick to the top 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.