Template:Annotation switch/doc

From Wikisource
Jump to: navigation, search
Shortcut:
{{asw}}

Used to create an annotated version of a work as a subpage of the original work. This template can be used to modify the text of a work in the Page namespace in such a way that the original proofread version appears correctly in the mainspace while the annotated version will appear in an appropriate subpage. For example, this can be used to add wikilinks to the body of a text.

Usage[edit]

Basic[edit]

{{Annotation switch|clean version|annotated version|annotation subpage name}}

The subpage name is optional.

Advanced[edit]

{{Annotation switch
 | clean    = 
 | note1    = 
 | subpage1 = 
 | note2    = 
 | subpage2 = 
 | note3    = 
 | subpage3 = 
 | note4    = 
 | subpage4 = 
 | note5    = 
 | subpage5 = 
}}

Parameters[edit]

Basic[edit]

This template only requires two parameters in its basic version. The first should be the original text (called the "clean" text) as it appears in the original work. The second should be the annotated text. The third is an optional subpage name, which defaults to "Annotated". This annotation will only appear if the subpage name matches the subpage in the mainspace.

The clean text gives a clean, accurate version of the text for Wikisource reader, unencumbered by annotation and removing the chance of confusion between original and added text. By default the clean text will appear.

Advanced[edit]

  • clean: Original "clean" version of the text without annotation.
  • note: The annotated version of the text.
  • subpage: The name of the subpage in which the annotation should appear.

The numbers allow for up to five different variants of an annotation to appear in different subpages (if required).

Examples[edit]

Example 1[edit]

{{Annotation switch|Rattus rattus|[[species:Rattus rattus|Rattus rattus]]}}
{{Annotation switch
 | clean    = Rattus rattus
 | note1    = [[species:Rattus rattus|Rattus rattus]]
}}

These two versions of the template produce the same result.

  • In the Page namespace and the clean version in the Main namespace, this will appear: Rattus rattus
  • In a special annotation subpage of the clean version, this will appear: Rattus rattus

Thus, the plain text Rattus rattus appears in the clean version but a wikilink to Wikispecies, Rattus rattus, appears in the annotated version.

Example 2[edit]

{{asw|Rattus rattus|[[species:Rattus rattus|Rattus rattus]]}}

This produces the same effect as Example 1, using the shortcut for this template.

Example 3[edit]

{{Annotation switch|Rattus rattus|[[species:Rattus rattus|Rattus rattus]]|Annotated Edition}}
{{Annotation switch
 | clean    = Rattus rattus
 | note1    = [[species:Rattus rattus|Rattus rattus]]
 | subpage1 = Annotated Edition
}}

If the subpage containing the annotations is not the default "Annotated", this is set with the subpage parameter (or the third paramter of the basic version). In this case, the subpage is "Annotated Edition" appearing as Original/Annotated Edition.

Example 4[edit]

{{Annotation switch
 | clean    = Rattus rattus
 | note1    = [[species:Rattus rattus|Rattus rattus]]
 | subpage1 = Annotated Edition
 | note2    = Black Rat
 | subpage2 = Simple Edition
}}

If there are more than one additional versions, then the template can be expanded to up to five variations. In this example, there are three version: the original, clean version; an annotated version with a wikilink to Wikispecies; and a Simple version, rendering the latin name into Simple English. These will appear as:

  • Clean: Rattus rattus
  • Annotated: Rattus rattus
  • Simple: Black Rat

The two different subpages will be Original/Annotated Edition and Original/Simple Edition.

See also[edit]

  • {{annotation}} - used in the body of a work to create a reference. eg. {{annotation|text for body of the work}}
  • {{annotations}} - used at the base of the document to collect any reference material to which referred.
  • {{annotation header}} - placed in the Notes field of the {{header}}