Difference between revisions of "Template:Hatnote/doc"

From Wazeopedia
(removing call to a missing template (no impact as we are in a /doc page))
Line 1: Line 1:
{{About|the Waze forum messaging feature|the Waze client application feature|Private message (Waze app)|the Wiki template|Template:PrivateMessage}}
+
{{Documentation subpage}}
  
Private messages (PMs) are a feature of the Waze community forum. Similar to email messages, they can be sent to one or more forum users at a time and are received in the recipients forum inbox.
+
== Usage ==
 +
Using {{tlx|Hatnote|''text''}} formats text into the standard stylistic for a [[Wikipedia:Hatnote|Wikipedia type hatnote]]. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarize a topic, explaining its boundaries.
  
You can send a PM to another user if you have a question that is not meant for a wider audience. Most general communication will take place in the [http://www.waze.com/forum/index.php community forums], but the forums do not have a way to alert someone that a person is asking them a question. The PM will appear in the user's [http://www.waze.com/forum/ucp.php?i=pm&folder=inbox Waze inbox] with an email to their registered email account alerting them that they have a PM.
+
{{Hatnote|This is text in a hatnote template.}}
  
Consider a case where you find a road segment that is not following the general guidelines of the Wiki and overall Waze community. Rather than post the user's name in the general forum, it would be better to send that user a direct PM asking the question and probably including a [[Waze Map Editor#Permalink|permalink]] to the segment in question. That will assure the user has the best chance of seeing the message, but it is still no guarantee they will read it or respond.
+
== Function ==
 +
This template is primarily used to add a correctly formatted ''hatnote'' to a page. Often, but not always, this is a ''disambiguation link'' at the top of article pages. It places an HTML <code>div-</code> / <code>div</code> block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.
  
[[Image:CreatePM.png|200px|thumb|right|]]The [http://www.waze.com/forum/ucp.php?i=pm&mode=compose compose] page is where you create a PM. In the upper left box type the name of the user(s) and press the '''add''' button. Add other users that you want to get the same email. Enter a subject related to your message. Enter the main message in the larger box in the middle of the page. Add emoticons as desired.
+
This template is also used as the "meta-template" for additional specialized disambiguation link templates; see [[Wikipedia:Otheruses templates (example usage)]] for a list.
  
When your message is complete, use the '''preview''' button at the bottom of the page to see what the message will look like to the recepient. This will let you be sure any [[Waze_Map_Editor#Permalink|permalinks]] or other links are working correctly.
+
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [http://en.wikipedia.org/wiki/Help:Cheatsheet Wiki markup].
  
The message will show up in your outbox until the user reads the message. Once the user has read it, it will move to your Sent folder.
+
== Code ==
 +
The code used in this template includes:
 +
<code><nowiki><div class="dablink"></div></nowiki></code>
 +
 
 +
== Parameters ==
 +
 
 +
The only required parameter is the desired text to be displayed in the hatnote. It is passed as the first and only parameter in the template.
 +
 
 +
 
 +
<!--Commented out until the Visual Editor is implemented
 +
 
 +
==Template data==
 +
{{TemplateDataHeader}}
 +
<templatedata>{
 +
"description": "Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarize a topic, explaining its boundaries.",
 +
"params": {
 +
  "1": {
 +
    "label": "Text",
 +
    "description": "This field should contain the text that will be displayed in the hatnote.",
 +
    "type": "string",
 +
    "required": true
 +
  }
 +
}}</templatedata>
 +
 
 +
End of Comment out-->
 +
 
 +
== See also ==
 +
{{tl|See also}}
 +
 
 +
 
 +
<includeonly>
 +
[[Category:Hatnote templates]]
 +
[[Category:Incomplete templates]]
 +
</includeonly>

Revision as of 10:17, 26 March 2015

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

Usage

Using {{Hatnote|text}} formats text into the standard stylistic for a Wikipedia type hatnote. That produces a short note placed at the top of an article to provide disambiguation of closely related terms or summarize a topic, explaining its boundaries.

Function

This template is primarily used to add a correctly formatted hatnote to a page. Often, but not always, this is a disambiguation link at the top of article pages. It places an HTML div- / div block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.

This template is also used as the "meta-template" for additional specialized disambiguation link templates; see Wikipedia:Otheruses templates (example usage) for a list.

The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wiki markup.

Code

The code used in this template includes: <div class="dablink"></div>

Parameters

The only required parameter is the desired text to be displayed in the hatnote. It is passed as the first and only parameter in the template.


See also

{{See also}}