Difference between revisions of "Template:Disambiguation"

From Battlestar Wiki, the free, open content Battlestar Galactica encyclopedia and episode guide
(tweak)
(+ templatedata stuff and minor change in examples for grammar)
Line 15: Line 15:
 
=== Alternate Usage ===
 
=== Alternate Usage ===
  
<pre>{{disambiguation|Galactica|on ships sharing this name}}</pre>
+
<pre>{{disambiguation|Galactica|ships sharing this name}}</pre>
  
 
This will produce:
 
This will produce:
  
{{disambiguation|Galactica|on ships sharing this name}}
+
{{disambiguation|Galactica|ships sharing this name}}
  
 
=== Alternate Usage #2 ===
 
=== Alternate Usage #2 ===
  
<pre>{{disambiguation|Galactica|on ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}</pre>
+
<pre>{{disambiguation|Galactica|ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}</pre>
  
 
This will produce:
 
This will produce:
Line 29: Line 29:
 
{{disambiguation|Galactica|on ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}
 
{{disambiguation|Galactica|on ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}
  
[[Category: Sidebar Templates|Disambiguation]]</noinclude>
+
[[Category: Sidebar Templates|Disambiguation]]
 +
 
 +
<templatedata>
 +
{
 +
    "description": "This template is used to set a default format for initial page notices that link TO disambiguation pages.",
 +
    "params": {
 +
        "1": {
 +
            "label": "Article Title",
 +
            "description": "This is the article that the disambiguation note will link to.",
 +
            "required": true,
 +
            "type": "string"
 +
        },
 +
        "2": {
 +
            "label": "Description",
 +
            "description": "This is a short description to fit into the sentence, e.g. 'For [description], see: subject.' Otherwise, it will default to: 'For subjects with a similar name, see: subject.'",
 +
            "type": "string"
 +
        },
 +
        "3": {
 +
            "label": "Preamble",
 +
            "description": "This is an introduction sentence or two that goes BEFORE the 'For [description], see: subject.'",
 +
            "type": "string"
 +
        }
 +
    }
 +
}
 +
</templatedata>
 +
</noinclude>

Revision as of 02:30, 18 October 2021

Description

This template is used to set a default format for initial page notices that link to disambiguation pages (e.g. Baltar (TOS), Galactica (TOS), Adama (TOS)) from an article linked to the said disambiguation page (e.g. Baltar, Galactica, Adama).

Using this template will add a line to the page, noting that a disambiguation page is available.

Usage

{{disambiguation|Adama}}

This will produce:

For subjects with a similar name, see: Adama.

Alternate Usage

{{disambiguation|Galactica|ships sharing this name}}

This will produce:

For ships sharing this name, see: Galactica.

Alternate Usage #2

{{disambiguation|Galactica|ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}

This will produce:

This article discusses the ship from the Re-imagined Series. For on ships sharing this name, see: Galactica.

This template is used to set a default format for initial page notices that link TO disambiguation pages.

Template parameters

ParameterDescriptionTypeStatus
Article Title1

This is the article that the disambiguation note will link to.

Stringrequired
Description2

This is a short description to fit into the sentence, e.g. 'For [description], see: subject.' Otherwise, it will default to: 'For subjects with a similar name, see: subject.'

Stringoptional
Preamble3

This is an introduction sentence or two that goes BEFORE the 'For [description], see: subject.'

Stringoptional