Latest revision as of 02:49, 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 ships sharing this name, see: Galactica.

Template Data

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

Template parameters[Edit template data]
Parameter		Description	Type	Status
Article Title	`1`	This is the article that the disambiguation note will link to.	Page name	required
Description	`2`	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.'	String	optional
Preamble	`3`	This is an introduction sentence or two that goes BEFORE the 'For [description], see: subject.'	String	optional

@@ Line 1: / Line 1: @@
-<includeonly>
+<includeonly>:<span class="noexcerpt">''{{{3|}}} For {{#if:{{{2}}}|{{void}}|other entries&nbsp;}}{{{2|subjects with a similar name}}}, see: [[{{{1|}}}]].''</span></includeonly><noinclude>= Description =
-<pagesidebar>
-* Disambiguation
-** {{{1}}}|Other articles with the same name
-</pagesidebar></includeonly><noinclude>= Description =
-This template is used to set a default format for page sidebars 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]]).
+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 page sidebar, as seen on this page for Medic [[Hudson]].
+Using this template will add a line to the page, noting that a disambiguation page is available.
-'''Usage note:''' Because this template will break under normal circumstances, this template must always be employed using template substitution, as the following instructions indicate.
+== Usage ==
+<pre>{{disambiguation|Adama}}</pre>
+This will produce:
+{{disambiguation|Adama}}
+=== Alternate Usage ===
+<pre>{{disambiguation|Galactica|ships sharing this name}}</pre>
+This will produce:
+{{disambiguation|Galactica|ships sharing this name}}
+=== Alternate Usage #2 ===
+<pre>{{disambiguation|Galactica|ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}</pre>
-{{TemplateSubst}}
+This will produce:
-== Usage ==
+{{disambiguation|Galactica|ships sharing this name|This article discusses the ship from the [[Re-imagined Series]].}}
+[[Category: Sidebar Templates|Disambiguation]]
-<pre>{{subst:disambiguation|disambiguation page}}</pre>
+== Template Data ==
-[[Category: Templates|Disambiguation]]</noinclude>
+<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": "wiki-page-name"
+        },
+        "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>