Violinwiki:Template guide

From Violinwiki
Jump to: navigation, search

The most important Violinwiki templates and their usage are explained here. When you are a seasoned editor with thousands of edits and feel like adding a new template, the rule is that pages are for the content and templates are for the code.

Page maintenance templates

These templates change the status of the wiki page. In an ideal case the page does not need any of them.

Usage: {{Bio needed}}
The article containing this template needs a brief biography of a person the article is about.
Usage: {{Citation needed}}
The text nearby this template contains vague or unsupported statement that needs to be supported by a verifiable external source. By using this template the article is put into Category:Articles needing sources for easy review.
Usage: {{Clarify}}
The text nearby this template needs clarification. By using this template the article is put into Category:Articles needing clarification for easy review. The template is usually used for puffery or weasel words.
Usage: {{Date?}}
The date nearby this item is uncertain and needs verification. By using this template the article is put into Category:Articles needing clarification for easy review.
Usage: {{Etude analysis needed}}
The etude containing this template needs a technical and musical analysis.
Usage: {{Piece analysis needed}}
This piece containing this template needs a deeper technical and musical analysis.
Usage: {{Stub}}
The template is inserted at the top of the page that is stub. It creates an infobox and puts the page into the Category:Stubs.
Usage: {{Under construction}}
A template used between active editing sessions. The template is inserted at the top of the page that is edited, it creates an infobox inviting other editors for input.
Usage: {{In use}}
A short term template used during an active editing session. The template is inserted at the top of the page that is edited, it creates an infobox. It helps to prevent edit conflicts.
Usage: {{No library}}
The template used by default in the template Book. If the editor forgets to put down a defining library reference, the book page is automatically put into the category Category:New book page without library.
Usage: {{No public library}}
The template us used when the edition of the work is not known to be held in any public library. This template is removed once the library holding the edition of the work is known.
Usage: {{Delete}}
The template is inserted at the top of the page, it puts the page into the maintenance category Category:Candidates for deletion.
Usage: {{Speedy}}
The template is inserted at the top of the page, it puts the page into the maintenance category Category:Candidates for speedy deletion.
Usage: {{Vandal|username}}
This template is not put on the vandalized page but on Administrator intervention against vandalism page to report vandalism of the page concerned. The editor can revert the page to previous status himself.
Usage: {{Unused file|~~~~~}}
The template is inserted at the top of the page in the File namespace, it puts the page into the maintenance category Category:Unused files.

Licence templates

These templates determine the copyright status of uploaded files in the File namespace. They have to be used for every uploaded file. These templates are usually chosen from Licensing menu when you invoke Upload file.

The file is in public domain worldwide.
The file has been released into the public domain by the uploader (author of the file).
The file may not be public domain in the USA. However, it is in the public domain in the EU, Canada and in any countries where the copyright term is life plus 70 years or less. This template is used for the works published between 1923 and 1945 that are public domain in the EU and other countries and areas where the copyright term is the author's life plus 70 years or less but they may not necessarily be public domain in the US.
This work is in the public domain in its country of origin and other countries and areas where the copyright term is the author's life plus 70 years or less. This template is used for the works that are public domain in the EU.
The file is licenced under the Creative Commons Attribution 3.0 licence.
The file is licenced under the Creative Commons Attribution 4.0. licence.
The file is licenced under the Creative Commons Attribution ShareAlike 3.0
The file is licenced under the Creative Commons Attribution ShareAlike 4.0
The file has an unknown copyright status. If the licence is not supplied, the file will be deleted within a week of its upload.

Catalogue templates‎

These templates are useful when you reference library and other catalogues in the articles. The catalogue templates are used only when the library catalogue does not enable a permalink (not preferable, permalink to the item is always preferred). They are useful for pasting the description string when permalink is used.

