Template:Ac: Difference between revisions

From IFWiki

(+ instructions)
(→‎Arguments: try to condense instructions)
Line 6: Line 6:
Author commentary links that appear on a work page should go under the Spoilers heading in the Links section. When author commentary links appear on a competition page, they should go under an Author Commentary heading in the Links section, and preferably be put in order by author surname.
Author commentary links that appear on a work page should go under the Spoilers heading in the Links section. When author commentary links appear on a competition page, they should go under an Author Commentary heading in the Links section, and preferably be put in order by author surname.
<hr>
<hr>
===Arguments===
===Arguments:===
 
* '''url''': required. Should specify the url of the making-of article.
 
* '''link text''': optional. This is an unlabeled argument. If omitted, the link text will show up as Author Commentary, which may be enough for a link on an individual work page.
At a minimum, this template requires the '''url''' argument for the link to the making-of article:
* '''archive''': optional. This can be used to store an archived version of the url (for example, from the Internet Archive), just as in the [[:Template:link|link]] and [[:Template:dead link|dead link]] templates. If an author commentary link goes dead, we can change "ac" to "dead ac" to switch the link over to the [[:Template:dead ac|dead ac template]], and then the archive url will be used instead of the original url.
<hr>
===Examples:===


<tt><nowiki>{{ac|url=http://www.the-making-of-my-game.com}}.</nowiki></tt>
<tt><nowiki>{{ac|url=http://www.the-making-of-my-game.com}}.</nowiki></tt>


appears as


[http://ifwiki.org Author Commentary].
<hr>


On the wiki page, the link will be labeled "Author Commentary" by default. (This may be enough information if the link appears on an individual work page.)
<tt><nowiki>{{ac|url=http://www.the-making-of-my-game.com|archive=http://wwww.archive-version.com|How I Made My Amazing Game}} - [[Petunia Q. Author]] on [[Amazing Game]].</nowiki></tt>
 
To use different link text, we can optionally put the text in an '''unlabeled argument''' in the template (and of course we can always add more information outside the template if we want to include crosslinks):
 
<tt><nowiki>{{ac|url=http://www.the-making-of-my-game.com|How I Made My Amazing Game}} - [[Petunia Q. Author]] on [[Amazing Game]].</nowiki></tt>
 
 
The optional '''archive''' argument can be used to store an archived version of the url (for example, from the Internet Archive), just as in the [[:Template:link|link]] and [[:Template:dead link|dead link]] templates:
 
<tt><nowiki>{{ac|url=http://www.making-of-my-awesome-game.com|archive=http://www.archived-url.com|How I Made My Amazing Game}}.</nowiki></tt>


If an author commentary link goes dead, we can change "ac" to "dead ac" to switch the link over to the [[:Template:dead ac|dead ac template]] instead.
appears as


[http://ifwiki.org How I Made My Amazing Game] - [[Petunia Q. Author]] on [[Amazing Game]].




[[Category:Link templates]]
[[Category:Link templates]]

Revision as of 03:28, 11 June 2016

[{{{url}}} Author Commentary]


Basic Use

The author commentary template is for links to "Making-Of" articles, post-mortems, and the like which are written by authors about a work of their own. A page that uses this template will automatically be added to the author commentary category so that readers in search of these craft articles can find them.

Author commentary links that appear on a work page should go under the Spoilers heading in the Links section. When author commentary links appear on a competition page, they should go under an Author Commentary heading in the Links section, and preferably be put in order by author surname.


Arguments:

  • url: required. Should specify the url of the making-of article.
  • link text: optional. This is an unlabeled argument. If omitted, the link text will show up as Author Commentary, which may be enough for a link on an individual work page.
  • archive: optional. This can be used to store an archived version of the url (for example, from the Internet Archive), just as in the link and dead link templates. If an author commentary link goes dead, we can change "ac" to "dead ac" to switch the link over to the dead ac template, and then the archive url will be used instead of the original url.

Examples:

{{ac|url=http://www.the-making-of-my-game.com}}.

appears as

Author Commentary.


{{ac|url=http://www.the-making-of-my-game.com|archive=http://wwww.archive-version.com|How I Made My Amazing Game}} - [[Petunia Q. Author]] on [[Amazing Game]].

appears as

How I Made My Amazing Game - Petunia Q. Author on Amazing Game.