Template:Gbstorylink: Difference between revisions

From MediaWiki
Jump to navigationJump to search
Tigerpaw28 (talk | contribs)
Automated documentation update
Tigerpaw28 (talk | contribs)
Manual documentation cleanup
Line 1: Line 1:
<noinclude>__NOTOC__
<noinclude>__NOTOC__
==Description==
==Description==
This template is intended for use in fiction sections, allowing for cross-references to the source of the history being discussed, without needing to break the flow of the story or use footnotes.
This template is intended for use in fiction sections, allowing for cross-references to the source of the history being discussed, without needing to break the flow of the story or use footnotes. This template creates an external link to a story article on our sister wiki {{gb|Main Page|GoBots Wiki}}. To create a storylink to our ''other'' sister wiki, use [[Template:Istorylink]]. Or, to create a storylink for {{SITENAME}}, use [[Template:Storylink]]. 


In non-fiction sections, it's better to refer to the work of fiction normally, e.g., "The last appearance of Bumblebee's Pretender shell is in the comic '[[Dark Creation]]'."
In non-fiction sections, it's better to refer to the work of fiction normally, e.g., "The last appearance of Bumblebee's Pretender shell is in the comic '[[Dark Creation]]'."
This template accepts two arguments, the first should be the article being linked to, and the second is an optional description which will appear as the link text. If the second argument is omitted, the text of the link will default to the name of the article being referenced.
:<tt><nowiki>{{Gbstorylink|King of the Hill|Marvel US #27}}</nowiki></tt>
:<tt><nowiki>{{Gbstorylink|King of the Hill}}</nowiki></tt>
These examples are rendered in the dummy text below, in the same order:
:<div style="background:#ececec">Lorem ipsum dolor sit amet {{Gbstorylink|King of the Hill!|Marvel US #27}}, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. {{Gbstorylink|King of the Hill!}}</div>
==Usage==
==Usage==
===Parameters===
===Parameters===
====Required====
====Required====
This template takes one required anonymous parameter.
This template takes one required anonymous parameter.
# The title of the story article to link to.
====Optional====
====Optional====
This template takes one optional anonymous parameter.
This template takes one optional anonymous parameter.
 
<ol>
<li value="2">The custom text to use for the link</li>
</ol>
===Code===
===Code===
<pre>
<pre>
Line 28: Line 22:
</pre>
</pre>
==Examples==
==Examples==
{{note|The below example includes fake [[w:Lorem ipsum|Lorem ipsum]] text for the purpose of showing the template in the flow of a paragraph.}}
===Code===
===Code===
<pre>
<pre>
{{Gbstorylink
Lorem ipsum dolor sit amet {{Gbstorylink|King of the Hill!|Marvel US #27}}, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|param2
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. {{Gbstorylink|King of the Hill!}}</pre>
|param1
 
}}
</pre>
===Result===
===Result===
{{Gbstorylink
Lorem ipsum dolor sit amet {{Gbstorylink|King of the Hill!|Marvel US #27}}, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|param2
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. {{Gbstorylink|King of the Hill!}}
|param1
}}


[[Category:Fiction section templates]]
[[Category:Fiction section templates]]
</noinclude>
</noinclude>
<includeonly><span class="tt1_istorylink">[[gbwiki:{{{1}}}|{{{2|{{{1}}}}}}]]</span></includeonly>
<includeonly><span class="tt1_istorylink">[[gbwiki:{{{1}}}|{{{2|{{{1}}}}}}]]</span></includeonly>

Revision as of 03:31, 19 June 2022

Description

This template is intended for use in fiction sections, allowing for cross-references to the source of the history being discussed, without needing to break the flow of the story or use footnotes. This template creates an external link to a story article on our sister wiki GoBots Wiki. To create a storylink to our other sister wiki, use Template:Istorylink. Or, to create a storylink for MediaWiki, use Template:Storylink.

In non-fiction sections, it's better to refer to the work of fiction normally, e.g., "The last appearance of Bumblebee's Pretender shell is in the comic 'Dark Creation'."

Usage

Parameters

Required

This template takes one required anonymous parameter.

  1. The title of the story article to link to.

Optional

This template takes one optional anonymous parameter.

  1. The custom text to use for the link

Code

{{Gbstorylink
|param2
|param1
}}

Examples

The below example includes fake Lorem ipsum text for the purpose of showing the template in the flow of a paragraph.

Code

Lorem ipsum dolor sit amet {{Gbstorylink|King of the Hill!|Marvel US #27}}, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. {{Gbstorylink|King of the Hill!}}

Result

Lorem ipsum dolor sit amet Marvel US #27, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. King of the Hill!