Wikipedia>DePiep at 19:33, 16 March 2021

2021-03-16T19:33:18Z

New page

{{documentation subpage}}
=== Basic usage===
There are various optional parameters:
:<code><nowiki>{{TOC US states|before=|DC=|PR=|UST=|after=|seealso=|refs=|extlinks=}}</nowiki></code>
:*<code>before=''links to be listed at the beginning''</code>
:*<code>DC=y</code>
:*<code>PR=y</code>
:*<code>UST=y</code>
:*<code>after=''links to be listed at the end''</code>
:*<code>seealso=y</code>
:*<code>refs=y</code>
:*<code>extlinks=y</code>
Using <code>DC</code>, <code>PR</code> and/or <code>UST</code> causes "District of Columbia", "Puerto Rico" and/or "US Territories" to be inserted in the correct alphabetic position within the list of states; {{em|these three non-states are omitted by default}}. These can also be spelled out, e.g. {{para|Puerto Rico|y}}. This feature is compatible with the other handling below (e.g. {{para|DC|Washington, D.C.}} with change the displayed output).

For <code>before</code> and <code>after</code>, a wikified list of one or more section headings is supplied as an argument, and those headings are inserted, either preceding the list of states (in the case of <code>"before"</code>) or following it (in the cast of <code>"after"</code>).

If <code>seealso=y</code>, <code>refs=y</code>, and/or <code>extlinks=y</code> are present, links to a "See also", "References", and/or "External links" sections are included at the end.

The <code>before</code> and <code>after</code> lists contain one or more sequences of wikified section names, combined with '*' unordered list formatting. For example:
<pre>
| after = [[#Footnotes|Footnotes]]
* [[#Further reading|Further reading]]
</pre>
Review [[Special:WhatLinksHere/Template:{{BASEPAGENAME}}|other uses of this template]] for additional examples of how it can be used.

=== Modifying the linking behavior ===
For all of the purposes below, the fully spelled-out codes {{para|District of Columbia}}, {{para|Puerto Rico}} and {{para|US Territoris}} must be used for those three cases, not the short versions <code>DC</code>, <code>PR</code> and <code>UST</code>.

==== Removing a state ====
To remove a particular state from the table of contents, use {{para|State}}, where <code>State</code> is either the name of the state, or the two letter abbreviation for the state. This is most useful in articles covering specific regions of the US, or time periods before certain states had formed. For example,
<pre>
| Kansas = | Alabama =
</pre>
or
<pre>
| KS = | AL =
</pre>
would remove Kansas and Alabama from the table of contents.

==== Unlinking a state ====
In an article where a section about a state is simply missing (e.g. due to lack of data), it is more useful to replace a state's link with unlinked text, than to omit it:
<pre>
| KS = Kansas | AL = Alabama
</pre>
or
<pre>
| Kansas = Kansas | Kansas = Alabama
</pre>

==== Replacing a link ====
To change a state's link, use #-link wikimarkup:
<pre>
| ND = [[#North and South Dakota|North and South Dakota]] | SD =
</pre>
or
<pre>
| North Dakota = [[#North and South Dakota|North and South Dakota]] | South Dakota =
</pre>

This feature can also be used to link to sections in other articles, e.g. when a [[WP:SAL|long list]] has been split into two pages.

<includeonly>{{Sandbox other||
[[Category:Wikipedia table of contents templates topical|US States]]
}}</includeonly>

Template:TOC US states/doc - Revision history

Wikipedia>DePiep at 19:33, 16 March 2021