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

From blackwiki
Jump to navigation Jump to search
imported>Yobot
m (→‎See also: WP:CHECKWIKI error 22 fixes (category with space) + general fixes (BRFA 16) using AWB (7799))
imported>John of Reading
m (→‎See also: Typo fixing, replaced: an timeline → a timeline)
 
(17 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{lua|Module:For related page}}
 +
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 +
{{for|the information page|Wikipedia:Outlines}}
 +
This template creates a cross-reference which points readers to the corresponding [[WP:Outline|outline]] article.
  
This template creates a [[WP:HATNOTE|hatnote]] which points a user to the corresponding outline article.
+
== Usage ==
  
=== Usage ===
+
Basic usage:
  
Add the following to the very top of the article:
+
{{in5}}{{tlx|{{BASEPAGENAME}}}}
  
<pre><nowiki>{{outline}}</nowiki></pre>
+
This will create an indented and italicized cross-reference like the following:
  
This will create a hatnote like the following:
+
{{in5}}''For a topical guide to this subject, see [[Outline of the Cayman Islands]].''
  
:''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, as long as it has been named in one of the more common patterns for such articles (check the link to be sure it worked). If the template doesn't detect the correct name automatically, then add it in manually like this:
  
 +
{{in5}}{{tlx|{{BASEPAGENAME}}|{{var|Title of outline article}}}}
  
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:
+
Don't [[WP:Link|wikilink]] the parameter; the template will do this for you.
  
<pre><nowiki>{{outline|outline article}}</nowiki></pre>
+
=== Placement ===
 +
Sometimes used as a [[WP:Hatnote|hatnote]] at the top of an article or section, the template can (like {{tl|Further information}}, {{tl|Detail}}, etc.) also be used below a narrative section, or below a list in some other format.
  
Don't [[WP:LINK|wikilink]] the parameter.
+
== See also ==
 +
* {{tl|For glossary}} – similar pointer to a [[MOS:GLOSSARY|glossary]] article or section on the topic
 +
* {{tl|For 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)
  
=== See also ===
+
<includeonly>{{sandbox other||
* {{tl|main}}
+
<!-- Categories below this line, please; interwikis at Wikidata -->
* {{tl|mainlist}}
 
 
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
 
[[Category:Disambiguation and redirection templates]]
 
[[Category:Disambiguation and redirection templates]]
</includeonly>
+
[[Category:Cross-reference templates]]
 +
[[Category:Hatnote templates for lists]]
 +
[[Category:WikiProject Outlines templates]]
 +
}}</includeonly>

Latest revision as of 14:56, 23 February 2019

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

Usage

Basic usage:

     {{For 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, as long as it has been named in one of the more common patterns for such articles (check the link to be sure it worked). If the template doesn't detect the correct name automatically, then add it in manually like this:

     {{For 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 {{Further information}}, {{Detail}}, etc.) also be used below a narrative section, or below a list in some other format.

See also

  • {{For glossary}} – similar pointer to a glossary article or section on the topic
  • {{For 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)