Template:FC/County/doc View history

Template documentation pages
VisualWikitext
(clarified instructions, incorporated new guidance on using date parameter)
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 14: Line 14:
For example
For example


{{Tl|FC/County|COUNTY NAME|STATUS}}
{{Tlx|FC/County|COUNTY NAME|STATUS}}


→Produces
→Produces
Line 66: Line 66:




This template is optimally deployed in sortable wiki table. This code should be place on the page where you want the table to be displayed, above where the template will be entered.
This template is optimally deployed in sortable wiki table. The top of table is formatted here with special wiki markup. There are two template options you can use here for this table. This code should be placed on the page where you want the table to be displayed, above where the individual row templates will be entered.
 
Option A) {{tl|FC/Top}} which will produce a sortable table, with a caption, and all four columns County, Editor(s), Status, Updated.
 
Option B) {{tl|FC/Topnd}} which will produce a sortable table, with a caption, and only three columns County, Editor(s), Status. The date column is not created in this table, use this option if you choose not to use the optional <code>date=</code> parameter.
 
Option C) Alternatively you can build your own table header using a variation on the following code.


<code>{| class="wikitable sortable" border="1"
<code>{| class="wikitable sortable" border="1"
|+ FC Upgrade Status by County (sortable)
|+ FC Upgrade Status by County (sortable)
|-
|-
! scope="col" | County
! | County
! scope="col" | Editor(s)
! | Editor(s)
! scope="col" | Status
! | Status
! scope="col" | Updated</code>
! | Updated</code>




Line 81: Line 87:
The data can be input here using one of two methods.
The data can be input here using one of two methods.


A) It can be isolated to a subpage, which can then be transcluded here. This method has the advantage of making it less daunting for a novice wiki editor to modify, as the only thing they'll see are the rooted of the table and any optional instruction notes you include. For example if the templates are isolated an stored on subpage [[/FC_table]], you would put this code here to copy the data from that subpage into the table.
Option A) It can be isolated to a subpage, which can then be transcluded here. This method has the advantage of making it less daunting for a novice wiki editor to modify, as the only thing they'll see are the rooted of the table and any optional instruction notes you include. For example if the templates are isolated an stored on subpage [[/FC_table]], you would put this code here to copy the data from that subpage into the table.


<code><nowiki>{{/FC table}}</nowiki></code>
<code><nowiki>{{/FC table}}</nowiki></code>




B) Simply place the templates here, like this for example.
Option B) Simply place the templates here, like this for example.




Line 95: Line 101:




And below where the templates will be added, you need this code to complete the table.
And below where the templates will be added, on the line below the individual row data, you need this code to complete the table. This can be done manually, or also with a template.


<code>|}</code>
Option A) Put the following template {{tl|FC/Bottom}}


Option B) Put the following code <code>|}</code>


→This produces
 
→This produces when used all together


