Template:SimRef: Difference between revisions

From 118Wiki
Jump to navigation Jump to search
(Created page with " {{#tag:ref [{{{SIMLINK}}} ''"{{{SIMNAME}}}"''], {{{CHARACTERS}}}, {{{SHIP}}}, SD {{{STARDATE}}} | name="{{{SIMNAME}}}" }}")
 
(Add heading for template data)
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#tag:ref [{{{SIMLINK}}} ''"{{{SIMNAME}}}"''], {{{CHARACTERS}}}, {{{SHIP}}}, SD {{{STARDATE}}} | name="{{{SIMNAME}}}" }}
<includeonly>{{#tag:ref |
  {{#if: {{{SIMLINK|}}}
    | [{{{SIMLINK}}} ''"{{{SIMTITLE}}}"'']  
    | ''"{{{SIMTITLE}}}"''
  }}{{#if: {{{CHARACTERS|}}}
    |, {{{CHARACTERS}}}
    |
  }}{{#if: {{{SHIP|}}}
    |, {{{SHIP}}}
    |
  }}{{#if: {{{STARDATE|}}}
    |, SD{{{STARDATE}}}
    |
  }} | name="{{#if: {{{REFNAME|}}}
    |{{{REFNAME}}}
    |{{{SIMTITLE}}}
  }}" }}</includeonly><noinclude>
==Usage==
Creates a standardised wiki reference tag ("<ref>") to your sim.
 
<pre>
{{SimRef | SIMLINK=<URL to your sim> | CHARACTERS=<the character name(s)> | SIMTITLE=<title of the sim> | SHIP=<the name of the ship or installation> | STARDATE=<relevant stardate for the sim> | REFNAME=<name for the reference>}}
</pre>
 
