Template:Construction/doc View history

Latest revision as of 19:01, 9 August 2014

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

This template is added to pages that are undergoing major changes or initial developments.

Usage

Place {{construction}} at the top of a new page to produce the default message box.

Alternately, the following optional variables can be used to adjust the generic message:

{{construction
| contact     = URL of forum or user
| contacttype = forum or user
| draft       = yes or no
| open        = no
| revision    = yes
| section     = yes
| talk        = yes
}}

Parameters

contact

Optional URL parameter for forum or private message. Do not include the descriptor field of the URL, meaning only send the valid URL text without the extra space followed by a description of the URL. Requires |contacttype= to alter message appropriate for forum or individual user.

contacttype

Required if |contact= parameter is supplied. Optional message with URL linking to location where other editors should send messages on this page. Used with |open= parameter to control the message in the box. The |contacttype= parameter is completing this sentence If you have questions, please... When |contacttype=forum it displays: post a message in this forum. When |contacttype=user it displays: send a private message to this user.

draft

Optional parameter to display information on the quality or state of the content. Use |draft=yes to say the information is still draft form and not ready for use. Use |draft=no to say the information is accurate enough to be followed now. If the parameter is not included or is set to anything else, no text will be displayed regarding the draft condition.

open

Optional indicator if other input is desired. Only with the presence of the |contact= parameter can you use |open=no to display:

This page has already been identified as being needed. Content for this page is being prepared by one or more users. Do not make any changes before you

with the rest of the message coming from the |contacttype= parameter result. The default or empty |open parameter will display: This page has already been identified as being needed. This page is open to changes from anyone during construction. Further, if the |contact= parameter is also set you will see: If you have questions, please with the rest of the message coming from the |contacttype= parameter result. Requires the |contact= parameter must be set to direct people with a URL.

revision

The text can be altered to reflect the changes are based on a revision or a completely new set of information. This is related to the parameter |draft=, but fully independent of it. Use |revision=yes for text saying it is a revision. Do not include that parameter or set it to anything else to result in text saying the information is new.

section

The text can be altered to reflect the construction happening on the whole page (default) or just one or more sections. Use |section=yes for text covering just a section. Do not include that parameter or set it to anything else to result in text covering the whole page.

talk

If the talk page is currently being or will be used for initial thoughts on the page, use |talk=yes to display: Please use the talk page for thoughts and ideas on setting up this content.

Examples

Review the page Template:Construction/Examples for how some of the parameter combinations will look on a page.

Where used

Editors can find all occurrences of this template with the link to what links here for the Construction template.

Category added

This template will automatically add the Category:Construction to the page for tracking. The parameter |revision=yes will add Category:Revision, otherwise it will add Category:New.

@@ Line 2: / Line 2: @@
 This template is added to pages that are undergoing major changes or initial developments.
-=== Usage ===
+== Usage ==
-Place {{tl|Construction}} at the top of a new page to produce the default message box.
+Place {{tl|construction}} at the top of a new page to produce the default message box.
-Alternately, the following optional variables can be used in place of the generic message:
+Alternately, the following optional variables can be used to adjust the generic message:
 <pre>
-{{NeedPage
+{{construction
 | contact     = URL of forum or user
 | contacttype = forum or user
+| draft       = yes or no
 | open        = no
-| scope       = page
+| revision    = yes
+| section     = yes
 | talk        = yes
 }}
 </pre>
-=== Parameters ===
+== Parameters ==
 '''contact'''
-:Optional URL parameter for forum or private message. Requires {{para|contacttype}} to alter message appropriate for forum or individual user.
+:Optional URL parameter for forum or private message. Do not include the descriptor field of the URL, meaning only send the valid URL text without the extra space followed by a description of the URL. Requires {{para|contacttype}} to alter message appropriate for forum or individual user.
 '''contacttype'''
 :Required if {{para|contact}} parameter is supplied. Optional message with URL linking to location where other editors should send messages on this page. Used with {{para|open}} parameter to control the message in the box. The {{para|contacttype}} parameter is completing this sentence '''If you have questions, please...''' When {{para|<var>contacttype</var>|<var>forum</var>}} it displays: <code>post a message in [http://www.waze.com/forum/ this forum]</code>. When {{para|<var>contacttype</var>|<var>user</var>}} it displays: <code>send a private message to [http://www.waze.com/forum/ this user].</code>
+'''draft'''
+:Optional parameter to display information on the quality or state of the content. Use {{para|<var>draft</var>|<var>yes</var>}} to say the information is still draft form and not ready for use. Use {{para|<var>draft</var>|<var>no</var>}} to say the information is accurate enough to be followed now. If the parameter is not included or is set to anything else, no text will be displayed regarding the draft condition.
 '''open'''
 :Optional indicator if other input is desired. Only with the presence of the {{para|contact}} parameter can you use {{para|<var>open</var>|<var>no</var>}} to display: <code>This page has already been identified as being needed. Content for this page is being prepared by one or more users. Do not make any changes before you </code> with the rest of the message coming from the {{para|contacttype}} parameter result. The default or empty {{para||open}} parameter will display: <code>This page has already been identified as being needed. This page is open to changes from anyone during construction.</code> Further, if the {{para|contact}} parameter is also set you will see: <code>If you have questions, please </code> with the rest of the message coming from the {{para|contacttype}} parameter result. Requires the {{para|contact}} parameter must be set to direct people with a URL.
-'''scope'''
+'''revision'''
-:The text can be altered to reflect the construction happening on the whole page (default) or just one or more sections. Use {{para|<var>scope</var>|<var>page</var>}} for text covering the whole page. Use {{para|<var>scope</var>|<var>section</var>}} for text covering just a section.
+:The text can be altered to reflect the changes are based on a revision or a completely new set of information. This is related to the parameter {{para|draft}}, but fully independent of it. Use {{para|<var>revision</var>|<var>yes</var>}} for text saying it is a revision. Do not include that parameter or set it to anything else to result in text saying the information is new.
+'''section'''
+:The text can be altered to reflect the construction happening on the whole page (default) or just one or more sections. Use {{para|<var>section</var>|<var>yes</var>}} for text covering just a section. Do not include that parameter or set it to anything else to result in text covering the whole page.
 '''talk'''
 :If the talk page is currently being or will be used for initial thoughts on the page, use {{para|<var>talk</var>|<var>yes</var>}} to display: <code>{{Template:Mbox/Text/Talk}}</code>
-=== Where used ===
+== Examples ==
+Review the page [[Template:Construction/Examples]] for how some of the parameter combinations will look on a page.
+== Where used ==
 Editors can find all occurrences of this template with the link to [[Special:WhatLinksHere/Template:Construction|what links here for the Construction template]].
-=== Category added ===
+== Category added ==
-This template will automatically add the [http://wiki.waze.com/wiki/Category:Construction Category:Construction] to the page for tracking. You see a similar list to the What Links Here above.
+This template will automatically add the [[:Category:Construction]] to the page for tracking. The parameter {{para|<var>revision</var>|<var>yes</var>}} will add [[:Category:Revision]], otherwise it will add [[:Category:New]].
+== See also ==
+* {{tl|mbox}}
+* {{tl|AddCode}}
 <includeonly>
 <!-- ADD CATEGORIES BELOW THIS LINE -->
-[[Category:Maintenance Templates]]
+[[Category:Maintenance templates]]
+[[Category:Mbox templates]]
 <!-- ADD INTERWIKIS BELOW THIS LINE -->
 </includeonly>

Search