Difference between revisions of "Template:PrivateMessage/doc"

From Wazeopedia
(Creating documentation)
 
(finish doc)
Line 3: Line 3:
  
 
== Usage ==
 
== Usage ==
Place {{tl|PrivateMessage}} on a user page.
+
Place {{tl|PrivateMessage}} on a user page. When on a user page, it will automatically identify the username to be used in the private message link. The subject of the private message will be populated with "A Wiki Question" and can be changed in the Private Message
 
 
== REMAINING CONTENT NOT YET UPDATED TO THIS TEMPLATE ==<!-- remove heading -->
 
  
 
Alternately, the following optional variables can be used to adjust the generic message:
 
Alternately, the following optional variables can be used to adjust the generic message:
  
 
<pre>
 
<pre>
{{construction
+
{{PrivateMessage
| contact    = URL of forum or user
+
| username    = user name for the private message
| contacttype = forum or user
 
| draft      = yes or no
 
| open        = no
 
| revision    = yes
 
| section    = yes
 
| talk        = yes
 
 
}}
 
}}
 
</pre>
 
</pre>
Line 23: Line 15:
 
== Parameters ==
 
== Parameters ==
  
'''contact'''
+
'''username'''
: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.
+
:Optional parameter listing the user name for the private message. When the template is placed on a user's page, this parameter is not required. It can be used to create a private message link to a user when the template is not on the user page.
 
 
'''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.
 
 
 
'''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 {{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'''
+
== Example ==
: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.
+
{{tl|PrivateMessage|}} will generate the following on FastWazer's user page:
 +
{{PrivateMessage|username=FastWazer}}
  
'''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>
 
  
== Examples ==
+
{{tl|PrivateMessage|username{{=}}FastWazer}} will generate the following on any page:
Review the page [[Template:Construction/Examples]] for how some of the parameter combinations will look on a page.
+
{{PrivateMessage|username=FastWazer}}
  
== 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 [[: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]].
+
No category is added to pages with this template.
  
 
== See also ==
 
== See also ==
Line 58: Line 35:
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Maintenance Templates]]
 
 
[[Category:Mbox Templates]]
 
[[Category:Mbox Templates]]
  
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
</includeonly>
 
</includeonly>

Revision as of 22:11, 15 May 2014

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

This template provides a private message link to a username. It is designed to go on user pages.

Usage

Place {{PrivateMessage}} on a user page. When on a user page, it will automatically identify the username to be used in the private message link. The subject of the private message will be populated with "A Wiki Question" and can be changed in the Private Message

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

{{PrivateMessage
| username    = user name for the private message
}}

Parameters

username

Optional parameter listing the user name for the private message. When the template is placed on a user's page, this parameter is not required. It can be used to create a private message link to a user when the template is not on the user page.

Example

{{PrivateMessage}} will generate the following on FastWazer's user page:

FastWazer can be reached by private message.


{{PrivateMessage}} will generate the following on any page:

FastWazer can be reached by private message.


Category added

No category is added to pages with this template.

See also