The <ref> tag will be named using the title of the sim, unless you specify a value for the REFNAME parameter.  That allows you to make multiple attributions to the same reference in one wiki page ([[#Multiple attributions to the same sim reference|see example below]]).
 
 
Parameters:
* '''SIMLINK''': The URL of your sim.  This can be a link to a google group post, or a sim wiki page.  This parameter is optional.
* '''CHARACTERS''': The name or names of the relevant characters that the sim is about, i.e. the character names used in the title of the sim post.  This parameter is optional.
* '''SIMTITLE''': The title of the sim.  This parameter is expected.
* '''SHIP''': The ship or installation that the character is from, or the sim relates to.  This parameter is optional.
* '''STARDATE''': The relevant stardate for the sim. This parameter is optional.
* '''REFNAME''': A shorthand name for the ref tag. This parameter is optional.  If not specified, SIMTITLE is used for the name of the ref.
 
== Examples ==
Following are examples of how to use this template in your own pages.  The result of the examples are shown in the [[#References|References]] section below.
 
 
=== Reference to a sim without a ref name ===
An example of every template parameter being used (except for REFNAME).  The title of the sim specified in the SIMTITLE parameter is used for the name of the reference.
<pre>
Perfect for analysts, officers, and administrative personnel alike{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/VddlJAiFJ2I/m/yADaiqlHDwAJ | CHARACTERS=Crewman [[Annamae Barberra]] | SIMTITLE=Emissary in Leather  | SHIP=[[Amity Outpost]] | STARDATE=239905.07}}.
</pre>
Perfect for analysts, officers, and administrative personnel alike{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/VddlJAiFJ2I/m/yADaiqlHDwAJ | CHARACTERS=Crewman [[Annamae Barberra]] | SIMTITLE=Emissary in Leather | SHIP=[[Amity Outpost]] | STARDATE=239905.07}}.
 
 
=== A complete reference to a sim===
An example of every template parameter being used, including REFNAME.  The name of the reference will be the value specified for this parameter.  This is useful if the title if the sim is long and/or complicated, and you want to reference the same sim again in the same wiki page ([[#Multiple attributions to the same sim reference|see example below]]).
<pre>
The anomaly caused some crew to experience vivid visions{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/9SKm1FcrUFA/m/1onwX5dhAgAJ | CHARACTERS=Ensign Finsen | SIMTITLE=The sim where Ensign Finsen has experiences a second vision, and it's almost as ghastly as the first one but really they are just as bad as each other | SHIP=[[Amity Outpost]] | STARDATE=239906.17 | REFNAME="SecondVision"}}.
</pre>
The anomaly caused some crew to experience vivid visions{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/9SKm1FcrUFA/m/1onwX5dhAgAJ | CHARACTERS=Ensign Finsen | SIMTITLE=The sim where Ensign Finsen has experiences a second vision, and it's almost as ghastly as the first one but really they are just as bad as each other | SHIP=[[Amity Outpost]] | STARDATE=239906.17 | REFNAME="SecondVision"}}.
 
=== Sim with No URL ===
A reference to a sim that doesn't have a corresponding link.
<pre>
The Captain wasted no time and put the ship at red alert{{SimRef | CHARACTERS=Lt Cmdr Anna Jones | SIMTITLE=Red Alert! | SHIP=[[Amity Outpost]] | STARDATE=239905.07}}.
</pre>
The Captain wasted no time and put the ship at red alert{{SimRef | CHARACTERS=Lt Cmdr Anna Jones | SIMTITLE=Red Alert! | SHIP=[[Amity Outpost]] | STARDATE=239905.07}}.
 
 
=== Sim with no ship or installation ===
A reference to a sim that doesn't have a relevant ship or installation.
<pre>
In 2397 Keehani lodged a petition with the [[Reconciliation Forums of Betazed]] for the "rightful re-establishment of Vaxa Ral, formerly Vaxa Ukinix, as matriarch of the Ninth House of Betazed"{{SimRef | SIMLINK=https://groups.google.com/g/sb118-veritas/c/wOtTM9DQop8/m/374wE2WMCgAJ | CHARACTERS=Esion Akoibo and Nivoxi Unaa | SIMTITLE=Gossip | STARDATE=239707.22}}.
</pre>
 
In 2397 Keehani lodged a petition with the [[Reconciliation Forums of Betazed]] for the "rightful re-establishment of Vaxa Ral, formerly Vaxa Ukinix, as matriarch of the Ninth House of Betazed"{{SimRef | SIMLINK=https://groups.google.com/g/sb118-veritas/c/wOtTM9DQop8/m/374wE2WMCgAJ | CHARACTERS=Esion Akoibo and Nivoxi Unaa | SIMTITLE=Gossip | STARDATE=239707.22}}.
 
 
=== Sim with No Stardate ===
A reference to a sim without specifying a stardate.
<pre>
The sleek trains have either a purple or blue line that run along the full length of them to indicate which service they are for{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/kD7Yp6VcLpc/m/UrQKrGRKAQAJ | CHARACTERS=Ambassador [[Rivi Vataix]]| SIMTITLE=CO to CO train ride | SHIP=[[Amity Outpost]] }}.
</pre>
The sleek trains have either a purple or blue line that run along the full length of them to indicate which service they are for{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/kD7Yp6VcLpc/m/UrQKrGRKAQAJ | CHARACTERS=Ambassador [[Rivi Vataix]]| SIMTITLE=CO to CO train ride | SHIP=[[Amity Outpost]] }}.
 
== Multiple attributions to the same sim reference ==
 
=== Referencing Using Sim Title ===
Any reference using the SimRef template will be named using the value in the SIMTITLE parameter (if a value for the REFNAME parameter is not specified). This allows you to make multiple attributions to the same sim in a single wiki page without having to repeat it, by using the built in "ref" tag, i.e:
<pre>
<ref name="Title of Sim />"
</pre>
Example:
<pre>
Contains Washington DC cherry blossom trees (which were originally gifted to Washington DC from Japan centuries earlier) that winds along the path{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/VCyhosHMalk/m/uvoKnmGlAgAJ | CHARACTERS=Lt Cmdr [[Wil Ukinix]] | SIMTITLE=Last Train To Trancentral  | SHIP=[[Amity Outpost]] | STARDATE=SD239904.24}}.
 
Each section of the Outpost has a train stop. Holographic sign(s) above each station show either a blue number under the words “Amity Line”, or a purple number under the words “Upper Terminals Line” to indicate how many minutes away each train is from arriving<ref name="Last Train To Trancentral" />.
 
</pre>
Contains Washington DC cherry blossom trees (which were originally gifted to Washington DC from Japan centuries earlier) that winds along the path{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/VCyhosHMalk/m/uvoKnmGlAgAJ | CHARACTERS=Lt Cmdr [[Wil Ukinix]] | SIMTITLE=Last Train To Trancentral | SHIP=[[Amity Outpost]] | STARDATE=239904.24}}.
 
Each section of the Outpost has a train stop. Holographic sign(s) above each station show either a blue number under the words “Amity Line”, or a purple number under the words “Upper Terminals Line” to indicate how many minutes away each train is from arriving<ref name="Last Train To Trancentral" />.
 
=== Referencing Using REFNAME parameter ===
For sims with long/complicated sim titles, you can instead reference a sim by using the REFNAME parameter.
 
Example:
<pre>
Pek’al was the Chief Engineer on the [[USS Kitty Hawk]]{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/zEsHqOCPm4E/m/YNkOEfWiDgAJ | CHARACTERS=Ensign Finsen | SIMTITLE=The sim where Ensign Finsen wants to meet Kivik's new music playing friend and go aboard Amity and trains are so exciting! | SHIP=[[Amity Outpost]] | STARDATE=SD239905.05 | REFNAME=AmityTrains }}.
 
The view of the purple nebula is visible out of the glass roof of the mezzanine<ref name="AmityTrains" />.
</pre>
Pek’al was the Chief Engineer on the [[USS Kitty Hawk]]{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/zEsHqOCPm4E/m/YNkOEfWiDgAJ | CHARACTERS=Ensign Finsen | SIMTITLE=The sim where Ensign Finsen wants to meet Kivik's new music playing friend and go aboard Amity and trains are so exciting! | SHIP=[[Amity Outpost]] | STARDATE=SD239905.05 | REFNAME=AmityTrains }}.
 
The view of the purple nebula is visible out of the glass roof of the mezzanine<ref name="AmityTrains" />.
 
 
{{References}}
 
[[Category:Templates]]
 
==Template Data==
<templatedata>
{
"params": {
"SIMLINK": {
"description": "The URL of your sim. This can be a link to a google group post, or a sim wiki page. This parameter is optional."
},
"SIMTITLE": {
"description": "The title of the sim. This parameter is expected.",
"required": true
},
"CHARACTERS": {
"description": "The name or names of the relevant characters that the sim is about, i.e. the character names used in the title of the sim post. This parameter is optional."
},
"SHIP": {
"description": "The ship or installation that the character is from, or the sim relates to. This parameter is optional."
},
"STARDATE": {
"description": "The relevant stardate for the sim. This parameter is optional."
},
"REFNAME": {
"description": " A shorthand name for the ref tag. This parameter is optional. If not specified, the value of SIMTITLE is used for the name of the ref."
}
},
"description": "Creates a standardised wiki reference tag (\"<ref>\") to your sim.\n\nThe <ref> tag will be named using the title of the sim, unless you specify a value for the REFNAME parameter. That allows you to make multiple attributions to the same reference in one wiki page.\n\nSee the SimRef template's page for detailed examples."
}
</templatedata></noinclude>

Latest revision as of 03:42, 17 January 2023

Usage

Creates a standardised wiki reference tag ("<ref>") to your sim. 

{{SimRef | SIMLINK=<URL to your sim> | CHARACTERS=<the character name(s)> | SIMTITLE=<title of the sim> | SHIP=<the name of the ship or installation> | STARDATE=<relevant stardate for the sim> | REFNAME=<name for the reference>}}

The <ref> tag will be named using the title of the sim, unless you specify a value for the REFNAME parameter. That allows you to make multiple attributions to the same reference in one wiki page (see example below).


Parameters:

  • SIMLINK: The URL of your sim. This can be a link to a google group post, or a sim wiki page. This parameter is optional.
  • CHARACTERS: The name or names of the relevant characters that the sim is about, i.e. the character names used in the title of the sim post. This parameter is optional.
  • SIMTITLE: The title of the sim. This parameter is expected.
  • SHIP: The ship or installation that the character is from, or the sim relates to. This parameter is optional.
  • STARDATE: The relevant stardate for the sim. This parameter is optional.
  • REFNAME: A shorthand name for the ref tag. This parameter is optional. If not specified, SIMTITLE is used for the name of the ref.

Examples

Following are examples of how to use this template in your own pages. The result of the examples are shown in the References section below.


Reference to a sim without a ref name

An example of every template parameter being used (except for REFNAME). The title of the sim specified in the SIMTITLE parameter is used for the name of the reference. 

Perfect for analysts, officers, and administrative personnel alike{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/VddlJAiFJ2I/m/yADaiqlHDwAJ | CHARACTERS=Crewman [[Annamae Barberra]] | SIMTITLE=Emissary in Leather  | SHIP=[[Amity Outpost]] | STARDATE=239905.07}}.

Perfect for analysts, officers, and administrative personnel alike[1].


A complete reference to a sim

An example of every template parameter being used, including REFNAME. The name of the reference will be the value specified for this parameter. This is useful if the title if the sim is long and/or complicated, and you want to reference the same sim again in the same wiki page (see example below). 

The anomaly caused some crew to experience vivid visions{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/9SKm1FcrUFA/m/1onwX5dhAgAJ | CHARACTERS=Ensign Finsen | SIMTITLE=The sim where Ensign Finsen has experiences a second vision, and it's almost as ghastly as the first one but really they are just as bad as each other | SHIP=[[Amity Outpost]] | STARDATE=239906.17 | REFNAME="SecondVision"}}.

The anomaly caused some crew to experience vivid visions[2].

Sim with No URL

A reference to a sim that doesn't have a corresponding link. 

The Captain wasted no time and put the ship at red alert{{SimRef | CHARACTERS=Lt Cmdr Anna Jones | SIMTITLE=Red Alert! | SHIP=[[Amity Outpost]] | STARDATE=239905.07}}.

The Captain wasted no time and put the ship at red alert[3].


Sim with no ship or installation

A reference to a sim that doesn't have a relevant ship or installation. 

In 2397 Keehani lodged a petition with the [[Reconciliation Forums of Betazed]] for the "rightful re-establishment of Vaxa Ral, formerly Vaxa Ukinix, as matriarch of the Ninth House of Betazed"{{SimRef | SIMLINK=https://groups.google.com/g/sb118-veritas/c/wOtTM9DQop8/m/374wE2WMCgAJ | CHARACTERS=Esion Akoibo and Nivoxi Unaa | SIMTITLE=Gossip | STARDATE=239707.22}}.

In 2397 Keehani lodged a petition with the Reconciliation Forums of Betazed for the "rightful re-establishment of Vaxa Ral, formerly Vaxa Ukinix, as matriarch of the Ninth House of Betazed"[4].


Sim with No Stardate

A reference to a sim without specifying a stardate. 

The sleek trains have either a purple or blue line that run along the full length of them to indicate which service they are for{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/kD7Yp6VcLpc/m/UrQKrGRKAQAJ | CHARACTERS=Ambassador [[Rivi Vataix]]| SIMTITLE=CO to CO train ride | SHIP=[[Amity Outpost]] }}.

The sleek trains have either a purple or blue line that run along the full length of them to indicate which service they are for[5].

Multiple attributions to the same sim reference

Referencing Using Sim Title

Any reference using the SimRef template will be named using the value in the SIMTITLE parameter (if a value for the REFNAME parameter is not specified). This allows you to make multiple attributions to the same sim in a single wiki page without having to repeat it, by using the built in "ref" tag, i.e: 

<ref name="Title of Sim />"

Example: 

Contains Washington DC cherry blossom trees (which were originally gifted to Washington DC from Japan centuries earlier) that winds along the path{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/VCyhosHMalk/m/uvoKnmGlAgAJ | CHARACTERS=Lt Cmdr [[Wil Ukinix]] | SIMTITLE=Last Train To Trancentral  | SHIP=[[Amity Outpost]] | STARDATE=SD239904.24}}.

Each section of the Outpost has a train stop. Holographic sign(s) above each station show either a blue number under the words “Amity Line”, or a purple number under the words “Upper Terminals Line” to indicate how many minutes away each train is from arriving<ref name="Last Train To Trancentral" />.

Contains Washington DC cherry blossom trees (which were originally gifted to Washington DC from Japan centuries earlier) that winds along the path[6].

Each section of the Outpost has a train stop. Holographic sign(s) above each station show either a blue number under the words “Amity Line”, or a purple number under the words “Upper Terminals Line” to indicate how many minutes away each train is from arriving[6].

Referencing Using REFNAME parameter

For sims with long/complicated sim titles, you can instead reference a sim by using the REFNAME parameter.

Example: 

Pek’al was the Chief Engineer on the [[USS Kitty Hawk]]{{SimRef | SIMLINK=https://groups.google.com/g/sb118-amity/c/zEsHqOCPm4E/m/YNkOEfWiDgAJ | CHARACTERS=Ensign Finsen | SIMTITLE=The sim where Ensign Finsen wants to meet Kivik's new music playing friend and go aboard Amity and trains are so exciting! | SHIP=[[Amity Outpost]] | STARDATE=SD239905.05 | REFNAME=AmityTrains }}.

The view of the purple nebula is visible out of the glass roof of the mezzanine<ref name="AmityTrains" />.

Pek’al was the Chief Engineer on the USS Kitty Hawk[7].

The view of the purple nebula is visible out of the glass roof of the mezzanine[7].


References

  1. ↑ "Emissary in Leather", Crewman Annamae Barberra, Amity Outpost, SD239905.07
  2. ↑ "The sim where Ensign Finsen has experiences a second vision, and it's almost as ghastly as the first one but really they are just as bad as each other", Ensign Finsen, Amity Outpost, SD239906.17
  3. ↑ "Red Alert!", Lt Cmdr Anna Jones, Amity Outpost, SD239905.07
  4. ↑ "Gossip", Esion Akoibo and Nivoxi Unaa, SD239707.22
  5. ↑ "CO to CO train ride", Ambassador Rivi Vataix, Amity Outpost
  6. ↑ 6.0 6.1 "Last Train To Trancentral", Lt Cmdr Wil Ukinix, Amity Outpost, SD239904.24
  7. ↑ 7.0 7.1 "The sim where Ensign Finsen wants to meet Kivik's new music playing friend and go aboard Amity and trains are so exciting!", Ensign Finsen, Amity Outpost, SDSD239905.05

Template Data

Creates a standardised wiki reference tag ("<ref>") to your sim. The <ref> tag will be named using the title of the sim, unless you specify a value for the REFNAME parameter. That allows you to make multiple attributions to the same reference in one wiki page. See the SimRef template's page for detailed examples.

Template parameters

ParameterDescriptionTypeStatus
SIMLINKSIMLINK

The URL of your sim. This can be a link to a google group post, or a sim wiki page. This parameter is optional.

Unknownoptional
SIMTITLESIMTITLE

The title of the sim. This parameter is expected.

Unknownrequired
CHARACTERSCHARACTERS

The name or names of the relevant characters that the sim is about, i.e. the character names used in the title of the sim post. This parameter is optional.

Unknownoptional
SHIPSHIP

The ship or installation that the character is from, or the sim relates to. This parameter is optional.

Unknownoptional
STARDATESTARDATE

The relevant stardate for the sim. This parameter is optional.

Unknownoptional
REFNAMEREFNAME

A shorthand name for the ref tag. This parameter is optional. If not specified, the value of SIMTITLE is used for the name of the ref.

Unknownoptional
Retrieved from "https://wiki.starbase118.net/wiki/index.php?title=Template:SimRef&oldid=338592"