Template:File generation description
en-1 | The description below was composed by a non-native English speaker. You are cordially invited to improve the literal quality of any textual expression. |
This template allows to specify how an SVG image file was made, e.g. the used tool and other properties.
This wrapper around {{Image generation}} uses more or less self-explaining parameter names, instead of the (cryptic) short codes. Most parameters and essential features of Image generation are supported.
Invocations should be descriptive, therefore no abbreviations exist (for template or parameter names).
All parameters names start with an upper case letter (and must be specified with the proper case).
Of the first four parameters:
SVG tool
is required andTopic
is most recommended,W3C error count
andOther fields
are usefully defaulted.[clarification needed]
There are also:
- a set of boolean (true/false) parameters which default is "no" (false);
- the three parameters to describe a digital alteration;
- parameters to describe possible SVG bugs;
- parameters to format the possible display of source codes; and
- more parameters.
Normally very few parameters will be sufficient, and only in special cases some more are needed.
Usage
{{File generation description |SVG tool= |Topic= }}
Template parameters
Parameter | Description | Default | Status | |
---|---|---|---|---|
SVG tool | specify the name of the SVG tool: prepended with "Created with" it gives a template name. | required | ||
W3C error count | specify the number of errors detected by the W3C Validator (see explanation) | 0 (valid) | optional | |
Other fields | specify either "yes" for {{InFi}} insertion, or "no" for a linefeed, or "none" (see explanation) | yes *) | optional | |
Topic | specify a description what the image shows, e.g. coa, flag, icon, logo, map (see the list below) | empty | suggested | |
| more parameters: | optional | ||
Category | specify to change the categorization | standard | optional | |
Subcategory | specify to change the subcategorization | standard | optional | |
Sortkey | specify to change the sorting within the [sub]category | empty | optional | |
Topic-d | specify a topic for the display only (see Difference between "s" and "w") | Topic | optional | |
User | specify any textstring for a user (see {{U}} or {{By}}) | empty | optional | |
Userlink | specify a linkable user name (this parameter precedes "User") | empty | optional | |
More | specify free text to be displayed | . | optional | |
Prefix | specify anything (text and/or templates) to display previously | empty | optional | |
Trailer | specify anything (text and/or templates) to display afterwards | empty | optional | |
Tincture | specify a string e.g. like or/azure/gules (see Tincture); for Tincture-ss= see other shades | empty | optional | |
Colorbox | specify a string of one or more color codes (see #Colorboxes) | empty | optional | |
Graphic lab | specify an ISO 639 language code, or Commons or Workshop {see the list below} | empty | optional | |
Othertool | specify the toolname when "Other tool" name is known | empty | optional | |
Additional | specify another tool which was used together with the "SVG tool" | empty | optional | |
Message | specify one or more message boxes | empty | optional | |
Broken file | specify the description why the file is corrupted | empty | optional | |
Supersedes | specify the name of the superseded file | empty | optional | |
Superseded by | specify the name of the superseding file | empty | optional | |
| yes–no parameters: | optional | ||
Superseded | yes when the file is inferior to another one | no | optional | |
Commonist | yes when the file was Uploaded with Commonist | no | optional | |
Text embedded | yes (or switch ) when the file contains embedded text | no | optional | |
Text as path | yes when the file contains path text | no | optional | |
Large file | yes when the SVG file is too large to show the source code | no | optional | |
Easy border | yes when a border should be drawn | no | optional | |
PGF data | yes when the file contains PGF CDATA blocks | no | optional | |
Traced SVG | yes when the file is a poorly traced SVG | no | optional | |
Bad SVG | yes when the file contains raster data | no | optional | |
Fake SVG | yes when the file is a Fake SVG | no | optional | |
Topo SVG | yes when the file contains topographic raster data | no | optional | |
Required raster | yes when the file contains required raster data | no | optional | |
SVG 1.2 | yes when the file contains SVG 1.2 features | no | optional | |
Topo SVG | yes when the file Should be text | no | optional | |
Fictional | yes when the image shows a fictional object, e.g. a flag | no | optional | |
Simplified SVG | yes (or pair of numbers) when the SVG code had been simplified | no | optional | |
Textedit only | yes (or only /+ /- ) when no vector graphic editor should be used (aka No Inkscape) | no | optional | |
Draw by hand | yes (or name of an example file) when a very simple SVG image should not be drawn with a tool | no | optional | |
Vector version | yes (or name of the SVG file) when a vector version exists of that raster image | no | optional | |
Convert to SVG | yes (or topic) when the raster image should be converted to SVG | no | optional | |
Simple to SVG | yes (or topic) when a very simple bitmap should be converted to SVG | no | optional | |
Important | yes when the code had been created with Inkscape-Important | no | optional | |
| Retouched picture parameters: | optional | ||
Retouche | specify what has been modified | empty | optional | |
Modifier | specify the user name of the editor who has done the digital alteration | empty | optional | |
Original | specify the file name of the original picture, if any | empty | optional | |
| bug description parameters: | optional | ||
General bug | specify descriptional text of one or more bugs | empty empty empty empty empty empty empty empty empty | optional | |
Technically replaced | specify the name of the replacing file | empty | optional | |
| display source code parameters: see Created with code Three source codes can be displayed:Each one of the following parameters can be postfixed with either 1, 2 or 3; the first set can also be used without the postfix "1". | optional | ||
Code | copy the source code which was used to generate the image | optional | ||
Syntax | specify one of the supported languages for highlighting | optional | ||
Titling | specify the titling headline to be shown above the code | optional | ||
Collapse | specify the headline to be shown instead of the code | optional | ||
Diffusion | specify a category diffusion to categorize "Images with Diffusion source code" | optional | ||
Explanation | specify an explanatory text to be shown above the code | optional | ||
Footnote | specify a footing note below of the displayed code | optional | ||
Format | specify a style attribute for code display | 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
Localization
This template is not intended to be localized.
The template itself does not generate any localizable text, except an error message.
Explanation
SVG tool
Regardless of the parameter name it can also be another tool which does not, or not only, create SVG files; parameter Tool name
may be used in that case.
This parameter is required and will not be defaulted. An error occurs when this parameter is missing, or when no such template exists.
The value is case sensitive. The names of all tool templates can be used, including:
- Adobe Illustrator
- BKchem
- ChemDraw
- ChemSketch
- Chemtool
- CorelDRAW
- Fig2SVG
- Gnuplot
- HandSVG
- Inkscape-hand
- Inkscape
- LibreOffice
- Other tool
- Sodipodi
- Unknown tool
- (more than 100 "Created with ..." templates)
- IA when Inkscape and Adobe Illustrator are used (no matter which sequence)
Validity (W3C error count)
Not setting the W3C error count
parameter or setting it to 0
or v
means no W3C-error or "valid".
A value greater than 0 means "invalid because of .. errors".
Other values:
- For files that are not W3C-checkable, specify
-1
. n
can be set for non-SVG files (not necessary, will be set automatically)s
is used for SVG files that are not checked, or should not show their validation
Other fields
By default or when set to yes
, includes the {{Information field}} treatment to create the field name.
When set to no
it performs a {{Clr}}.
An empty value (|Other fields=
) or |Other fields=none
does nothing.
- recommended: when used with "other fields" of {{Information}}, do not specify it, or with "yes"
- deprecated: when used outside of {{Information}}, or within {{Inform}}, specify it with "no" (or with "none")
Topics
This parameter should always be provided with a value, it is essential for display and for the subcategorizing.
The most frequent used "topics" can be specified by the following parameter values, all as written in singular with lower caps.
But as well all values as defined in the tables
can be specified with their short codes.
- arrow
- button
- chart
- coa | coat of arms
- diagram
- digit
- drawing
- emblem
- equation
- flag
- geometric
- icon
- logo
- map
- notation
- order
- pictogram
- roundel
- seal
- signature
- sign
- structural formula
- text logo | textlogo
- trigonometry
- unicode
- world map
- symbol
Some templates default a not specified topic, e.g. BKchem, ChemDraw, ChemSketch, Chemtool, N2S with "structural formula".
To suppress the (standard) definition of any topic, use Topic = none
.
More parameters
Cat/Sub/Key
Category, subcategory and sort key are created following certain standards; it is advised not to change it – but nevertheless it can be altered if that is desired.
- Category can be specified complete (e.g. [[Category:Collection of bugs: Part1|Severity]]), or just the category name (e.g. Collection of bugs) with possibility to define the other two parameters (e.g. Subcategory=: Part1, Sort key=Severity).
- To suppress the (standard) categorization, use
Category = none
.
- Subcategory can replace the standard subcategorizing by topic
- To suppress the (standard) subcategorization, use
Subcategory = none
.
- Sorting within the category or subcategory can be changed by the parameter value of "Sort key".
User, Userlink
The parameter value can be either a simple textstring (e.g. User=The Stanford University
), or a transclusion with e.g. {{U}}, {{Ut}}, {{Uw}}, {{Uc}}}, {{Ud}}, {{Uwt}}.
The link to a Commons user page can be performed with the other parameter Userlink
which uses the template:U, e.g. Userlink=Leyo
Graphic lab
Grahic lab categories contain in general subcategories for CoA, Flag and Map.
Currently the following Graphic labs are established:
Colorboxes
There are seven different parameter names, to generate different color box layouts:
Colorbox
generates boxes with {{Legend}} from parameter pairsColorbox-b
generates boxes with {{ColorBox}} from single parametersColorbox-d
generates boxes with {{ColorBox}} from parameter pairsColorbox-l
generates boxes with {{Legend}} from single parameters ¹)Colorbox-m
generates boxes with {{Legend-small}} from parameter pairsColorbox-s
generates boxes with {{Legend-small}} from single parametersColorbox-t
generates boxes with {{Tbc}} from parameter pairs
- ¹)
Colorbox-l
exists just for completion – normally a "Legend" without an explaining text seems not useful.
The (first) parameter has to be a color code
- a valid hexadecimal color code, e.g. "#FF00FF" or "#080"
- a valid tincture color name, e.g. "cendrée"
- a valid CSS color name, e.g "turquoise"
invalid codes cause unpredictable errors. For Colorbox-l
and Colorbox-s
each parameter is such a color code.
The second parameter of a pair is descriptive text, e.g. "rouge", it may also contain links or other wiki syntax;
when it is missing (e.g. two consecutive slashes), the first parameter is displayed instead.
The parameters are specified as a slash-separated string, e.g. "#aa1122/Color 1/#ccddee/Color 2/#cc00dd/Color 3/#FF0/yellow
"
For (heraldic) Tinctures, see the documentation of that template.
Bad/Fake/Topic/Requ SVG
An SVG file containing raster graphics in most cases is a Bad SVG; in some special cases it will be a Fake SVG or a Topo SVG/Required raster. Only either one of these four possibilities can occur.
Retouched picture
For the complete description of a digital alteration, all three parameters should pass their values; nevertheless any one of them triggers the tagging of the file with the template.
Retouche
can describe the modificationsModifier
can describe theeditor
of the alterations, in general it will be a link to a user nameOriginal
can describe theoriginal
picture that has been modified, in general it will be a link to a file name
Always consider the fact that a mere vectorization is not a digital alteration! These cases should use the template:AutVec in the Author=
field.
Other tool
It can be specified that a file has been created using more than one (the "SVG tool" of the first parameter) tool.
Raster graphic tags
Of course, Convert to SVG
or Simple to SVG
is only useful when specified at a raster graphic.
All the topics explained in Convert to SVG/doc/param1 can be used.
Vector version
when specified at a raster graphic shows the SVG file with the same name, or with the specified name.
Parameter copy
Small example
{{ File generation description
| SVG tool = ChemDraw
| W3C error count =
| Topic = structural formula
| Text as path = no
| Text embedded = no }}
In this example, only the first parameter is necessary, the others just specify what would be defaulted anyway.
When "Other fields" is missing it is the same as Other fields=yes
which will be the best choice in most cases.
Large parameter list
{{File generation description |SVG tool= |W3C error count= |Topic= |Category= |Subcategory= |Sort key= |User= |Userlink= |More= |Othertool= |Additional= |Graphic lab= |Tincture= |Colorbox= |Broken file= |Superseded by= |Supersedes= |Prefix= |Trailer= |Message= |Superseded= |Commonist= |Text embedded= |Text as path= |Large file= |Easy border= |PGF data= |Traced SVG= |Bad SVG= |Fake SVG= |Topo SVG= |Required raster= |Fictional= |Simplified SVG= |SVG 1.2= |Textedit by hand= |Vector version= |Convert to SVG= |Simple to SVG= |Retouche= |Modifier= |Original= }}
- |Other fields=yes
Bug parameters, Code parameters
|Technically replaced= |General bug= |Gaussian blur bug= |Compatibility bug= |Demonstration bug= |Former bug= |Overwritten bug= |Replaced bug= |Unsolved bug= |Syntax= |Titling= |Collapse= |Diffusion= |Explanation= |Footnote= |Format= |Code=
{{ifsandbox|