Difference between revisions of "Template:GOCE-new-drive-page/doc"
Jump to navigation
Jump to search
imported>Jonesey95 (Redoing parameters for clarity, simplicity. Enhancing template.) |
imported>Jonesey95 (formatting documentation) |
||
Line 12: | Line 12: | ||
}}{{#ifeq:{{BASEPAGENAME}}|{{PAGENAME}} |[[Category:Wikipedia substituted templates]]}} | }}{{#ifeq:{{BASEPAGENAME}}|{{PAGENAME}} |[[Category:Wikipedia substituted templates]]}} | ||
− | Use this template to populate a newly-created [[WP:GOCE|Guild of Copy Editors]] Drive page. It '''must always''' be substituted; if it is transcluded, you won't be able to edit the Drive page normally. | + | Use this template to populate a newly-created [[WP:GOCE|Guild of Copy Editors]] Drive page. It '''must always''' be substituted (see copy-and-paste example at the bottom of this page); if it is transcluded, you won't be able to edit the Drive page normally. |
− | |||
− | |||
===Parameters=== | ===Parameters=== | ||
Line 21: | Line 19: | ||
!Parameters || Variable || Notes | !Parameters || Variable || Notes | ||
|- | |- | ||
− | | <nowiki>|start-date=</nowiki> || Drive start date in any format ||The first day of the drive month, e.g. 1 February 2015 | + | |{{nowrap|<nowiki>|start-date=</nowiki>}}|| Drive start date in any format ||The first day of the drive month, e.g. '''1 February 2015''' |
|- | |- | ||
− | | <nowiki>|end-date=</nowiki> ||Drive end date in any format ||The last day of the drive month, e.g. 28 February 2015 | + | |{{nowrap|<nowiki>|end-date=</nowiki>}}||Drive end date in any format ||The last day of the drive month, e.g. '''28 February 2015''' |
|- | |- | ||
− | |<nowiki>|backlog-months=</nowiki>|| backlog months || include punctuation and "and" in the template markup | + | |{{nowrap|<nowiki>|backlog-months=</nowiki>}}|| backlog months || include punctuation and "and" in the template markup |
|- | |- | ||
− | |<nowiki>|request-months=</nowiki>|| request month(s)||include punctuation and "and" in the template markup | + | |{{nowrap|<nowiki>|request-months=</nowiki>}}|| request month(s)||include punctuation and "and" in the template markup |
|- | |- | ||
− | |<nowiki>|previous-drive=</nowiki>|| previous drive's month and year||full month name, starting with capital letter, e.g. December 2014 | + | |{{nowrap|<nowiki>|previous-drive=</nowiki>}}|| previous drive's month and year||full month name and year, starting with capital letter, e.g. '''December 2014''' |
|- | |- | ||
− | |<nowiki>|this-drive=</nowiki>|| this drive's month and year||full month name, starting with capital letter, e.g. February 2015 | + | |{{nowrap|<nowiki>|this-drive=</nowiki>}}|| this drive's month and year||full month name and year, starting with capital letter, e.g. '''February 2015''' |
|- | |- | ||
− | |<nowiki>|lead-coordinator=</nowiki>|| lead coordinator's username || <nowiki>Use {{subst:User0|Example}} | + | |{{nowrap|<nowiki>|lead-coordinator=</nowiki>}}|| lead coordinator's username || <nowiki>Use {{subst:User0|Example}} for all coordinator usernames.</nowiki> |
|- | |- | ||
− | |<nowiki>|coordinators=</nowiki>|| coordinators' usernames || list all coordinators' names (see example) | + | |{{nowrap|<nowiki>|coordinators=</nowiki>}}|| coordinators' usernames || list all coordinators' names (see example) |
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
===Example=== | ===Example=== | ||
This is an example of how to use the template. | This is an example of how to use the template. | ||
− | < | + | <pre> |
− | + | {{subst:GOCE-new-drive-page | |
− | + | | start-date=1 February 2015 | |
− | + | | end-date=28 February 2015 | |
− | + | | backlog-months=September, October and November 2013 | |
− | + | | request-months=November and December 2014 | |
− | + | | previous-drive=December 2014 | |
− | + | | this-drive=February 2015 | |
− | + | | lead-coordinator={{subst:User0|Example}} | |
− | + | | coordinators={{subst:User0|Example1}}, {{subst:User0|Example2}} and {{subst:User0|Example3}} | |
− | + | }}</pre> | |
− | ===Easy-to-use | + | ===Easy-to-use copy-and-paste version=== |
− | :Copy | + | :Copy and paste the empty template below into the new Drive page. |
:Fill in the parameters as shown in the example. | :Fill in the parameters as shown in the example. | ||
− | :Remove any parameters that are not required. < | + | :Remove any parameters that are not required. |
− | + | <pre> | |
− | + | {{subst:GOCE-new-drive-page | |
− | + | | start-date= | |
− | + | | end-date= | |
− | + | | backlog-months= | |
− | + | | request-months= | |
− | + | | previous-drive= | |
− | + | | this-drive | |
− | + | | lead-coordinator={{subst:User0|}} | |
− | + | | coordinators={{subst:User0|}} and {{subst:User0|}} | |
+ | }}</pre> | ||
+ | |||
<includeonly> | <includeonly> | ||
<!-- CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE --> | <!-- CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE --> | ||
[[Category:Guild of Copy Editors templates]] | [[Category:Guild of Copy Editors templates]] | ||
</includeonly> | </includeonly> |
Revision as of 00:24, 7 March 2015
Usage
![]() | This is a documentation subpage for Template:GOCE-new-drive-page. It contains usage information, categories and other content that is not part of the original template page. |
![]() | This template should always be substituted, i.e. use {{subst:GOCE-new-drive-page}}. |
Use this template to populate a newly-created Guild of Copy Editors Drive page. It must always be substituted (see copy-and-paste example at the bottom of this page); if it is transcluded, you won't be able to edit the Drive page normally.
Parameters
The table below shows the parameters that will populate the Drive page with the usual variables. If any are omitted, the Drive page can be edited as normal and the variables added. Omitted variables will not appear in the resulting Drive page.
Parameters | Variable | Notes |
---|---|---|
|start-date= | Drive start date in any format | The first day of the drive month, e.g. 1 February 2015 |
|end-date= | Drive end date in any format | The last day of the drive month, e.g. 28 February 2015 |
|backlog-months= | backlog months | include punctuation and "and" in the template markup |
|request-months= | request month(s) | include punctuation and "and" in the template markup |
|previous-drive= | previous drive's month and year | full month name and year, starting with capital letter, e.g. December 2014 |
|this-drive= | this drive's month and year | full month name and year, starting with capital letter, e.g. February 2015 |
|lead-coordinator= | lead coordinator's username | Use {{subst:User0|Example}} for all coordinator usernames. |
|coordinators= | coordinators' usernames | list all coordinators' names (see example) |
Example
This is an example of how to use the template.
{{subst:GOCE-new-drive-page | start-date=1 February 2015 | end-date=28 February 2015 | backlog-months=September, October and November 2013 | request-months=November and December 2014 | previous-drive=December 2014 | this-drive=February 2015 | lead-coordinator={{subst:User0|Example}} | coordinators={{subst:User0|Example1}}, {{subst:User0|Example2}} and {{subst:User0|Example3}} }}
Easy-to-use copy-and-paste version
- Copy and paste the empty template below into the new Drive page.
- Fill in the parameters as shown in the example.
- Remove any parameters that are not required.
{{subst:GOCE-new-drive-page | start-date= | end-date= | backlog-months= | request-months= | previous-drive= | this-drive | lead-coordinator={{subst:User0|}} | coordinators={{subst:User0|}} and {{subst:User0|}} }}