Template:ROF-2

From Wikipedia, the free encyclopedia

Ring of Fire II

This page is transcluded from and may be maintained using: Template:1632 series templates usage1 (edit|talk|history|links)


This is common usage notes for many of the editor aid templates associated with the book series 1632 series.

Abbreviated title templates

All the book titles in the 1632 series have been set up with mnemonic editor typing aids. In general, most times, they are used to provide the given default link. Alternatively, they can be given a single letter output mode control as arg-1 ({{{1}}}), which select the three other most needed and common output formats: 1) provide italicisation of the link, 2) the title but not linked, 3) the unlinked title as (2) but italicised.

Mode controls by example
The templates ALL take the 'same mode controls as parameter arg-1: {I, N, O, and none}, which are passed as {{{1}}}.
Mnemonically, given arg-1 possibilities: none is a default link, 'I/i' is italicise the link, 'N/n' is book title as plain text (not as a link), and O/o triggers italicization of the nolinked mode.
'none' is the same as 'anything' but the single letters of the set {i, I, n, N, o, O}, hence giving a word or phrase as Arg-1 ({{{1}}}) will also display as the default mode, as is simulated by 'J' in the autotest shown below.
  • This could be one common error mode in the templates used to reference stories in anthologies, assuming an error in not using the equals sign or proper spelling of a display or section linking control parameter ({in, IN, p, or s}), all of which are discussed below.
Self tests 
{Template:ROF-1} -- (Master template "Model" for anthologies)
{Template:35TCL} -- (Master template "Model" for year prefixed novels titles)
In the below dynamic tests, the second of each adjacent alphabetical pairs are italicized, which is perhaps clearest if one considers giving no argument ({{{1}}} unset, or undefined) as "J" to complement "I" (the mnemonic for Italicized), but the true compliment of "I" is any other character not listed above, or indeed, any word or phrase that is not i or I.

Hence the default mode completes the "pairs sets" in the given list—giving four ways to control gross output behaviors, two linked and two not linked.
  • The last four examples demonstrate the effects of the display or section linking parameters {p, s, in, and IN}... the later two may show no effect (only used in anthologies templates)


Default:
Ring of Fire II
'i/I' Italicize:
Ring of Fire II
'n/N': (Nolink)
Ring of Fire II
'o/O': (Nolink+I)
Ring of Fire II
'P/p' pipetricks:
"p=p-demo Glops I"
p-demo Glops I
"section linkings:"
"s=s-demo Glops II"
s-demo Glops II
'in' sectionlinks:
'in="in-demo storytitle"'
"in-demo storytitle" in Ring of Fire II
'IN' sectionlinks:
'IN="IN-demo storytitle"'
"IN-demo storytitle" in the anthology Ring of Fire II


  • All templates will take a pipetrick for display contextual renaming of a link (|p=).
    • "Alternate phrasing" can always be given (if the output mode provides a link) by specifying a "pipetrick parameter": "| p =alternate phrasing" .
  • All templates will take a section command for contextual linking to a specific page's section title (|s=).
    • Each is capable of accessing a section title by using the "Section parameters":'s', as in: "|s=sectionname".
    • In practice, for example in referencing an anthology story, the section name might need to be quoted: {{ROF-1|s="Here Comes Santa Claus"}}.
    • In practice those parameters are used for only special occasions or needs, except to link to an article section or to an anthologies short story title (also organized as sections). Generally speaking, any illegal argument is ignored.
  • All templates addressing anthologies ({All the Gazettes... GGxx, 34TRR, ROF-1, and ROF-2}) will take two additional phrase boilerplate generating "section link command parameters" as well as 's' for contextual linking to a specific article's section title (|s=) (Such as the normal use... to link to the synopses section title of a particular short story in the anthology).
    • That is, "|in=" and "|IN=" link precisely to the same section as "|s="... but generate additional text. See the table above for the effect given by this particular template.

[edit] Miscellaneous notes

  • The anthologies templates operate in the same manner, but take an additional parameter '|in=' which generates a phrase and section link to the title "in".
    • Example {{ROF-1|in="Here Comes Santa Claus"}} will generate:
            [[Ring of Fire (anthology)#"Here Comes Santa Claus"|"Here Comes Santa Claus"]] in ''Ring of Fire'', displaying as:
      "Here Comes Santa Claus" in Ring of Fire... which is handy for discussing characters or canonical facts coming from one of the anthologies.