Template:NeedPage/doc View history

(building template; Added things for Construction page temporarily)
(documented new template.)
Line 5: Line 5:


=== Usage ===
=== Usage ===
Place {{tl|NeedPage}} at the top of a new page to produce the message box with the default message.
Place {{tl|NeedPage}} 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 in place of the generic message:


<pre>
<pre>
{{NeedPage
{{NeedPage
| text      = <div>The text to be displayed in the box. The DIV function helps keep the text and line breaks as desired.</div>
| contact    = URL of forum or user
| textstyle  = color: red;
| contacttype = forum or user
| contact    = [ESCAPED URL] (Template will fill in rest.)
| open        = no
| talk        = yes
}}
}}
</pre>
</pre>
Line 19: Line 20:


=== Parameters ===
=== Parameters ===
List of all parameters:
<pre>
{{NeedPage
| contact =
| open = yes / no
| style = CSS values
| text  = The message body text.
| textstyle = CSS values
}}
</pre>


'''contact'''
'''contact'''
:Optional URL linking to location where other editors should send messages on this page.
:Optional URL parameter for forum or private message. Requires '''contacttype''' to alter message appropriate for forum or individual user.
 
'''Open'''
:Optional indicator if other input is desired or not. <code>Yes</code> displays "This page is open to changes from anyone during construction."
 
'''style'''
:Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-bottom: 0.5em;</code>


'''text'''
'''contacttype'''
:The message body text.
: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 the contacttype is "<code>forum</code>" it displays: <code>post a message in [http://www.waze.com/forum/ this forum]</code>. When the contacttype is "<code>user</code>" is displays: <code>send a private message to [http://www.waze.com/forum/ this user].</code>


'''textstyle'''
'''open'''
:Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
:Optional indicator if other input is desired. Use "<code>no</code>" 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.
::<code>textstyle = text-align: center;</code>


'''talk'''
:If the talk page is currently being or will be used for initial thoughts on the page, use '''<code>yes</code>''' to display "Please use the talk page for thoughts and ideas on setting up this page."


=== Where used ===
=== Where used ===

Revision as of 08:22, 26 February 2014

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

This template is added to new pages that do not yet exist to prevent a user from getting the create page link when they select it. The current person editing the page may not have have the information yet or is unable to add it at this time.

If preliminary information is being saved in preparation for creating the page content, consider placing the data on the talk page and put a link to it from the page below this template.

Usage

Place {{NeedPage}} 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:

{{NeedPage
| contact     = URL of forum or user
| contacttype = forum or user
| open        = no
| talk        = yes
}}


Parameters

contact

Optional URL parameter for forum or private message. 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 the contacttype is "forum" it displays: post a message in this forum. When the contacttype is "user" is displays: send a private message to this user.

open

Optional indicator if other input is desired. Use "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.

talk

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

Where used

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

Note that pages with this template will not be seen in the Special:WantedPages so use the above "what links here instead."

Category added

This template will automatically add the Category:NeedPage to the page for tracking. You see a similar list to the What Links Here above.