Open main menu

Template:File generation description

Unknown logo-V.svg
This vector image was created with an unknown tool.
Documentationviewedithistorypurge

This template allows to specify how a file was made, e.g. the used tool and other properties of an SVG drawing.

It serves as an interface from human readable parameters to the template:{{Image generation}}.
Most parameters of Image generation can be used with more or less self-explaining names.


This inbetween-template allows to use {{Image generation}} with parameter names, instead of the short codes.
The most essential tags can be specified, but all the subcategorizing and formatting is provided only by the original.
In general, parameter names are not aliased; they all start with an upper case letter, while the values are in lower case.
Of the first four parameters,

  • SVG tool is required and Topic is most recommended,
  • W3C error count and Other fields are usefully defaulted.

There are further

  • more parameters which are used by specifying their value,
  • a set of yes/no (true/false) parameters which default is "no" (false),
  • the three parameters to describe a digital alteration
  • the parameters to describe possible SVG bugs, and
  • parameters to format the possible display of source codes.


Normally very few parameters will be sufficient, and only in special cases some more are needed.
A set of all parameters can be copied from the complete parameter list below.

Usage

{{File generation description |SVG tool= |Topic= }}

Template parameters

ParameterDescriptionDefaultStatus
SVG toolspecify the name of the SVG tool: prepended with "Created with" it gives a template name.0required
W3C error countspecify the number of errors, detected by the W3C Validator (see explanation)0 (valid)optional
Other fieldsspecify either "yes" for {{InFi}} insertion, or "no" for a linefeed, or "none" (see explanation)yesoptional
Topicspecify a description what the image shows, e.g. coa, flag, icon, logo, map (see the list below)emptysuggested
00 more parameters:0optional
Categoryspecify to change the categorizationstandardoptional
Subcategoryspecify to change the subcategorizationstandardoptional
Sortkeyspecify to change the sorting within the [sub]categoryemptyoptional
Topic-dspecify a topic for the display only (see Difference between "s" and "w")Topicoptional
Userspecify any textstring for a user (see {{U}} or {{By}})emptyoptional
Userlinkspecify a linkable user name (this parameter precedes "User")emptyoptional
Morespecify free text to be displayed.optional
Prefixspecify anything (text and/or templates) to display previouslyemptyoptional
Trailerspecify anything (text and/or templates) to display afterwardsemptyoptional
Tincturespecify a string e.g. like a/b/g/s (see Tincture)emptyoptional
Colorboxspecify a string of one or more color codes (see #Colorboxes)emptyoptional
Graphic Labspecify an ISO 639 language code, or Commons or Workshop {see the list below}emptyoptional
Other toolspecify another tool which was used together with the "SVG tool"emptyoptional
Messagespecify one or more message boxesemptyoptional
Broken filespecify the description why the file is corruptedemptyoptional
Supersedesspecify the name of the superseded fileemptyoptional
Superseded byspecify the name of the superseding fileemptyoptional
00 yes–no parameters:0optional
Supersededyes when the file is inferior to another onenooptional
Commonistyes when the file was Uploaded with Commonistnooptional
Text embeddedyes (or switch) when the file contains embedded textnooptional
Text as pathyes when the file contains path textnooptional
Large fileyes when the SVG file is too large to show the source codenooptional
Easy borderyes when a border should be drawnnooptional
PGF datayes when the file contains PGF CDATA blocksnooptional
Traced SVGyes when the file is a poor traced SVGnooptional
Bad SVGyes when the file contains raster datanooptional
Topo SVGyes when the file contains topographic raster datanooptional
Fake SVGyes when the file is a Fake SVGnooptional
Fictionalyes when the image shows a fictional object, e.g. a flagnooptional
Simplified SVGyes (or pair of numbers) when the SVG code had been simplifiednooptional
Textedit onlyyes (or only) when no vector graphic editor should be usednooptional
Draw by handyes (or name of an example file) when a very simple SVG image should better be drawn by hand than using a toolnooptional
Vector versionyes (or name of the SVG file) when a vector version exists of that raster imagenooptional
Convert to SVGyes (or topic) when the raster image should be converted to SVGnooptional
Simple to SVGyes (or topic) when a very simple bitmap should be converted to SVGnooptional
00 Retouched picture parameters:0optional
Retouchespecify what has been modifiedemptyoptional
Modifierspecify the user name of the editor who has done the digital alterationemptyoptional
Originalspecify the file name of the original picture, if anyemptyoptional
00 bug description parameters:0optional
General bug
0Gaussian blur bug
0Compatibility bug
0Demonstration bug
0Former bug
0Overwritten bug
0Replaced bug
0Unsolved bug
specify descriptional text of one or more bugs







empty
empty
empty
empty
empty
empty
empty
empty
optional
Technically replacedspecify the name of the replacing fileemptyoptional
00 display source code parameters: see Created with code00Three source codes can be displayed:
0 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".
0optional
Codecopy the source code which was used to generate the image0optional
Syntaxspecify one of the supported languages for highlighting0optional
Titlingspecify the titling headline to be shown above the code0optional
Formatspecify a style attribute for code display0optional
Footnotespecify a footing note below of the displayed code0optional
Explanationspecify an explanatory text to be shown above the code0optional
Diffusionspecify a category diffusion to categorize "Images with Diffusion source code"0optional
Collapsespecify the headline to be shown instead of the code0optional

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

This inbetween-template allows to use the template:Image generation with parameter names, instead of the short codes.
The most essential tags can be specified, with abstention of all the tag-subcategorizing and tag-formatting that is provided only by the original.
In general, parameter names are not aliased; they all start with an upper case letter, while most parameter values are in lower case.
Of the first four parameters, the tool name and the topic are required, while error count and other fields are usefully defaulted. There are

  • more parameters which are used by specifying their value,
  • a set of yes/no (true/false) parameters which default is "no" (false),
  • the three parameters to describe a digital alteration
  • the parameters to describe possible SVG bugs, and
  • parameters to format the possible display of source codes.

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 message occurs when this parameter is missing, or when no such template exists.
The parameter value is case sensitive. All the template names can be used, e.g.

(more than 100 "Created with ..." templates)

W3C error count

The parameter not specified, or with 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

The parameter not specified, or with yes, includes the {{InFi}} treatment to create the field name. Specified with no it performs a {{Clr}}.

Take care: Not specified is treated differently from an empty definition !

An empty specification "Other fields=" does nothing, like the specification "Other fields=none".

  • recommended: when used with "other fields" of {{Information}}, do not specify it, or with "yes"
  • deprecated: when used outside of {{Information}}, 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.

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 five different parameter names, to generate different color box layouts:

  • Colorbox00 generates boxes with {{Legend}} from parameter pairs
  • Colorbox-l generates boxes with {{Legend}} from single parameters ¹)
  • Colorbox-m generates boxes with {{Legend-small}} from parameter pairs
  • Colorbox-s generates boxes with {{Legend-small}} from single parameters
  • Colorbox-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"

Bad/Fake/Topic 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. Only either one of these three 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 modifications
  • Modifier can describe the editor of the alterations, in general it will be a link to a user name
  • Original can describe the original 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
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=
|Other tool=
|Graphic lab=
|Tincture=
|Colorbox=
|Broken file=
|Superseded by=
|Supersedes=
|Prefix=
|Trailer=

|Superseded=
|Commonist=
|Text embedded=
|Text as path=
|Large file=
|Easy border=
|PGF data=
|Traced SVG=
|Bad SVG=  
|Topo SVG=  
|Fake SVG=
|Fictional=
|Simplified SVG=
|Textedit only=
|Draw 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=
|Format=
|Collapse=
|Explanation=
|Diffusion=
|Footnote=
|Code=