Template:Work in progress/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "<noinclude>{{docsub}}</noinclude> The <nowiki>{{</nowiki>work in progress<nowiki>}}</nowiki> template provides an easy way to place a message box on an article or section identifying it as a work in progress.") |
mNo edit summary |
||
Line 1: | Line 1: | ||
<noinclude>{{docsub}}</noinclude> | <noinclude>{{docsub}}</noinclude> | ||
<div id="shortcut" style="float:right;margin-top:-10px;"> | |||
{| class="wikitable" style="text-align:center" | |||
|- | |||
| <small>Shortcut</small><hr />'''<nowiki>{{</nowiki>[[Template:wip|wip]]<nowiki>}}</nowiki>''' | |||
|}</div> | |||
The <nowiki>{{</nowiki>[[Template:work in progress|work in progress]]<nowiki>}}</nowiki> template provides an easy way to place a message box on an article or section identifying it as a work in progress. | The <nowiki>{{</nowiki>[[Template:work in progress|work in progress]]<nowiki>}}</nowiki> template provides an easy way to place a message box on an article or section identifying it as a work in progress. | ||
==Usage== | |||
{| | |||
|- | |||
| Basic usage: || <code><nowiki>{{work in progress}}|</nowiki> | |||
|- | |||
| All parameters: || <code><nowiki>{{work in progress|</nowiki>''1''<nowiki>|</nowiki>text=''some text.''<nowiki>|</nowiki>talk=''talk page link''<nowiki>}}</nowiki></code> | |||
|} | |||
To mark an entire article as a work in progress, place the template at the top of the page. To mark a section as a work in progress, place the template immediately after the section heading and set the unnamed parameter <code>{{{1}}}</code> to <code>section</code>. | |||
==Parameters== | |||
{| class="wikitable" | |||
! Parameter !! Description !! Type !! Status !! Notes | |||
|- | |||
| <code>1</code> || Type of work in progress || String || Optional || Defaults to <code>article</code>; set to <code>section</code> for applicability only to a section of an article. | |||
|- | |||
| <code>text</code> || Additional text || String || Optional || Use to display additional explanatory text, if desire. | |||
|- | |||
| <code>talk</code> || Talk page link || String || Optional || Use to link to a talk page; the link may specify a section with the <code>talk:''pagename''#''section name''</code> syntax; do not include <code>[[</code> and <code>]]</code> around the link. | |||
|} | |||
==Examples== | |||
* <code><nowiki>{{work in progress}}</nowiki></code> | |||
{{work in progress}} | |||
* <code><nowiki>{{work in progress|section}}</nowiki></code> | |||
{{work in progress|section}} | |||
* <code><nowiki>{{work in progress|text=Some or all of the following information may not be canon.}}</nowiki></code> | |||
{{work in progress|text=Some or all of the following information may not be canon.}} | |||
* <code><nowiki>{{work in progress|talk=Template talk:work in progress}}</nowiki></code> | |||
{{work in progress|talk=Template talk:work in progress}} |
Revision as of 21:16, 12 December 2023
This is a documentation subpage for Template:Work in progress. It may contain usage information, categories and other content that is not part of the original template page. |
Shortcut {{wip}} |
The {{work in progress}} template provides an easy way to place a message box on an article or section identifying it as a work in progress.
Usage
Basic usage: | {{work in progress}}|
|
All parameters: | {{work in progress|1|text=some text.|talk=talk page link}}
|
To mark an entire article as a work in progress, place the template at the top of the page. To mark a section as a work in progress, place the template immediately after the section heading and set the unnamed parameter {{{1}}}
to section
.
Parameters
Parameter | Description | Type | Status | Notes |
---|---|---|---|---|
1 |
Type of work in progress | String | Optional | Defaults to article ; set to section for applicability only to a section of an article.
|
text |
Additional text | String | Optional | Use to display additional explanatory text, if desire. |
talk |
Talk page link | String | Optional | Use to link to a talk page; the link may specify a section with the talk:pagename#section name syntax; do not include [[ and ]] around the link.
|
Examples
{{work in progress}}
{{work in progress|section}}
{{work in progress|text=Some or all of the following information may not be canon.}}
{{work in progress|talk=Template talk:work in progress}}
This article is a work in progress. Relevant discussion may be found on the talk page. |