USA/CommonState/doc: Difference between revisions View history

(description)
m (Adding category to the page)
 
(5 intermediate revisions by 2 users not shown)
Line 3: Line 3:
This template is part of the CommonState template suite. It is currently only set up to work on the United States and its territories.
This template is part of the CommonState template suite. It is currently only set up to work on the United States and its territories.


{{TOC}}
== Usage ==
== Usage ==
The primary template, {{tlm|USA/CommonState}}, is placed on each state page. It includes both code and displayed text that is used to combine the common guidance and the individual state unique guidance.
=== Primary template ===
The primary template, {{tlx|:USA/CommonState}}, is placed on each state page. It includes both code and displayed text that is used to combine the common guidance and the individual state unique guidance.
 
== Supporting templates ==
=== Start ===
 
* {{tlx|:USA/CommonState/Start}} - This template is used on new state pages as the only code on the page:
:{{Pre2|<nowiki>{{subst::USA/CommonState/Start}}</nowiki>}}
 
: Once that page is saved it will automatically display the required template and supporting comments preventing users for editing the wrong content.
 
: Alternately copy and paste this code below into the browser. Change the STATENAME at the end of the line to the name of the state or territory being created. Use the name as spelled in the [[Template:USA_Navbox]]
 
:{{Pre2|<nowiki>https://wiki.waze.com/wiki/index.php?action=submit&summary=Create%20new%20state&preload=USA/CommonState/Start&preview=yes&title=STATENAME</nowiki>}}
 
=== SectionProcess ===
* {{tlx|:USA/CommonState/SectionProcess}} - This (Main namespace) template (not in the Template namespace) is called from the {{tlx|:USA/CommonState}} template. It is the common logic used on the {{tlx|:USA/CommonState}} template to determine if the universal content should come before or be displaced by the unique state content, and if the unique content subpage is not present, it provides a link to generate a unique content page. It has one required parameter with the name of the subpage for the section.
 
=== TalkTableElement ===
* {{tlx|:USA/CommonState/TalkTableElement}} - Helps build the [[Talk:USA/CommonState#Subpage maintenance|subpage edit table]].


== Related templates ==
== Related templates ==
* {{tlm|USA/CommonState/SectionProcess}}
=== EditState ===
:: This (Main namespace) template (not in the Template namespace) is called from the {{tlm|USA/CommonState}} template. It is the common logic used on the {{tlc|{{colon}}USA/CommonState}} template to determine if the universal content should come before or be displaced by the unique state content, and if the unique content subpage is not present, it provides a link to generate a unique content page. It has one required parameter with the name of the subpage for the section.


* {{tlm|USA/CommonState/TalkTableElement}} - Helps build the [[Talk:USA/CommonState#Subpage maintenance|subpage edit table]].
* {{tl|EditState}} - Placed on the talk page of a state or territory to edit the customized content for that state and use the preloads linked on [[Talk:USA/CommonState]]. That is also the best place from which to edit them as well.  


* {{tl|EditState}} - Placed on the talk page of a state or territory to edit the customized content for that state.


<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Templates for or part of the state template]]


<!-- ADD INTERWIKIS BELOW THIS LINE -->
<!-- ADD INTERWIKIS BELOW THIS LINE -->


</includeonly>
</includeonly>

Latest revision as of 11:24, 28 August 2016

This is a documentation subpage for [[::USA/CommonState]].
It contains usage information, categories and other content that is not part of the original article.

This template is part of the CommonState template suite. It is currently only set up to work on the United States and its territories.

Usage

Primary template

The primary template, {{[[::USA/CommonState|:USA/CommonState]]}}, is placed on each state page. It includes both code and displayed text that is used to combine the common guidance and the individual state unique guidance.

Supporting templates

Start

  • {{[[::USA/CommonState/Start|:USA/CommonState/Start]]}} - This template is used on new state pages as the only code on the page:
{{subst::USA/CommonState/Start}}
Once that page is saved it will automatically display the required template and supporting comments preventing users for editing the wrong content.
Alternately copy and paste this code below into the browser. Change the STATENAME at the end of the line to the name of the state or territory being created. Use the name as spelled in the Template:USA_Navbox
https://wiki.waze.com/wiki/index.php?action=submit&summary=Create%20new%20state&preload=USA/CommonState/Start&preview=yes&title=STATENAME

SectionProcess

  • {{[[::USA/CommonState/SectionProcess|:USA/CommonState/SectionProcess]]}} - This (Main namespace) template (not in the Template namespace) is called from the {{[[::USA/CommonState|:USA/CommonState]]}} template. It is the common logic used on the {{[[::USA/CommonState|:USA/CommonState]]}} template to determine if the universal content should come before or be displaced by the unique state content, and if the unique content subpage is not present, it provides a link to generate a unique content page. It has one required parameter with the name of the subpage for the section.

TalkTableElement

  • {{[[::USA/CommonState/TalkTableElement|:USA/CommonState/TalkTableElement]]}} - Helps build the subpage edit table.

Related templates

EditState

  • {{EditState}} - Placed on the talk page of a state or territory to edit the customized content for that state and use the preloads linked on Talk:USA/CommonState. That is also the best place from which to edit them as well.