Template:Vector version available/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Notifies about the existence of one or more vector versions (superior/equivalent/inferior) of a bitmap image

The template automatically sets the following categories: Vector version available

Usage

{{Vector version available |1= }}

When first parameter is absent it defaults to the name of the file the template is placed on, with the extension changed to ".svg". See ➔ File name

Template parameters

ParameterDescriptionDefaultStatus
1First SVGName of the SVG file (see #File name for explanation)Current file name, minus extension, plus .svg.suggested
2Second SVGName of a second SVG fileemptyoptional
3Third SVGName of a third SVG fileemptyoptional
quality
q
allquality
aq
Quality"superior" / "inferior" (or abbreviation "s" / "i")
shortcut "q"
when more than one file the parameter "allquality" must be used,
(or the shortcut "aq") otherwise the "quality" option is ignored
emptyoptional
reason
r
Reasonany text for explanationemptyoptional
lang
lang1
Languagelanguage code to be used for a multilingual SVG file (also: lang2, lang3 for the other files)emptyoptional
by
by1
Creatorwhen it seems useful to display the creator of the SVG file (also: by2, by3 for the other files)emptyoptional
topic
t
Topic Codewhen the topic should be displayed, instead of just the namespaceemptyoptional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Notifies about the existence of one or more vector versions (superior/equivalent/inferior) of a bitmap image

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
First SVG1

The first SVG image, in the form "Image.svg".

Default
Current file name, minus extension, plus ".svg".
Filesuggested
Second SVG2

The second SVG image, in the form "Picture.svg".

Fileoptional
Third SVG3

The third SVG image, in the form "Graphic.svg".

Fileoptional
Creatorby by1

when it seems useful to display the creator of the SVG file (also: by2, by3 for the other files)

Lineoptional
Languagelang lang1

language code to be used for a '''multilingual''' SVG file (also: lang2, lang3 for the other files)

Stringoptional
Qualityquality q allquality aq

"superior" / "inferior" (or abbreviation "s" / "i")

when more than one file the parameter "allquality" must be used, otherwise the "quality" option is ignored

Suggested values
s superior i inferior
Stringoptional
Reasonreason r

any text for explanation

Lineoptional
Topic Codetopic t

when the topic should be displayed, instead of just the namespace

Stringoptional

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: all users

See also

{{Convert to SVG}}
{{Superseded}}

File name

If the names of the bitmap and vector files are identical except for the file extension, the first parameter may be left empty (see Autoreferencing templates).

Each parameter may, but does not need to, include the "File:" or "Image:" namespace prefix and/or the ".svg" file extension. Any other recognized extension will be replaced by ".svg".

The template will give an error message and add the maintenance category Vector version available/error if any of the specified files does not exist.

see also

Localization

Alemannisch  Bahasa Indonesia  Bahasa Melayu  British English  català  čeština  dansk  Deutsch  eesti  English  español  Esperanto  euskara  français  Frysk  galego  hrvatski  Ido  italiano  lietuvių  magyar  Nederlands  norsk bokmål  norsk nynorsk  occitan  Plattdüütsch  polski  português  português do Brasil  română  Scots  sicilianu  slovenčina  slovenščina  suomi  svenska  Tiếng Việt  Türkçe  vèneto  Ελληνικά  беларуская (тарашкевіца)  български  македонски  нохчийн  русский  српски / srpski  татарча/tatarça  українська  ქართული  հայերեն  বাংলা  தமிழ்  മലയാളം  ไทย  한국어  日本語  简体中文  繁體中文  עברית  العربية  فارسی  +/−

This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:Vector version available/layout.

To add your language to the list of languages supported by this template, please copy the code of Template:Vector version available/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.


For quick insert (and replace) you can use a user-script (the first highlighted line could be redundant):

var ns = mw.config.get('wgNamespaceNumber'), ti = mw.config.get('wgTitle');
if (ns === 14 || (ns === 6 && !/SVG/i.test(ti.slice(-3)))
    importScript('User:Perhelion/fixconverttosvg.js'); // Automatic CONVERT-TO-SVG tags: