Template:Qotw topic/doc: Difference between revisions
(saving at intermediate stage) |
m (Protected "Template:Qotw topic/doc": Robot: Protecting all pages from category templates ([edit=sysop] (indefinite) [move=sysop] (indefinite))) |
||
(8 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
'''{{tl|qotw}}''' is for the easy placement of topics on the page, | '''{{tl|qotw}}''' is for the easy placement of topics on the page, Quote of the Week nominations. This template reduces the burden of entering a new topic to a few keystrokes — instead of cutting, pasting and altering each individual topic. | ||
==Variables== | == Variables == | ||
The following variables are recognized by the template: | The following variables are recognized by the template: | ||
<pre width="60"> | <pre width="60"> | ||
AUTO-LINKING VARIABLES | AUTO-LINKING VARIABLES | ||
(if disambiguated, we want the disambiguation showing | |||
for clarity) | |||
person = topic is person | person = topic is person | ||
story = topic is story | story = topic is story | ||
NON-LINKING VARIABLES | NON-LINKING VARIABLES | ||
thing = topic is something other than a person or story. | |||
more = something allowed with all of the above | (Not linked, because pluralisation often | ||
grammatically desirable.) | |||
more = something allowed with all of the above variables | |||
(it lets you tag a bit more info onto a | (it lets you tag a bit more info onto a | ||
message for clarification) | message for clarification) | ||
Line 17: | Line 21: | ||
</pre> | </pre> | ||
==Usage== | == Usage == | ||
The basic usage for this template is: | The basic usage for this template is: | ||
<pre width=60> | <pre width=60> | ||
Line 25: | Line 29: | ||
</pre> | </pre> | ||
Let's now go through the various messages displayed when the above variables are employed. | Let's now go through the various messages displayed when the above variables are employed. | ||
===Thing=== | === Person === | ||
If you type: | |||
<pre width=60> | |||
{{qotw|person=Calcula}} | |||
</pre> | |||
You'll get: | |||
{{qotw|person=Calcula}} | |||
=== Story === | |||
If you type: | |||
<pre width=60> | |||
{{qotw|story=The End of Time (TV story)}} | |||
</pre> | |||
You'll get: | |||
{{qotw|story=The End of Time (TV story)}} | |||
Note here that we'd want the disambiguation showing, because it makes it crystal clear that we're talking about the [[David Tennant]] swansong, and not a book in [[The Darksmith Legacy]] series. | |||
=== Thing === | |||
If you type: | |||
<pre width=60> | |||
{{qotw|thing=[[hospital]]s}} | |||
</pre> | |||
You'll get: | |||
{{qotw|thing=[[hospital]]s}} | |||
=== More === | |||
Let's say that you wanted to be a bit more specific. Then you would use: | |||
<pre width=60> | |||
{{qotw|thing=[[hospital]]s|more=Your quote must involve the opinion of a [[nurse]].}} | |||
</pre> | |||
{{qotw|thing=[[hospital]]s|more=Your quote must involve the opinion of a [[nurse]].}} | |||
'''More''' can be used with any of the message types, except for '''freeform'''. | |||
=== Freeform === | |||
The freeform variable is for when you can't express your topic in terms of one of the above messages. Its usage would be fairly rare, because you can add the '''more''' variable to any of the above messages to improve their flexibility. However, when you just can't make your topic fit the above molds, this is your variable. Note that a '''freeform''' message doesn't accept the '''more''' variable, and that it automatically includes the "valid sources" line. | |||
If you type: | |||
<pre width=60> | |||
{{qotw|freeform=I honestly can't think of a time you'd ''need'' to use it, but it's here if you want it.}} | |||
</pre> | |||
You'll get: | |||
{{qotw|freeform=I honestly can't think of a time you'd ''need'' to use it, but it's here if you want it.}} | |||
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude> |
Latest revision as of 02:08, 13 May 2013
{{qotw}} is for the easy placement of topics on the page, Quote of the Week nominations. This template reduces the burden of entering a new topic to a few keystrokes — instead of cutting, pasting and altering each individual topic.
Variables
The following variables are recognized by the template:
AUTO-LINKING VARIABLES (if disambiguated, we want the disambiguation showing for clarity) person = topic is person story = topic is story NON-LINKING VARIABLES thing = topic is something other than a person or story. (Not linked, because pluralisation often grammatically desirable.) more = something allowed with all of the above variables (it lets you tag a bit more info onto a message for clarification) freeform = allows totally freeform message
Usage
The basic usage for this template is:
{{qotw|variable=text}} or, if addendum is required {{qotw|variable=text|more=text}}
Let's now go through the various messages displayed when the above variables are employed.
Person
If you type:
{{qotw|person=Calcula}}
You'll get:
- The Grandfather: You’re a romantic, my dear. Mostly these humans are thoughtless and savage, with outmoded ideas about practically everything. Yet, they may merit further study. I marvel that they have survived as a species to reach into space.
- The Granddaughter: Because they dream. Perhaps one day the Ship will take us to their home. To Earth.
- The Grandfather: Who knows . . . Susan.
Story
If you type:
{{qotw|story=The End of Time (TV story)}}
You'll get:
- The Grandfather: You’re a romantic, my dear. Mostly these humans are thoughtless and savage, with outmoded ideas about practically everything. Yet, they may merit further study. I marvel that they have survived as a species to reach into space.
- The Granddaughter: Because they dream. Perhaps one day the Ship will take us to their home. To Earth.
- The Grandfather: Who knows . . . Susan.
Note here that we'd want the disambiguation showing, because it makes it crystal clear that we're talking about the David Tennant swansong, and not a book in The Darksmith Legacy series.
Thing
If you type:
{{qotw|thing=[[hospital]]s}}
You'll get:
- The Grandfather: You’re a romantic, my dear. Mostly these humans are thoughtless and savage, with outmoded ideas about practically everything. Yet, they may merit further study. I marvel that they have survived as a species to reach into space.
- The Granddaughter: Because they dream. Perhaps one day the Ship will take us to their home. To Earth.
- The Grandfather: Who knows . . . Susan.
More
Let's say that you wanted to be a bit more specific. Then you would use:
{{qotw|thing=[[hospital]]s|more=Your quote must involve the opinion of a [[nurse]].}}
- The Grandfather: You’re a romantic, my dear. Mostly these humans are thoughtless and savage, with outmoded ideas about practically everything. Yet, they may merit further study. I marvel that they have survived as a species to reach into space.
- The Granddaughter: Because they dream. Perhaps one day the Ship will take us to their home. To Earth.
- The Grandfather: Who knows . . . Susan.
More can be used with any of the message types, except for freeform.
Freeform
The freeform variable is for when you can't express your topic in terms of one of the above messages. Its usage would be fairly rare, because you can add the more variable to any of the above messages to improve their flexibility. However, when you just can't make your topic fit the above molds, this is your variable. Note that a freeform message doesn't accept the more variable, and that it automatically includes the "valid sources" line. If you type:
{{qotw|freeform=I honestly can't think of a time you'd ''need'' to use it, but it's here if you want it.}}
You'll get:
- The Grandfather: You’re a romantic, my dear. Mostly these humans are thoughtless and savage, with outmoded ideas about practically everything. Yet, they may merit further study. I marvel that they have survived as a species to reach into space.
- The Granddaughter: Because they dream. Perhaps one day the Ship will take us to their home. To Earth.
- The Grandfather: Who knows . . . Susan.