View source for Template:Row numbers/doc

{{Documentation subpage}}
{{lua|Module:Row numbers}}
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: {{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 ==
{{Format TemplateData|JSON=
{
	"params": {
		"1": {
			"label": "The wikitable",
			"description": "Either the whole wiki table surrounded by &lt;nowiki>...&lt;/nowiki> tags, or the first section, when split by {{!}} characters",
			"type": "string",
			"required": true,
			"suggested": true	
		},
		"index": {
			"label": "Starting index",
			"description": "Starting index of row count which is useful when table is split by headings.<br><small>See [https://en.wikipedia.org/w/index.php?title=List_of_highest-funded_crowdfunding_projects&oldid=1018568495 List of highest-funded crowdfunding projects]</small>",
			"example": "50",
			"type": "number", 
			"required": false,
			"suggested": false,
            "default":"1"
		}
	},
	"description": "<noexport><code>&#123;&#123;row numbers&#124;''wikitable''&#124;''index = '' &#125;&#125;</code><br></noexport>",
	"format": "inline"
} }} 

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 <code>|</code> 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 {{tl|{{=}}}}:
:<syntaxhighlight lang="wikitext">{| class{{=}}"wikitable"
|-
! scope{{=}}col |...
</syntaxhighlight>
Internally, the Module maintains a monotonically increasing counter. The Module looks for the keywords <code>_row_count</code> and <code>_row_count_hold</code> in the table. Keyword <code>_row_count</code> is replaced with the next counter value; keyword <code>_row_count_hold</code> is replaced with the value from the last <code>_row_count</code> replacement.

==Examples==
{| class="wikitable"
|+ Examples
|-
! 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}}
|}
}}
| <syntaxhighlight lang="wikitext">{{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}}
|}}}</syntaxhighlight>
|-
| {{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}}
| <syntaxhighlight lang="wikitext">{{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}}</syntaxhighlight>
|}

== See also ==
* {{t|Static row numbers}} - alternative method to add row numbers. Static, unsortable ones.
* [[Help:Sortable tables#Maintaining tables sorted alphabetically or by rank]]
* {{t|Soft hyphen}} – Can be used to help narrow columns by adding a [[soft hyphen]] to a word to allow it to wrap.
[[WP:TemplateStyles|TemplateStyles]] for tables:
* {{t|Sticky header}} - makes column headers stick to the top of the page while scrolling through table data. 
* {{t|Sort under}} - moves the sorting arrows under the headers.
* {{t|Row hover highlight}} - adds row hover highlighting, and option for white background. 

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Table templates]]
}}</includeonly>