{| class="wikitable sortable" border="1"
{| class="wikitable sortable" border="1"
Line 116: Line 124:


Notice that the row for Richmond is missing the updated cell, this is because the "date" parameter wasn't included in that rows template. This is not recommended, either all rows ina table should use this parameter, or none should use it.
Notice that the row for Richmond is missing the updated cell, this is because the "date" parameter wasn't included in that rows template. This is not recommended, either all rows ina table should use this parameter, or none should use it.
{{FC}}
<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->

Latest revision as of 08:16, 12 July 2015

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

This template is designed to be used to add rows to a table tracking FC upgrades by county.


It requires only two parameters at minimum, the county name, and it's upgrade status.

The template is designed to be transcluded enclosed inside a table. 

{| border=1
Template goes here
|}


For example

{{FC/County|COUNTY NAME|STATUS}}

→Produces

|- align="center" bgcolor="white" |COUNTY NAME |No volunteers yet |STATUS



But when enclosed in a table like this 

{| border=1 
{{FC/County|COUNTY NAME|STATUS}}
|}

→It produces

COUNTY NAME No volunteers yet STATUS




It can change the color of the row if the status is set to one of these three options exactly |not started|in progress|complete|


It accepts up to six optional editor names, separated by a pipe (|). If no editors are added, it will display "No volunteers yet".


Example usage 

{| border=1
{{FC/County|Kings|in progress|PesachZ}}
{{FC/County|Queens|not started}}
{{FC/County|New York|complete|pumrum|PesachZ}}
{{FC/County|Richmond|something else|pumrum|PesachZ|third|4th|fifth_Wazer|FinalShownWazer|not displayed above limit}}
|}

→Produces

Kings PesachZ (PM [Help])   in progress



Queens No volunteers yet not started



New York pumrum (PM [Help])  , PesachZ (PM [Help])   complete



Richmond pumrum (PM [Help])  , PesachZ (PM [Help])  , third (PM [Help])  , 4th (PM [Help])  , fifth_Wazer (PM [Help])  , FinalShownWazer (PM [Help])   something else




There also an optional (recommended) parameter to include a date the row was last updated. This will help keep the information in the table current, and allow works to quickly see which counties may be stale. The "date" parameter is added after a pipe (|), and accepts any value. It should be used to enter the date the row was last modified.

If it is not used, the last cell is not created in the table for that row. So it should either be used for all rows in a table, or for none of them.


For example

{{FC/County|Monroe|in progress|joyriding|date=Aug '14}}

→Produces

|- align="center" bgcolor="orange" |Monroe |joyriding (PM [Help])   |in progress |Aug '14



This template is optimally deployed in sortable wiki table. The top of table is formatted here with special wiki markup. There are two template options you can use here for this table. This code should be placed on the page where you want the table to be displayed, above where the individual row templates will be entered.

Option A) {{FC/Top}} which will produce a sortable table, with a caption, and all four columns County, Editor(s), Status, Updated.

Option B) {{FC/Topnd}} which will produce a sortable table, with a caption, and only three columns County, Editor(s), Status. The date column is not created in this table, use this option if you choose not to use the optional date= parameter.

Option C) Alternatively you can build your own table header using a variation on the following code.

{| class="wikitable sortable" border="1" |+ FC Upgrade Status by County (sortable) |- ! | County ! | Editor(s) ! | Status ! | Updated


The data for the individual rows using these templates are then added in the desired order here. Whichever order they are added in here will be the default order they are displayed in.

The data can be input here using one of two methods.

Option A) It can be isolated to a subpage, which can then be transcluded here. This method has the advantage of making it less daunting for a novice wiki editor to modify, as the only thing they'll see are the rooted of the table and any optional instruction notes you include. For example if the templates are isolated an stored on subpage /FC_table, you would put this code here to copy the data from that subpage into the table.

{{/FC table}}


Option B) Simply place the templates here, like this for example. 


{{FC/County|Kings|in progress|date=07/14|PesachZ}}
{{FC/County|Queens|date=July 2014|not started}}
{{FC/County|New York|complete|pumrum|PesachZ|date=5/14}}
{{FC/County|Richmond|something else|pumrum|PesachZ|third|4th|fifth_Wazer|FinalShownWazer|not displayed above limit}}


And below where the templates will be added, on the line below the individual row data, you need this code to complete the table. This can be done manually, or also with a template.

Option A) Put the following template {{FC/Bottom}}

Option B) Put the following code |}


→This produces when used all together

FC Upgrade Status by County (sortable)
County Editor(s) Status Updated
Kings PesachZ (PM [Help])   in progress 07/14


Queens No volunteers yet not started July 2014


New York pumrum (PM [Help])  , PesachZ (PM [Help])   complete 5/14


Richmond pumrum (PM [Help])  , PesachZ (PM [Help])  , third (PM [Help])  , 4th (PM [Help])  , fifth_Wazer (PM [Help])  , FinalShownWazer (PM [Help])   something else



Notice that the row for Richmond is missing the updated cell, this is because the "date" parameter wasn't included in that rows template. This is not recommended, either all rows ina table should use this parameter, or none should use it.

See Also


Retrieved from "https://www.waze.com/wiki/USA/index.php?title=Template:FC/County/doc&oldid=113532"