قالب:Hatnote/doc
 | هذه صفحة توثيق فرعية لـ قالب:Hatnote. تتضمن معلومات الاستعمال، التصنيفات وأي محتوى آخر ليس من محتويات الأصل لصفحة القالب. |
 | Uses Lua: |
This template produces formatted text, following the guideline for a Wikipedia hatnote.
{{hatnote|Example hatnote text.}}→
Broadly speaking, a hatnote should answer a readers' question (maybe preemptively): Am I on the right page?
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 Category:Hatnote templates for a list.
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.
Usage
- Basic usage
{{hatnote|text}}
- All parameters
{{hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}
Parameters
This template accepts the following parameters:
1- the hatnote text. (required)extraclasses- any extra CSS classes to be added. For example, the {{see also}} template adds the classes|extraclasses=boilerplate seealso.selfref- if set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.category- if set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This only has an effect if the first positional parameter (the hatnote text) is omitted.
Example
{{hatnote|Example hatnote text}}→
Errors
If no hatnote text is supplied, the template will output the following message:
- Error: no text specified (help).
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{hatnote}}). Please use{{hatnote|text}}instead. - Some parameters were specified, but the hatnote text wasn't included. For example, the template text
{{hatnote|extraclasses=seealso}}will produce this error. Please use (for example){{hatnote|text|extraclasses=seealso}}instead. - The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code
{{hatnote|2+2=4}}will produce this error. To work around this, you can specify the parameter name explictly by using1=before the hatnote text, like this:{{hatnote|1=2+2=4}}. - You tried to access Module:Hatnote directly by using
{{#invoke:hatnote|hatnote|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use{{hatnote|text}}instead.
If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
Technical details
The HTML code produced by this template looks like this:
<div class="hatnote">hatnote text</div>
The code is produced by Module:Hatnote.
| هذه صفحة توثيق فرعية لـ قالب:Hatnote. تتضمن معلومات الاستعمال، التصنيفات وأي محتوى آخر ليس من محتويات الأصل لصفحة القالب. |
Hatnote templates
For a summary page on how to use these templates, see the example page here. For the full editing guideline on hatnotes, see Wikipedia:Hatnote.
Generic
{{Hatnote|CUSTOM TEXT}}→
{{Hatnote|For other senses of this term, see [[etc…]]}}→
{{Rellink|CUSTOM TEXT}}→
Other uses (of the title)
"This page is about … For other uses …"
{{About}} is the main template for noting other uses.
Note. When used in main namespace, the word "page" in the following hatnotes is replaced by "article".
{{About|USE1}}→{{About|USE1||PAGE2}}(When the disambiguation page has a different name — Note the empty second parameter) →{{About|USE1|USE2|PAGE2}}(When there is only one other use) →{{About|USE1|USE2|PAGE2|and|PAGE3}}(Two pages for USE2) →{{About|USE1|USE2|PAGE2#SUBSECTION{{!}}PAGE2TITLE}}(Using the {{!}} template to give the link a different title) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4|USE5|PAGE5}}(When there are up to five other uses — You should generally create a disambiguation page at this point) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses}}(When there are several standard other uses and also a disambiguation page with default name — Note that the last page name is not specified) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4}}(When there are several standard other uses and also a disambiguation page with non-default name) →{{About|USE1|USE2|PAGE2|USE3|PAGE3|other uses|PAGE4|and}}→{{About||USE2|PAGE2|USE3|PAGE3|other uses}}(When you don't need to state the focus of this article/page — Note the empty first parameter) →{{About|||PAGE1|and|PAGE2}}→
- Note:
{{for||PAGE1|PAGE2}}produces the same result.
{{Other uses-section|USE}}(disambiguous) → قالب:Other uses-section
- Note: this hatnote says "section", instead of "article" or "page".
"See also …"
{{See also|OTHER TOPIC|OTHER TOPIC2}}→
- Note: use when OTHER TOPIC is related to that of the current article and already contains a self-explanatory parenthetical.
{{See also2|[[OTHER TOPIC]]|[[OTHER TOPIC2]]|[[OTHER TOPIC3]] and other text}}→
"For …, see …"
{{For}} can be used instead of {{About}} so as not to display: This page is about USE1. but still specify a specific other use. This effect can also be achieved by using an empty first parameter in {{About}} as in:
- For example:
{{for|OTHER TOPIC|PAGE1}}is the same as{{About||OTHER TOPIC|PAGE1}}(note the empty first parameter).
However, it is somewhat clearer when using the {{For}} template, since the word "about" does not appear in the statement.
{{For|OTHER TOPIC}}(disambiguous) →{{For|OTHER TOPIC|PAGE1}}→{{For|OTHER TOPIC|PAGE1|PAGE2}}→{{For|OTHER TOPIC|PAGE1|PAGE2|PAGE3}}→{{For||PAGE1|PAGE2}}→
- Variations
As with {{Other uses}}, there are a whole family of "for" templates.
{{For2|OTHER TOPIC|CUSTOM TEXT}}→لمعلومات عن OTHER TOPIC, انظر CUSTOM TEXT.
"For other uses, see …"
When such a wordy hatnote as {{About}} is not needed, {{Other uses}} is often useful.
{{Other uses}}(disambiguous) →{{Other uses|PAGE1}}→{{Other uses|PAGE1|PAGE2}}→
- Variations
There are, historically, a whole family of "other uses" templates for specific cases. {{About}} is the standard hatnote for "other uses" and many of them can be specified using the {{About}} template. However, the individual templates may be easier to use in certain contexts.
Here are the variations and (when appropriate) the equivalents using the {{About}}, {{Other uses}} or {{For}} templates.
{{Other uses2|PAGE1}}(disambiguous) →
- Note: adds "(disambiguation)" to whatever is input as the PAGE1.
- Note:
{{Other uses|PAGE1 (disambiguation)}}produces the same result.
{{Two other uses|USE1|USE2|PAGE2}}→هذه المقالة هي عن USE1. إذا كنت تبغي USE2, انظر PAGE2. إذا كنت تبغي استعمالات أخرى, انظر Hatnote/doc (توضيح).
- Note: same as {{about}}, except it forces a second use to be noted if unspecified by parameters.
{{Two other uses|USE1|USE2|PAGE2|USE3|PAGE3}}→{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3}}هذه المقالة هي عن USE1. لمطالعة USE2, انظر PAGE2. ولمطالعة USE3, انظر PAGE3. ولمطالعة استخدامات أخرى, انظر Hatnote/doc (توضيح).{{Three other uses||USE2|PAGE2|USE3|PAGE3}}→لمطالعة USE2, انظر PAGE2. ولمطالعة USE3, انظر PAGE3. ولمطالعة استخدامات أخرى, انظر Hatnote/doc (توضيح).{{Three other uses|USE1|USE2|PAGE2|USE3|PAGE3|USE4|PAGE4}}→
"For other uses of …, see …"
{{Other uses of}}(disambiguous) →{{Other uses of|TOPIC}}(disambiguous) →{{Other uses of|TOPIC|PAGE1}}→
"For more details on …, see …"
{{Details}} is used to make summary style explicit. To be used in a section for which there is also a separate article on the subject.
{{Details|Article|TOPIC}}→
{{Details3}} allows any text to links:
{{Details3|[[article 1]], [[article 2]], and [[article 3]]|TOPIC}}→
"… redirects here. For other uses, see …"
{{Redirect|REDIRECT}}(disambiguous) →{{Redirect|REDIRECT||PAGE1}}→{{Redirect|REDIRECT|USE1|PAGE1}}→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2}}→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→{{Redirect|REDIRECT|USE1|PAGE1|and|PAGE2}}→{{Redirect|REDIRECT|USE1|PAGE1|USE2|PAGE2|and|PAGE3}}→
- Variations
{{Redirect-synonym|TERM|PAGE}}or{{Redirect-acronym|TERM|PAGE}}→{{Redirect2|REDIRECT1|REDIRECT2}}(disambiguous) →"REDIRECT1" و "REDIRECT2" يـُحوّلا إلى هنا. للاستخدامات الأخرى, انظر REDIRECT1 (توضيح).{{Redirect2|REDIRECT1|REDIRECT2|USE|PAGE1}}→"REDIRECT1" و "REDIRECT2" يـُحوّلا إلى هنا. للاستخدامات الأخرى, انظر USE (توضيح).{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2}}→"REDIRECT1" و "REDIRECT2" يـُحوّلا إلى هنا. للاستخدامات الأخرى, انظر USE1 (توضيح).{{Redirect2|REDIRECT1|REDIRECT2|USE1|PAGE1|USE2|PAGE2|USE3|PAGE3}}→"REDIRECT1" و "REDIRECT2" يـُحوّلا إلى هنا. للاستخدامات الأخرى, انظر USE1 (توضيح).{{Redirect3|REDIRECT|TEXT}}→"REDIRECT" تحويلات هنا. TEXT.{{Redirect4|REDIRECT1|REDIRECT2}}(disambiguous) →"REDIRECT1" و"REDIRECT2" يحول هنا. لاستخدامات أخرى، انظر REDIRECT1 (توضيح) وREDIRECT2 (توضيح).{{Redirect6|REDIRECT|USE1|PAGE1}}(disambiguous) →"REDIRECT" تحوِّل إلى هنا. إذا أردت USE1، انظر PAGE1. إذا أردت الاستخدامات الأخرى، انظر REDIRECT (توضيح).{{Redirect6|REDIRECT|USE1|PAGE1||PAGE2}}→{{Redirect7|"REDIRECT1", "REDIRECT2", and "REDIRECT3"|USE1|PAGE1|USE2|PAGE2}}→
- Note: If the number of pages redirecting to the target page is two,
{{Redirect2}}can be used instead. If the number is three and there are three corresponding disambiguation pages,{{Redirect10}}can be used.
{{Redirect10|REDIRECT1|REDIRECT2|REDIRECT3}}(disambiguous) →
- ... Not to be confused with ...
{{Redirect-distinguish|REDIRECT|PAGE1}}→{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Redirect-distinguish2|REDIRECT|TEXT}}→
"Further information: …"
{{See|OTHER TOPIC}}→{{See|Iraq and weapons of mass destruction|Saddam Hussein and al-Qaeda|Downing Street memo|Bush-Blair memo}}→{{Further|[[Article 1]], [[Article 2]], and [[Article Something#3|Article 3]]}}→
Other people, places, etcetera
Other people
{{Other people}}(disambiguous) →{{Other people|NAME}}(disambiguous) →{{Other people|NAME|PAGE}}→{{Other people|NAME|PAGE|named=titled}}→{{Other people2|PAGE}}→لأشخاص آخرون يحملون نفس الاسم، انظر PAGE.{{Other people3}}(disambiguous) →
- Note: same as {{About}} except uses "other people" instead of "other uses" if only 1 parameter is used
{{Other people3|PERSON1}}(disambiguous) →{{Other people3|PERSON1|PERSON2}}(disambiguous) →{{Other people3|PERSON1|PERSON2|PAGE2}}→{{Other people3|PERSON1||PAGE2}}→{{Other people5|NAME1|NAME2|NAME3|NAME4}}→
- Note: defaults to "named" as in {{Other people}}, exists for options like "nicknamed", "known as", etc.
Other places
{{Other places}}, analogous to {{Other uses}} (disambiguous) →{{Other places|PAGE}}, analogous to {{Other uses2}}(disambiguous) →{{Other places3|PAGE}}, analogous to {{Other uses}} →
Other hurricanes
For articles on storms:
{{Other hurricanes}}(disambiguous) →{{Other hurricanes|PAGE1}}→{{Other hurricanes|PAGE1|THIS}}→{{Other hurricanes||THIS}}→
Other ships
For articles on ships:
{{Other ships|SHIP1}}→
Distinguish
"Not to be confused with …"
{{Distinguish|PAGE1}}→{{Distinguish|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Distinguish2|TEXT}}→لا يجب الخلط بين موضوع المقال و TEXT.
"… redirects here. It is not to be confused with …"
{{Redirect-distinguish|REDIRECT|PAGE1}}→{{Redirect-distinguish|REDIRECT|PAGE1|PAGE2|PAGE3|PAGE4}}→{{Redirect-distinguish2|REDIRECT|TEXT}}→
"Main article: …" etcetera
{{Main|Main Article}}→{{Main|Main Article|Article2}}→{{Main list|Article1}}→{{ArticlePreceeding|George Washington}}→ قالب:ArticlePreceeding{{ArticleSucceeding|Thomas Jefferson}}→ قالب:ArticleSucceeding{{ArticlePair|George Washington|Thomas Jefferson}}→ قالب:ArticlePair
Wikipedia self-reference
{{Selfref|ANYTEXT}}→ANYTEXT
- See: Manual of Style (self-references to avoid) for more details.
Categories
Category-specific templates produce bold category names.
{{Category see also|THIS|THAT|THE OTHER}}→
This is a template for linking categories horizontally. Horizontal linkage is often the right solution when vertical linkage (i.e. as sub-category and parent category) is not appropriate. In most cases, this template should be used on both categories to create reciprocal linkage between the two categories.
{{CatPreceding|OTHER TOPIC}}→{{CatSucceeding|OTHER TOPIC}}→{{Category pair|TOPIC1|TOPIC2}}→{{Contrast|OTHERCAT|OTHERCAT2}}→{{Contrast|OTHERCAT|OTHERCAT2|plural=yes}}→
Family names
Lists
User pages
{{This user talk|TOPIC|PAGE1}}→
Notes
Do not use subst: with these templates, as that will prevent:
- propagating changes as the template is modified; and the
- What links here (WLH) listing.
These templates are used in thousands of articles; therefore, changing the syntax could break thousands of articles. If you wish to create or edit a disambiguation or redirection template, first ask yourself the following questions:
- Is there already a template that will do this job? Since many disambiguation and redirection templates have already been created, first check: تصنيف:قوالب التوضيح والتحويل.
- Do I really need a new template for this? Will it likely be used on any other articles or should I just use {{Hatnote}} instead? Before creating a new template, see: Template namespace guideline.
- If I change the parameters around on an existing template, do I know what the result will be? Will it break existing uses of the template and if so, can I fix all of the errors? Before making any changes, see: Template sandbox and test cases.
See also
TemplateData
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Hatnote 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 summarise a topic, explaining its boundaries.
| |||||||||||||||||||||||||