Difference between revisions of "Template:RC/doc"

From Wazeopedia
(Related templates: typo)
(Created initial doc)
Line 2: Line 2:
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
 
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
  
This template is a suite of subpage templates used for the [[Regional Coordinator]] table.
+
This template is a suite of subpage templates (listed below) used for the [[Regional Coordinator]] table.
 
 
== Subpages ==
 
The following subpages are currently defined:
 
 
 
* {{tl|RC/Editor}} - Regional Coordinator table entry template
 
* {{tl|RC/USA}} - Link to USA Wiki page and forum
 
* {{tl|RC/Region}} - Link to Region Wiki page and forum
 
* {{tl|RC/CommonRegion}} - Default content for regional pages if not already created
 
  
 
== Usage ==
 
== Usage ==
Use the templates as required.
+
The primary template used in this suite is {{tl|RC/TableRow}} to automatically generate the content of the regional coordinator table. Place this template repeatedly for each region as shown.
  
 
{{Pre2|<nowiki>
 
{{Pre2|<nowiki>
{{RC/Editor|HighRankEd|USA|Southeast}}
+
{{RC/TableRow|(3)|Southeast}}
 
</nowiki>
 
</nowiki>
 
}}
 
}}
 +
 +
== Parameters ==
 +
There are two required parameters:
 +
 +
: '''Parameter 1''' is a text field added to the left inside the region name column, typically to indicate a region number for user cross reference, but it has no purpose inside the template.
 +
 +
: '''Parameter 2''' is the name of the region. It must match a region already defined in {{tl|RC/Data}}.
  
 
== Related templates ==
 
== Related templates ==
 
This template suite also uses the following templates:
 
This template suite also uses the following templates:
  
* {{tl|StateForum}} to link to the appropriate forums.
+
* {{tl|RC/USA}} - Link to USA Wiki page and forum
 +
* {{tl|RC/Region}} - Link to Region Wiki page and forum
 +
* {{tl|RC/CommonRegion}} - Default content for regional pages if not already created
 +
* {{tl|RC/Forum}} - Generates HTML link based on Region name and requested data
 +
* {{tl|RC/Data}} - The database holding all the regional coordinator related data
 +
* {{tl|RC/Data/Core}} - The translation of text for parameters to the {{tlc|RC/Data}} content
 +
 
 
* {{tl|Username|NAME_OF_USER}} to create user page and PM links.
 
* {{tl|Username|NAME_OF_USER}} to create user page and PM links.
 +
 
* {{tl|PM|NAME_OF_USER}} to create PM links.
 
* {{tl|PM|NAME_OF_USER}} to create PM links.
 +
 +
  
 
<!--
 
<!--

Revision as of 23:08, 8 July 2014

This is a documentation subpage for Template:RC.
It contains usage information, categories and other content that is not part of the original template page.

This template is a suite of subpage templates (listed below) used for the Regional Coordinator table.

Usage

The primary template used in this suite is {{RC/TableRow}} to automatically generate the content of the regional coordinator table. Place this template repeatedly for each region as shown.

{{RC/TableRow|(3)|Southeast}}

Parameters

There are two required parameters:

Parameter 1 is a text field added to the left inside the region name column, typically to indicate a region number for user cross reference, but it has no purpose inside the template.
Parameter 2 is the name of the region. It must match a region already defined in {{RC/Data}}.

Related templates

This template suite also uses the following templates:

  • {{RC/USA}} - Link to USA Wiki page and forum
  • {{RC/Region}} - Link to Region Wiki page and forum
  • {{RC/CommonRegion}} - Default content for regional pages if not already created
  • {{RC/Forum}} - Generates HTML link based on Region name and requested data
  • {{RC/Data}} - The database holding all the regional coordinator related data
  • {{RC/Data/Core}} - The translation of text for parameters to the {{RC/Data}} content
  • {{Username}} to create user page and PM links.
  • {{PM}} to create PM links.