Template:SVG created with/doc
Used to mark an image file
As its name indicates, this template was originally designed to identify the software (application, in most cases) used to create the file, but its role has since largely expanded. It now displays a horizontal (usually grey) box describing the file, potentially specifying its author, and controls its categorization.
This template may or may not display another box about SVG validity in some cases. When that validity box displays, it is first.
Usage
{{SVG created with ... |err= |topic= }}
Template parameters
Parameter | Description | Default | Status | |
---|---|---|---|---|
1 | name of user or author (for display); may as well be a link coded e.g. with {{U}}, {{Uc}}, {{Ud}}, {{Ut}}, {{Ult}} or otherwise. | empty | optional | |
2 | Depending on file types and the desired behavior, one of the following letters, always lowercase:
| empty | optional | |
err errors errnum | number of errors from W3C validator, generates {{InvalidSVG}} Mutually exclusive with "v"; should be a numeric value err=0 is equivalent to 2=v | empty | optional | |
more | optional additional text | . | optional | |
width | to set another width for the (normally grey) box | auto | optional | |
style | to set or overwrite other style attributes for the box | empty | optional | |
cat category | name of category/categories: complete with the brackets, or without them; replaces the category "Category:SVG created with" set by default suppress categorizing with cat=- | empty | optional | |
sub subcat subcategory | for category diffusion: specify a suffix to the category name Select the best fitting subcategory, or create an appropriate new one To insert an inbetween space, use understroke _ or and not <nowiki/> | empty | optional | |
key sort sortkey | Sortkey option within the category default value is the file name, will be preceded by the | empty | optional | |
topic | the topic, specified using its short code (e.g. "f" for "flag, "i" for "icon", "m" for map) | empty | optional | |
vwidth vw | SVG validity: to set another width for the box of ValidSVG/InvalidSVG[clarification needed] | width | optional | |
vstyle vs | SVG validity: to set or overwrite other style attributes for the box of ValidSVG/InvalidSVG e.g. vstyle=float:left or short vs=fl | style | optional | |
vtext vtxt vt | SVG validity: optional additional text for ValidSVG/InvalidSVG | . | optional | |
vopt vo opt | SVG validity: to set or overwrite the display source option for ValidSVG/InvalidSVG Suppress the display of the validation box with vopt=none (abbr: vo=n )or set vo=> when files are too large to display the SVG source code | empty | optional | |
c_t c_text | category text, e.g. "drawn with", "plotted using", "taken with" | created with | optional |
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
This template unifies the documentation of the templates categorized in the SVG created with ... templates category. To test changes to this template, you can use SVG created with/doc/sandbox.
The documentation generated by this meta-template can be customized using the following parameters:
◾ |desc= |
any description of the template, if different from default |
◾ |addinf= |
additional information for "Relies on" |
◾ |shortkey= |
sort key, e.g. template name without "Created with" Default is the value of |shorthand=
|
◾ |shorthand= |
any redirects to the template |
◾ |shorttext= |
any additional text to |shorthand=
|
◾ |redirects= |
one or more names of redirects |
◾ |igen= |
abbreviation used by the template {{Image generation}} |
◾ |catnam= |
if category names differ from template name |
◾ |cattext= |
any additional text following categories |
◾ |n= |
(=yes) if category "PNG created with ..." should exist[clarification needed] |
◾ |descname= |
replace the BASEPAGENAME in description |
◾ |c_t= |
if set to "X", the category name starts with "extracted" instead of "created" (with). |
◾ |sub= |
text or (=n) if no subcategorization should be possible |
◾ |top= |
default for the documented template's |topic= parameter
|
◾ |topic= |
If set to "no", suppresses the suggestion of the the documented template's |topic= parameter[clarification needed]
|
◾ |sandbox= |
e.g. "yes" if a sandbox exists |
◾ |vopttext= |
SVG validity: when set to any value (like yes ), shows s as an option for parameter #2. When set to un , adds a predefined text about unspecified validity.
|
◾ |opt= |
No longer used by this meta-template. However, it remains an alias for the |vopt= parameter of the documented templates.
|
◾ |vdef= |
default value for parameter #2 (e.g. "n" or "v") |
◾ |vstyle= |
SVG validity: default value for the documented template's |vstyle= parameter (e.g. "fl")
|
◾ |code= |
(1, 2 or 3) if the file description should display source code(s)[clarification needed] |
◾ |codetext= |
any additional text when |code=
|
◾ |vtext= |
alternative description for the documented template's |vtext= parameter
|
◾ |inval= |
SVG validity: When set to any value (e.g. "no"), the documented template's documentation does not display categories for invalid files as potential categories |
◾ |unspec= |
SVG validity: When set to any value (e.g. "no"), the documented template's documentation does not display categories for files with unspecified validity as potential categories |
◾ |I= |
(Upper case "i"): some description for parameter |IMPORTANT= [clarification needed]
|
◾ |w1= |
Relative width for the first (left) column of the examples table, as a percentage; default=37 |
◾ |w2= |
Relative width for the second (right) column of the examples table, as a percentage; default=63 |
◾ |I18dot= |
e.g. "yes": uses internationalization subtemplates from "Created with ..." "yes" is now assumed default - use "no" to display the old subtemplates |
- See also