Difference between revisions of "Template:For outline/doc"

From blackwiki
Jump to navigation Jump to search
imported>SMcCandlish
m (this is not always used as a hatnote)
imported>SMcCandlish
(re-doc)
Line 2: Line 2:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
{{for|the information page|Wikipedia:Outlines}}
 
{{for|the information page|Wikipedia:Outlines}}
This template creates a [[WP:HATNOTE|hatnote]] which points a user to the corresponding outline article.
+
This template creates a cross-reference which points a user to the corresponding [[WP:Outline|outline]] article.
  
=== Usage ===
+
== Usage ==
  
Add the following to the very top of the article:
+
Basic usage:
  
<pre><nowiki>{{outline}}</nowiki></pre>
+
{{in5}}{{tlx|outline}}
  
This will create a hatnote like the following:
+
This will create an indented and italicized cross-reference like the following:
  
:''For a topical guide to this subject, see [[Outline of the Cayman Islands]].
+
{{in5}}''For a topical guide to this subject, see [[Outline of the Cayman Islands]].
  
 +
The template should automatically detect the correct title of the outline article (check the link to be sure). If the template doesn't detect the correct outline name automatically, then add it in manually like this:
  
The template should automatically detect the correct title of the outline article. If the template doesn't create the correct outline name automatically, then add it in manually like this:
+
{{in5}}{{tlx|outline|{{var|Title of outline article}}}}
  
<pre><nowiki>{{outline|outline article}}</nowiki></pre>
+
Don't [[WP:Link|wikilink]] the parameter; the template will do this for you.
  
Don't [[WP:LINK|wikilink]] the parameter.
+
=== Placement ===
 +
Sometimes used as a [[WP:Hatnote|hatnote]] at the top of an article or section, the template can (like {{tl|More2}}, {{tl|Further information}}, {{tl|Detail}}, etc.) also be used below a narrative section, or below a list in some other format.
  
=== See also ===
+
== See also ==
* {{tl|main}}
+
* {{tl|See glossary}} – similar pointer to a [[MOS:GLOSSARY|glossary]] article or section on the topic
* {{tl|main list}}
+
* {{tl|See index}} – similar pointer to a [[WP:Indexes|index]] article on the topic
 +
* {{tl|See timeline}} – similar pointer to a [[WP:Timeline|timeline]] article or section on the topic
 +
* {{tl|Main}} – pointer to the main article on a topic
 +
* {{tl|Main list}} – pointer to the main [[WP:Stand-alone list|{{em|list}} article]] on a topic (usually one for which there are multiple hierarchical or subtopical lists)
  
 
<includeonly>
 
<includeonly>
Line 29: Line 34:
 
[[Category:Disambiguation and redirection templates]]
 
[[Category:Disambiguation and redirection templates]]
 
[[Category:Cross-reference templates]]
 
[[Category:Cross-reference templates]]
 +
[[Category:Hatnote templates for lists]]
 
[[Category:WikiProject Outlines templates]]
 
[[Category:WikiProject Outlines templates]]
 
</includeonly>
 
</includeonly>

Revision as of 09:46, 22 June 2016

This template creates a cross-reference which points a user to the corresponding outline article.

Usage

Basic usage:

     {{outline}}

This will create an indented and italicized cross-reference like the following:

     For a topical guide to this subject, see Outline of the Cayman Islands.

The template should automatically detect the correct title of the outline article (check the link to be sure). If the template doesn't detect the correct outline name automatically, then add it in manually like this:

     {{outline|Title of outline article}}

Don't wikilink the parameter; the template will do this for you.

Placement

Sometimes used as a hatnote at the top of an article or section, the template can (like {{More2}}, {{Further information}}, {{Detail}}, etc.) also be used below a narrative section, or below a list in some other format.

See also

  • {{See glossary}} – similar pointer to a glossary article or section on the topic
  • {{See index}} – similar pointer to a index article on the topic
  • {{See timeline}} – similar pointer to a timeline article or section on the topic
  • {{Main}} – pointer to the main article on a topic
  • {{Main list}} – pointer to the main list article on a topic (usually one for which there are multiple hierarchical or subtopical lists)