Template:Work in progress/doc: Difference between revisions

(11 intermediate revisions by 3 users not shown)

Line 1:

;Description

; Description

:This template is marks pages that are currently being worked on to avoid edit conflicts, etc. It ~~also provides~~ a ~~convenient link to~~ the ~~talk~~/~~discussion section of~~ the ~~currently viewed page~~.

: This template marks pages that are currently being worked on to avoid edit conflicts, etc.

: Generally, it should be removed once the page is not actively being worked on. It should be removed from pages that have been tagged as works in progress for a long time since there is no work in progress on the page. This tag might discourage others from improving the page.

: Putting this template on a article/page automatically adds it to the [[:category:Work in progress|Work in progress]] category.

:Generally, it should be removed once the page is not actively being worked on. It should be removed from pages that have been tagged as works in progress for a long time since there is no work in progress on the page. This tag might discourage others from improving the page.

; Dependencies

: Uses:

:: {{T|Banner}}

:~~For cleanup issues~~, ~~use~~ a {{t|~~Cleanup~~}} template ~~instead, with an edit summary indicating what needs cleanup~~.

;Syntax

: {{T|1=Work in progress|2=description|3=date= date}}

; Parameters

: <code>description</code>

:: A description of the work being done. Can include a link to a draft page.

: <code>date=</code>

:: The date that the article/page has last been edited (optional).

::: To make it easy write date= <nowiki>~~~~~</nowiki> (5x~) which will expand to time, date and timezone when saved or viewed in preview.

::: Update when a relevant update has been done. i.e. do not change when a only a broken link has been fixed or other minor edits.

; Sample output

: {{Code|<nowiki>{{Work in progress}}</nowiki>}} gives...

{{Banner|color= #2B3856|border= orange

|'''This page is a work in progress.'''

This article or section '''is in the process of an expansion or major restructuring'''. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.

}}

~~;Syntax~~

: {{Code|<nowiki>{{Work in progress|Reformatting tables}}</nowiki>}} gives...

:~~Add <code>~~{{t|~~Work in progress}}</code> to the top of the page you are working on.~~

{{Banner|color= #2B3856|border= orange

~~;Sample output~~

|'''This page is a work in progress.''' Notes: ''Reformatting tables''

~~:<code>~~<nowiki>{{Work in progress}}</nowiki>~~</code>~~

::gives...

This article or section '''is in the process of an expansion or major restructuring'''. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.

}}

~~;Optional descriptor~~

: {{Code|<nowiki>{{Work in progress|Reformatting tables|date= ~~~~~}}</nowiki>}} gives...

:~~Type <code>~~{{~~t|Work in progress~~|~~Example reason given}}</code> at the top of the page.~~

{{Banner|color= #2B3856|border= orange

~~:<code>~~<nowiki>{{Work in progress|Reformatting tables}}</nowiki>~~</code>~~

|'''This page is a work in progress.''' Notes: ''Reformatting tables''

::gives...

~~;See also:~~<~~!-- delete if N/A --~~>

This article or section '''is in the process of an expansion or major restructuring'''. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template. Last edited: 13:42, 7 April 2022 (UTC)

:* [[Template:~~Cleanup]]~~

}}

<includeonly>[[Category:Maintenance templates~~|{{PAGENAME}}~~]]</includeonly>

<includeonly>[[Category:Maintenance templates]]</includeonly>

<noinclude>[[Category:Template documentation~~|{{PAGENAME}}~~]]</noinclude>

<noinclude>[[Category:Template documentation]]</noinclude>

@@ Line 1: / Line 1: @@
-;Description
+; Description
-:This template is marks pages that are currently being worked on to avoid edit conflicts, etc. It also provides a convenient link to the talk/discussion section of the currently viewed page.
+: This template marks pages that are currently being worked on to avoid edit conflicts, etc.
+: Generally, it should be removed once the page is not actively being worked on. It should be removed from pages that have been tagged as works in progress for a long time since there is no work in progress on the page. This tag might discourage others from improving the page.
+: Putting this template on a article/page automatically adds it to the [[:category:Work in progress|Work in progress]] category.
-:Generally, it should be removed once the page is not actively being worked on. It should be removed from pages that have been tagged as works in progress for a long time since there is no work in progress on the page. This tag might discourage others from improving the page.
+; Dependencies
+: Uses:
+:: {{T|Banner}}
-:For cleanup issues, use a {{t|Cleanup}} template instead, with an edit summary indicating what needs cleanup.
+;Syntax
+: {{T|1=Work in progress|2=description|3=date= date}}
+; Parameters
+: <code>description</code>
+:: A description of the work being done. Can include a link to a draft page.
+: <code>date=</code>
+:: The date that the article/page has last been edited (optional).
+::: To make it easy write date= <nowiki>~~~~~</nowiki> (5x~) which will expand to time, date and timezone when saved or viewed in preview.
+::: Update when a relevant update has been done. i.e. do not change when a only a broken link has been fixed or other minor edits.
+; Sample output <!-- Not using the actual template to avoid the automatic category assigning -->
+: {{Code|<nowiki>{{Work in progress}}</nowiki>}} gives...
+{{Banner|color= #2B3856|border= orange
+|'''This page is a work in progress.'''
+This article or section '''is in the process of an expansion or major restructuring'''. You are welcome to assist in its construction by editing it as well.<br>If this article or section has not been edited in several days, please remove this template.
+}}
-;Syntax
+: {{Code|<nowiki>{{Work in progress|Reformatting tables}}</nowiki>}} gives...
-:Add <code>{{t|Work in progress}}</code> to the top of the page you are working on.
+{{Banner|color= #2B3856|border= orange
-;Sample output
+|'''This page is a work in progress.''' <br>Notes: ''Reformatting tables''
-:<code><nowiki>{{Work in progress}}</nowiki></code>
-::gives...
+This article or section '''is in the process of an expansion or major restructuring'''. You are welcome to assist in its construction by editing it as well.<br>If this article or section has not been edited in several days, please remove this template.
-{{Work in progress}}
+}}
-;Optional descriptor
+: {{Code|<nowiki>{{Work in progress|Reformatting tables|date= ~~~~~}}</nowiki>}} gives...
-:Type <code>{{t|Work in progress|Example reason given}}</code> at the top of the page.
+{{Banner|color= #2B3856|border= orange
-:<code><nowiki>{{Work in progress|Reformatting tables}}</nowiki></code>
+|'''This page is a work in progress.''' <br>Notes: ''Reformatting tables''
-::gives...
-{{Work in progress|Reformatting tables}}
-;See also:<!-- delete if N/A -->
+This article or section '''is in the process of an expansion or major restructuring'''. You are welcome to assist in its construction by editing it as well.<br>If this article or section has not been edited in several days, please remove this template.<br><br>Last edited: 13:42, 7 April 2022 (UTC)
-:* [[Template:Cleanup]]
+}}
-<includeonly>[[Category:Maintenance templates|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
+<includeonly>[[Category:Maintenance templates]]<!-- Any categories for the template itself --></includeonly>
-<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+<noinclude>[[Category:Template documentation]]</noinclude>