Usage: {{Cat-at}}
Includes the reference to Österreichische Nationalbibliothek in the article.
Usage: {{Cat-at-oebl}}
Includes the reference to Österreichisches Biographisches Lexikon 1815-1950 Online-Edition in the article.
Usage: {{Cat-cz}}
Includes the reference to The Union Catalogue of the Czech Republic in the article.
Usage: {{Cat-cz-aut}}
Includes the reference to Authority Database of the National Library of the Czech Republic in the article.
Usage: {{Cat-es}}
Includes the reference to Catálogo de la Biblioteca Nacional de España in the article.
Usage: {{Cat-fr}}
Includes the reference to Bibliothèque nationale de France (Catalogue Général) in the article.
Usage: {{Cat-H-XIX}}
Includes the reference to Hofmeister XIX in the article.
Usage: {{Cat-it}}
Includes the reference to Catalogo del Servizio Bibliotecario Nazionale in the article.
Usage: {{Cat-rism}}
Includes the reference to Répertoire International des Sources Musicales in the article.
Usage: {{Cat-sk}}
Includes the reference to the Slovak Library Union Catalogue in the article.
Usage: {{Cat-us}}
Includes the reference to Library of Congress Online Catalog in the article.

Formatting templates

Page formatting templates

Template used for modifying the properties of the table of contents.
Template for showing the table of contents on the right side of the page.
Usage: {{anchor|Section}}
The template {{anchor}} inserts one or more HTML fragment identifiers (anchor names) in a page. Those locations can then be linked to using [[#Section|...]] syntax.
Usage: {{Clear}} {{Clear|left}} {{Clear|right}}
It pushes the content to the next line below nearby floating images or templates. It is often used to stop text from flowing next to unrelated images. For those with HTML knowledge, it clears the floats.
Usage: {Chart|title=Title of the chart image|chart=<pbars .... </pbars>}}
Template is used for embedding charts in Violinwiki pages. It requires the title of the image and chart data as parameteres.
Usage: {{Score|title=Scale in G major|source=IMSLP # 123456|licence=Public domain|score=<score .... </score>}}
Template is used for embedding Lilypond or ABC scores in Violinwiki pages. It requires the title of the image, the source of the score and the licence (Cc-by-sa-3.0 or Public Domain) and the score data as parameteres. The default values for source is 'Own work' and licence 'Cc-by-sa-3.0' if they are not provided.
Usage: {{listen|file|}} {{listen|title=title|filename=filename}}.
Links to media files (to Commons which is preferred) if the file doesn't exist on Violinwiki. All parameters except file name are optional.
Usage: {{Main|Article}}
Displays Main article: link to an article. Used in the help pages.
Enables to simulate heading where it is impossible, for example in the tables. Used in the help pages.
Used to display a link to template. Used in the help pages.

Violinwiki article templates

Unlike other templates that are transluded, these templates are always substituted using subst:. These templates are put at the top of the page, the page is saved and then reopened for editing. These templates will not work correctly without substitution. Read the individual article template pages to see what kind of information is generated automatically and what information should not be missing in each type of article.

Usage:
Without parameters:
{{subst:Book}}
Creates the preformattted headings in the violin book page.
With parameters:
{{subst:Book|title=TITLE|author=AUTHOR|publisher=PUBLISHER|pages=XX p.|isbn10=X-XXXXX-XXX-X|isbn13=XXX-X-XXXX-XXXX-X}}
Creates preformatted headings in the violin book page with the provided text in the page. All parameters all optional, if a parameter is not used, the default template value is supplied.
Usage: {{subst:Piece}}
Creates the headings for the violin piece page.
Usage: {{subst:Etude}}
Creates the headings for the etude page.
Usage: {{subst:Teacher}}
Creates the headings for the violin pedagogue page.
Usage: {{subst:Composer}}
Creates the headings for the violin composer page.
Usage: {{subst:Luthier}}
Creates the headings for the violin maker page.
Usage: {{subst:Archetier}}
Creates the headings for the bow maker page.
Usage: {{subst:Refs}}
This template creates heading References and </references> tag.

Text formatting templates

Usage: {{Bibref|link=http://primocat.bl.uk/F?func=direct&local_base=ITEMV&doc_number=004709613&con_lng=eng|title=Melodious Foundation Studies. Mélodies en études de fond. For Violin (1926)}}
Template is used for linking to the catalogue record of the first (extant) edition of the work from the works listing in the composer page (the library choice: the preference is for the national library of the composer's or the publisher's country. If the edition of the work is not available either in the national library of the composer's country or the national library of the publisher's country, any library that contains the edition is fine. Template requires the link to the catalogue record of the work and the title of the work. The author of the work is taken from page name by default.
Usage: {{ISBNN|isbn number}}
Creates ISBN number without ISBN string. Used in the {{Book}} and {{Bot-book}} templates.
Usage: {{Music|required symbol}}
Multipurpose template for displaying various musical symbols in the article. Its usage is described in Template:Music/doc.
Usage: {{Sheetmusic|link=Melodious Double Stops (Trott, Josephine) (editions)}}
Template is used for linking to the Violinwiki bibliographic record or list of editions from the works listing in the composer page when the sheetmusic is available. Template requires name of the page to be linked as a parameter.
Usage: {{Time signature|upper|lower}}
Creates time signature fraction in the text. Used in the {{Music}} template.
Usage: {{Blue|text}}
Makes the text blue.
Enables to use formatted html tags in the text. Used in the help pages.

Finger pattern templates

The templates used for inserting the finger pattern in the text whenever necessary.

Usage: {{Major finger pattern}}
Used for formatting of the violin Major finger pattern in the text: 1-23-4.
Usage: {{Minor finger pattern}}
Used for formatting of the violin Minor finger pattern in the text: 12-3-4.
Usage: {{Major finger pattern with high third}}
Used for formatting of the violin Major finger pattern with high third in the text: 1-2-34.
Usage: {{Whole tone finger pattern}}
Used for formatting of the violin Whole tone finger pattern in the text: 1-2-3-4.
Usage: {{Major Finger Pattern with Augmented Fourth}}
Used for formatting of the violin Major Finger Pattern with Augmented Fourth in the text: 1-23––4.
Usage: {{Minor Finger Pattern with Augmented Fourth}}
Used for formatting of the violin Minor Finger Pattern with Augmented Fourth in the text: 12-3––4.
Usage: {{Minor Finger Pattern with High Third}}
Used for formatting of the violin Minor Finger Pattern with High Third in the text: 12––34.
Usage: {{Whole Tone Finger Pattern with Augmented Second}}
Used for formatting of the violin Whole Tone Finger Pattern with Augmented Second in the text: 1––23-4.
Usage: {{Contraction Semitone Semitone Whole Tone Pattern}}
Used for formatting of the violin Contraction Semitone Semitone Whole Tone Pattern in the text: 123-4.
Usage: {{Contraction Semitone Whole Tone Semitone Pattern}}
Used for formatting of the violin Contraction Semitone Whole Tone Semitone Pattern in the text: 12-34.
Usage: {{Contraction Whole Tone Semitone Semitone Pattern}}
Used for formatting of the violin Contraction Whole Tone Semitone Semitone Pattern in the text: 1-234.
Usage: {{Semitone Finger Pattern}}
Used for formatting of the violin Semitone Finger Pattern in the text: 1234.

Column templates

Used for creting columns in the articles if it is required.

Help demo templates

These templates are used for demonstration in Help or in help pages. Their use in Violinwiki pages is very limited but they are good for understanding how templates work.

Other

Statistical template, included automatically by using templace {{Book}}
Statistical template, included automatically by using templace {{Piece}}
Statistical template, included automatically by using templace {{Teacher}}
Statistical template, included automatically by using templace {{Composer}}
Statistical template, included automatically by using templace {{Archetier}}
Statistical template, included automatically by using templace {{Luthier}}
Statistical template, included automatically by using templace {{Etude}}
Creates a bordered box with header and image if required.
Creates a warning text or warning box with an icon. Used in help pages.
Inserts internal links. Admin use.
Returns Mediawiki link. Help files use.