Template:FC/County/doc View history

(testing)
(clarified instructions, incorporated new guidance on using date parameter)
Line 52: Line 52:




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.
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.




Line 75: Line 77:




The templates are then added in your chosen order here. These can also be transcluded in from a subpage if you wish by adding the code referencing the subpage where the templates are store here. For example if the templates are isolated an stored on subpage /FC_table, you would put here.
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.
 
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>




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




Line 108: Line 114:
{{FC/County|Richmond|something else|pumrum|PesachZ|third|4th|fifth_Wazer|FinalShownWazer|not displayed above limit}}
{{FC/County|Richmond|something else|pumrum|PesachZ|third|4th|fifth_Wazer|FinalShownWazer|not displayed above limit}}
|}
|}
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.
<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->

Revision as of 20:15, 15 August 2014

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}}

→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) in progress



Queens No volunteers yet not started



New York pumrum (PM)PesachZ (PM) complete



Richmond pumrum (PM)PesachZ (PM)third (PM)4th (PM)fifth_Wazer (PM)FinalShownWazer (PM) 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) |in progress |Aug '14



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.

{| class="wikitable sortable" border="1" |+ FC Upgrade Status by County (sortable) |- ! scope="col" | County ! scope="col" | Editor(s) ! scope="col" | Status ! scope="col" | 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.

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}}


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, you need this code to complete the table.

|}


→This produces

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


Queens No volunteers yet not started July 2014


New York pumrum (PM)PesachZ (PM) complete 5/14


Richmond pumrum (PM)PesachZ (PM)third (PM)4th (PM)fifth_Wazer (PM)FinalShownWazer (PM) 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.