Template:Image generation

This graphic was created with Inkscape.

Template documentation[view] [edit] [history] [purge]

Note: This template is used on a lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.

Editing a template causes all pages that use the template to be re-rendered. If the template is used often, this can put a lot of load on the servers since it fills up the job queue.
Keep in mind that templates that are used on file description pages also show up on other wikis.

Please test any changes in the template's /sandbox and consider discussing changes at the talk page before implementing them.

Uses Lua:

Module:Igenmod

Short notation for the SVG created with ... templates and the non-SVG Created with ... templates, helps to display

W3C validation
SVG tool
optional: SVG code used for creation
WWWWwand a great number of other taggings formatted within one single line.

Categorisings occur depending on tool name, validation and other tags.

Some parameters/tags are only for SVG files, a few others only for raster images.

In case of difficulties using this template, its tag codes and this documentation,
you may use the Script support, or the easier template:File generation description.

Parameters for File generation description can be e.g.

 | other fields = {{ File generation description
  | SVG tool = ChemDraw
  | W3C error count = 0
  | Topic = structural formula
  | Text as path = yes }}

less cryptic than0 |other fields={{Igen|C|+|<}} 0which does exactly the same.

Igen/coa is a version for Coats of arms, in special with COAInformation.

Usage

Or use the shorthand {{Igen|… parameters as described …}} (like magyarul "igen" = "yes")

See also the template {{Creation}} for simpler usages within the Information box.

`Script support`

A user-script has been developed to help you maintaining the file description. Simply paste the following three lines into your common.js (or other MediaWiki skin related) JavaScript page. You can also edit this (script page) per user-preferences:

// [[User:Perhelion/simpleSVGcheck.js]]
if (mw.config.get('wgNamespaceNumber') === 6 && /SVG/i.test(mw.config.get('wgTitle').slice(-3)))
	mw.loader.load('//commons.wikimedia.org/w/index.php?title=User:Perhelion/simpleSVGcheck.js&action=raw&ctype=text/javascript');

Replace the script name with User:Sarang/simpleSVGcheck.js to work with the newest version: many enhancements, errors should be reported to Sarang.

The offered script support enables users – even novice users! – to use the template without knowing all details of its parametrizing.
The script cares for the most essential settings, and does a lot of standardizing the file descriptions when they are in need of being tidied up.
Expert users can complete the suggestions made from the script (e.g. by adding more tags) before saving the script’s changes of the file description page.

Alternative template

The template:File generation description is a version with descriptive parameter names for users not liking the cryptic short codes.
Most taggings can be specified in a better human-readable format with this more talkative template.
A rich and detailed documentation explains how easy it is to use that option.

Other tags

Can be set either by a shorthand notation, or expressed like in the following examples:

{{Add languages}}
{{BadSVG}}, {{TopoSVG}}, {{FakeSVG}}
{{Broken file}}
{{Cdata}}
{{Colorblind}} (bl)
{{Commonist}}
{{Convert to SVG}}
{{Convert to international}} (in)
{{Convert to multilang}} (ml)
{{Convert to wikichart}} (wc)
{{Convert to wikitable}} (wt)
{{Created with code}}
{{Current}} (ci)
{{Easy-border}}
{{Fictional}},
{{Fictitious flag}} (ff),
{{Fake sports logo}}
{{Fotowerkstatt}}
{{Graphic Lab}}:
{{Projet Blasons}},
{{Projekt Wappen}}
{{Large SVG}}
{{NoInkscape}} (ni)*
{{NoUpdate}} (nu)*
{{Logo history}} (lh)
{{Path text SVG}}
{{Opaque}} (oq)
{{Overlay}} (ov)
{{PDF version available}}
{{Quality image}},
{{Valued image}}
{{QGIS}}
{{Recent}} (re)
{{Retouched picture}}
{{Rsvg bug}}
{{Should be text}}
{{SimplSVG}}
{{Scripted SVG}}
{{Superseded}}
{{SVG 1.2}}
{{Taken with ...}}
{{Technically replaced}}
{{Tincture}}
{{TracedSVG}}
{{Translate}} (tr)
{{Update}} (up)
{{Valid SVG}} or {{Invalid SVG}}
{{Vector version available}}

Parameter settings

The flexibility of parameter definition allows to use the template with high variability. The same result can be achieved by different settings.
All parameters are optional; when used, unnamed

parameter #1 0 contains either

tool name abbreviation letter (default: I for Inkscape)
tool name
parameters %, ~, !, ?, §, &, <, ^, > or sign $, +, - and more.

parameter #2 0 contains either

v, n, s,
numeric error count (W3C),
parameters %, ~, !, ?, §, &, <, ^, > or sign $, +, - and more.

See also #Parameter 2

parameter #3 to #9 contains each one either

parameters %, ~, !, ?, §, &, <, ^, > or sign $, +, - and more.

It is recommended always to specify the tool with parameter #1. Files defaulted to Inkscape are collected in a maintenence category.

Template parameters

Parameter	Description	Default	Status
`1`	Name of the tool (case sensitive) to get the template name "Created with {{{1}}}" or Abbreviation of the tool name, case-insensitive: `A` for {{Adobe Illustrator}} `AH` for {{Adobe-hand}} `B` for {{BKchem}} `C` for {{ChemDraw}} `D` for {{CorelDRAW}} `E` for {{ElCompLib}} `F` for {{Fig2SVG}} `G` for {{Gnuplot}} `H` for {{Inkscape-hand}} `I` for {{Inkscape}} (default tool) `J` for {{JFreeChart}} `L` for {{LibreOffice}} `M` for {{MetaPost}} `O` for {{Other tool}} `P` for {{Pstoedit}} `Q` for {{QGIS}} `R` for {{R}} `S` for {{Sodipodi}} `T` for {{Text Editor}} via the adapter {{HandSVG}} `U` for {{Unknown tool}} `V` for {{Vim}} `VM` for {{Vector Magic}} `W` for {{Winplot}} `X` for {{Extracted with Inkscape}} Note: "`A$`" abbreviates for "Adobe and Commonist" ww"`IA`" abbreviates for the mixture Inkscape & Adobe ww"`Ih`" abbreviates `{{Inkscape-hand}}` ww"`IH`" abbreviates `{{Inkscape-hand}} without` {{HandSVG}} ww"`Im`" abbreviates `{{Inkscape\|…\|IMPORTANT=yes}}` ww"`Ic`" abbreviates `{{Inkscape}} and SVG cleaner postprocessing` ww"`Io`" abbreviates `{{Inkscape}} and SVGO postprocessing` ww"`I$`" abbreviates for "Inkscape and Commonist" ww"`ItB`" abbreviates `{{Inkscape to Bitmap}}` ww"`S-`" abbreviates for "Simplified SVG", drawn with Text Editor	`Inkscape`	optional
`2`	either character "v" (valid) (if absent, `v` is assumed with SVG files) or the numeric error count from W3C validation ("0" ≘ "v", "-1" ≘ uncheckable) or character "s" to suppress the W3C-box for SVG files (but with error count `e=`) See the detailed information for parameter #2 and suppress W3C	`v`	optional
`3^[1]`	necessary because the template cannot determine from where it is transcluded: a "-" (minus sign) to terminate the left-floating with {{Clr}} Can be necessary if the template is used outside* the {{Information}} box* a "+" (plus sign) when used in `\|Other fields` or `\|Other fields 1`. In this case parameter `fn=` may specify a `field name` for {{Information field}} Note: when a `field name` is specified, parameter "`+`" is implied and can be omitted; Note2: otherwise the `field name` "development" is nationalized by {{I18n/COA}}	empty	optional
`4^[1]`	a "$" (dollar sign) when " Uploaded with Commonist" should be added. In this case parameter `$u=` may specify a user, e.g. {{U\|user}} parameter `$l=` may specify a logo (☭), e.g. [[File:xyz.svg\|20px]]^[2] parameter `$m=` may specify a more, e.g.   explanation parameter `$c=` may specify a category, e.g. [[Category:Othercat\| ]]^[2] parameter `$s=` may specify a subcategory, e.g. `:diffusion`^[2] parameter `$w=` may specify a topic, e.g. `m` or `projection` parameter `$f=` may specify a linefeed before, e.g. `br`, `clr (default: none`^[2]) If any one of these seven parameters is specified the "`$`" is implied and can be omitted; for `$l`, `$c`, `$s` or `$f` it is enough if the supression is defined with an empty value e.g. `$c=`	empty	optional
`5^[1]^[3]`	For additional parametrizing see individual information a "%" (percent sign) or "%v" to insert the {{Translate}} tag, "%s" when option <switch>. a "~" (squiggle sign) to insert the {{pgf-Cdata}} tag. an "`!`" (exclamation mark) to insert the {{BadSVG}} tag. a "?" (question mark) to insert the {{Rsvg bug}} tag. a "§" ("section" sign) to insert the {{TracedSVG}} tag. an "&" (ampersand) to insert the {{QGIS}} tag. a "<" ("less" sign) to insert the {{Path text SVG}} tag. a "`^`" (circumflex sign) to insert the {{Quality image}} tag. a ">" ("greater" sign) to inhibit for large SVG the "show source" validator option. a "`×`" (multiplication sign) to insert the {{draw by hand}} tag. a "`\-`" (backslash&minus) or "\" to insert the {{Superseded}} tag, or a "`\+`" (backslash&plus) to insert the {{Supersedes}} tag', or a "`\\`" (backslash twice) to insert the {{VVA}} tag. a "`\#`" (backslash&number) to insert {{PDF version available}}. an "→" (arrow right) or "⇒" to insert the {{Convert to SVG}} tag. an "←" (arrow left) to insert the {{NoInkscape}} tag. a "`°`" (degree sign) to insert the {{Easy border}} tag.	empty	optional
`e[rr]`	when invalid SVG: error count from W3C validation ("0" for valid, "-1" for uncheckable) (has precedence over any argument of parameter 2) Note: when uncheckability is specified, `Other tool` is always implied.	empty	optional
`m[ore]`	optional additional text (use `M=` to precede that text with a space)	`.`	optional
`c[at]^[2]`	category/categories, complete with brackets (and sorting), or without; or suppress with `c=-` plain text without brackets becomes completed with `[[Category: ]]`	empty	optional
`C`	the tincture can be defined	empty	optional
`s[ub]^[2]`	suffix to the category name for diffusion but also an information for subtemplates `sub=` is used only for category diffusion (use `sub=-` for no diffusion) `S=` (upper case) like `sub=`, with the insertion of an inbetween space `s:=`, `s-=` (lower case) with insertions, see #Subcat & topic `s=` (lower case) can be used instead, or in addition to all the above; With a one-letter-code for `s=` the topics-subcategory may be defined, as :CoA, :Diagrams, :Flags, :Icons, :Logos, :Maps, :Signs, :Unicode, :Trigonometry, When `sub`/`S` and `s` are both defined, `sub`/`S` is used for subcategorizing, and `s` is used (like `w`) as an information and topic for several subtemplates Select the best fitting subcategory, or create an appropriate new one	empty	optional
`k[ey]`	key for sorting within the category (use `K=` for the insertion of a preceding space) `key` is used e.g. for category sorting, and in HandSVG for subcategorizing	empty	optional
`v[t[xt]]`	additional text for Valid/Invalid SVG box (use `V=` to precede that text with a space)	empty	optional
`o[pt]`	to set or overwrite the display source option for ValidSVG/InvalidSVG	empty	optional
`n[ame]`	a tool name or a description for {{Other tool}} Note: when `n[ame]` is specified, `Other tool` is implied and parameter 1 can be omitted	empty	optional
`u[ser] U by`	user name, or other text. May be coded e.g. with {{U}}, {{Uc}}, {{Ud}}, {{Ut}}, … Use `U=` to create the user link: `U=xyz` ⇒ `{{U\|xyz}}`. `by` creates a user link. May be coded with "[" or "{" (see {{By}})	empty	optional
`code c1`	display of the source code used for generation, e.g. the SVG code. In this case parameter `l1=` or `syntax=` may specify or change the code language (syntax) parameter `e1=` or `expl=` may specify explanatory text preceding the code block parameter `h1=` or `title=` may specify another headline, or suppress "`none`" parameter `f1=` or `format=` may specify format style options parameter `s1=` or `collapse=` may specify a title text for collapsability headline parameter `n1=` for a trailing note below of the code block More parameters with suffices "2" and "3" can be used for more codes: `c2=`, `l2=` or `code2` with `syntax2`, `title2`, `format2` etc. `c3=`, `l3=` or `code3` with `syntax3`, `title3`, `format3` and so on	empty	optional
`vsub^[2] Vs`	category diffusion `of Text editor` for e.g. HandSVG, Inkscape-Hand, Adobe-hand; Use `Vs=` for an inbetween space; set `vsub=-` to suppress the category diffusion.	`s`	optional
`vs[tyle]^[2]`	vstyle option: `vs=` or `vs=fl` for float-left (= same line)	`-`	optional
`p` or `P`	additional preceding text; to be displayed left or above of the boxes	empty	optional
`t T`	additional trailing text; is displayed right or below of the boxes If tags or secondary tools should appear in another sequence, use t2 (before Commonist} t3 (after Commonist, before `code`) t4 (immediately after `code`) WWWWWW } use uppercase "T " to precede with `<br>` t5 (before "Quality image") t6 (after QI, the last advantage tag, before all the disadvantage tags)	empty	optional
`g[l]`	specify the national Graphic lab with the ISO 639-1 language code (uses the topics-subcategory), e.g. `gl=it\|s=m` for the {{Laboratorio grafico mappa}} Abbreviations: "gd" for "g=de", "ge" for "g=es", "gf" for "g=fr", "gi" for "g=it", but "gl" for "g=en" Together with `s=c/f/m` the national heraldry project is achieved (e.g. de, es, fr). The parameters `gs=` may be used to specify the `style`, `gc=` for subcategorizing. See Graphic Lab/statistics for more information.	empty	optional
`r^[2]`	specify the {{Retouched picture}}, with parameters r= and editor= editoff= orig= origoff= See Retouched picture for more information.	empty	optional
`w[hat]^[2] topic^[2]`	With `w=` the topic can be altered or suppressed See also the subcategories description	`s`	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 is intended to be used within the {{Information}} box, e.g. at Other fields=, or anywhere outside

Because the prevalent majority of files belongs to Valid Inkscape, 1=Inkscape and 2=v are the default values
This defaulting is a failure; Inkscape-default categorizes to a maintenance category. See also Inkscape-undef.

The template uses several specific subtemplates, e.g.

{{Nil2}}0000 – decides whether {{Information field}} is used
{{I18n/COA}} – translation of the name
{{Igen/2nd}} – extends the codes *, @, ), \, ° to taggings
{{Igen/amp}} – analizes whether more than one SVG tool is used
{{Igen/bug}} – adapter to {{SVGbug}}
{{Igen/cat}} – tool for categorization
{{Igen/cbx}} – {{ColorBox}} together with {{Igen/cbox}}
{{Igen/coa}} – after textsplitting of {{COAInformation/Imgen}}
{{Igen/cod}} – for syntax of {{Created with code}}
{{Igen/csf}} – checks whether an SVG drawing is a structural formula
{{Igen/emb}} – embedded text is found
{{Igen/fgd}} – evaluates whether a topic is valid
{{Igen/fif}} – for fictional items
{{Igen/flg}} – subtemplate for Infobox flag
{{Igen/lab}} – adapter for {{Graphic lab}}
{{Igen/map}} – subtemplate for Map Infobox
{{Igen/nil}} – does absolutely nothing – nevertheless often used
{{Igen/par}} – analizes parameter 1 (tool name) and parameter 2 (error count}
{{Igen/ptx}} – path text is found
{{Igen/qui}} – adapter for {{Quality image}}
{{Igen/sni}} – displays text for "no inkscape"
{{Igen/sub}} – prepares the topic code for subcategorizion
{{Igen/swv}} – <switch> controlled variations
{{Igen/top}} – prepares the topic code for the display
{{Igen/trg}} – adapter for 'topographic raster graphics'
{{Igen/uns}} – for W3C-unspecifieds
{{Igen/twt}} – adapter for {{Taken with}}
{{Igen/upl}} – extends one-letter-codes to category names
{{BadSVG-t}}, {{Created with X}} and more.

Such subtemplating allows swift maintenance while the large main template does not need to be touched.

The template and its subtemplates are using several internationalization methods, like {{Autotranslate}} and {{LangSwitch}}.

Additional notes

↑ ^1.0 ^1.1 ^1.2 Every one of the signs ($, +, -) or parameters (%, ~, !, ?, §, &, <, ^, >, ×, \, →, ⇒, °, Ɨ) can be passed in any sequence, each as an argument for one of the unnamed parameters #1 through #9.
↑ ^2.00 ^2.01 ^2.02 ^2.03 ^2.04 ^2.05 ^2.06 ^2.07 ^2.08 ^2.09 ^2.10 This parameter allows supression with the parameter value "-" (or just the parameter without any value, e.g. cat=)
↑ Every one of the eight signs can be used either as a positional parameter, or as a named parameter passing the value to the corresponding template; see Named and unnamed parameters.

Because letters are used for the abbreviation of tool names, parameters #1 to #9 use other characters.

Examples

InputWWWWWWWWWWWWWWW	Result
`{{ Igen \| I }}`	This graphic was created with Inkscape
`{{ Igen \| I \| cf = n }}`	This graphic was created with Inkscape This SVG file was uploaded with Commonist.
`{{ Igen \| I \| 1 }}`	This W3C-invalid vector image was created with Inkscape 0 same as `{{ Igen \| I \| e = 1 }}`
`{{ Igen \| I \| + }}`	see next line how it appears in the Information box
SVG development InfoField	This vector image was created with Inkscape
`{{ Igen \| - }}`	( "nil" transclusion - it does nothing)
`{{ Igen \| A }}`	Template:Created with Adobe Illustrator
`{{ Igen \| A$ }}`	Template:Created with Adobe Illustrator This SVG file was uploaded with Commonist.
`{{ Igen \| IA }}`	Template:Created with Adobe Illustrator and with Inkscape.
`{{ Igen \| Im }}`	This graphic was created with Inkscape…important 0 option "IMPORTANT"
`{{ Igen \| B }}`	Template:Created with BKchem
`{{ Igen \| C }}`	Template:Created with ChemDraw
`{{ Igen \| D }}`	Template:Created with CorelDRAW
`{{ Igen \| H }}`	Template:Created with Inkscape-hand
`{{ Igen \| G }}`	Template:Created with Gnuplot
`{{ Igen \| J }}`	Template:Created with JFreeChart
`{{ Igen \| L \| n }}`	Template:Created with LibreOffice0 Raster graphics without W3C
`{{ Igen \| M \| s \| e = 0 }}`	Template:Created with MetaPost0 due to "s" without W3C – set W3C error count!
`{{ Igen \| P \| o = n \| e = 1 }}`	Template:Created with Pstoedit0 due to "opt=n" without W3C – set W3C error count!
`{{ Igen \| U \| 12 \| > }}`	This oversized W3C-invalid vector image was created with an unknown tool.
`{{ Igen \| Q \| 17 \| e = 23 }}`	Template:Created with QGIS :(from two given values 17 and 23, the `err=` value has precedence)
`{{ Igen \| S \| $ }}`	Template:Created with Sodipodi This SVG file was uploaded with Commonist.
`{{ Igen \| ArcMap }}`	Template:Created with ArcMap 0 name "ArcMap"
`{{ Igen \| GeoGebra \| n }}`	Template:Created with GeoGebra 0 "GeoGebra" non-SVG

When expressing some more options without expressing them by the shorthand parameters it can become a long line:
{{Image generation|Inkscape|v|+|u={{U|Username}}|s=:Drapeaux created by User:Username|m=-[[Help:Inkscape#Inkscape SVG vs. Plain SVG|''important'']]|t={{Translation possible}}{{Translate|switch=yes}}{{Cdata}}{{BadSVG}}{{SVGbug|description=hairline crack}}{{TracedSVG}}{{Path text SVG}}{{Quality image}}{{RetouchedPicture|1=Translation en → fr|editoff=Username|origoff=Carbon14 with activity labels.svg}}{{Projet Blasons}}{{Atelier graphique}}}}

Parameter table

The table shows for some given simple situations one of several possibilities to set parameters:

if the tool needs to be specified, it’s only possible with parameter #1
an error number can be specified either with parameter #2, or everywhere with err=
the n at parameter #2 clarifies that the file is non-SVG
to tag a file which is not SVG the n needs to be set with parameter #2
when used as an argument of Other fields, the + is necessary
when used outside the information box, the - may be necessary

parameters	p1	p2	p3	p1	p2	p3
placement	other fields			standalone
valid Inkscape	+			–
Inkscape 1 error	+	1		–	1
valid BKchem	B	+		B	–
Gnuplot 4 errors	G	4	+	G	4	–
Python raster	P	n	+	P	n	–
valid PHP	PHP	+		PHP	–
PHP 17 errors	PHP	17	+	PHP	17	–

Parameter 2

Parameter #2 has historically been the place to specify the file’s validation, as in transclusions like {{Inkscape||v}}. Now it may contain one of the following:

The character "v" to mark a valid SVG file. Because this is the default for SVG files it is not necessary to be specified and can be omitted.
The character "n" to mark a non-SVG file. Because this is the default for non-SVG files it is not necessary to be specified explicitly.
The character "s" to mark a SVG file with suppression of the W3C-box. To enable proper category sorting, "e= " must be specified explicitly (e=0 for "valid").
The W3C error count: either "0" (for a valid SVG), a number > zero or -1. This error count can also be given with the parameter e=. Default is "0".
The value "-1" for SVG code that can't be checked by the W3C validator (a common reason is the missing XML header which can be easily fixed); "Other tool" is implied, no need to specify it.
One of the signs $, +, - or %, ~, !, ?, §, &, <, ^, >. These can also occur as arguments for any one of the unnamed parameters #1 through #9.

Suppress the W3C-box

Parameter #2 set to "n" for raster graphics avoids the W3C-box and enables correct categorizing.
To suppress the W3C-box for SVG files, set parameter #2 to "s". When the SVG file contains W3C-errors, always set the e= parameter, otherwise e=0 to enable correct categorizing and sorting within the category. Setting "s" without "e=" let the file be W3C-unspecified.

If it seems necessary to tag a file with more than one generation tool, the other tool(s) can be added with e.g. t={{Created with ...|err=…|vo=n}}. The validator option vo set to "n" avoids to show the W3C-box again, while err must specify the error count (or "0") to categorize correctly, including the descending sorting within the category in the case of W3C-errors.

Template SimplSVG

To combine both the advantages of SimplSVG and Image generation it is possible to transclude the first one by the second.

This can be done by setting {{ Igen | … | … | + | S | and then the parameters for SimplSVG, followed by them for Image generation }}.
Keep in mind that the tool for the former image must be specified, while the Text Editor is always assumed as the tool for the simplified image!

An example may be e.g. File:Non-EU-section-with-MK-2012.svg with {{ Igen | I | 18034 | 272 | v | % | + | S }}
To suppress the categorization to SVG Simplified subcategories, use |S|sub=- (with -!), or short |S- (with -!).
S (or S-) can be specified at any position from 2 to 13 (S- even instead of the toolname T at position 1), e.g. 10=S (or 10=S-).
Exactly the same can be specified alterny with the parameters {{ Igen | I | + | sb = 18034 | sa = 272 | % | s = v }} ,

where sb specifies the size-before, and sa the size-actual;

for the template:File generation description that is expressed with the pair of numbers e.g. Simplified SVG = 18034/272

plus additional positional and named parameters for SimplSVG (like e.g. vs=-),
plus additional positional and named parameters for Igen like e.g. %, vsub= and/or T=.
No conflict can occur with the free-position parameters because SimplSVG uses letters, and Image generation uses other characters.

The layout can be controlled with the parameter vs:

mimimized layout, 1 line: 000 default (parameter skipped, or vs=- / vs=n)
small layout with 2 lines: vs= (or vs=fl for "float-left")
medium layout, 3 lines:0 vs=z (or vs=Z)
large layout with 3 lines:0 vs with any other value than the above

Color boxes

C: Tinctures can be specified with parameter C=, e.g. C=a/g/v or C=or/gules; the parameter Css= can be used to select another color shade.
cb: It is also possible to draw different Color Boxes above the other line(s) of the templates output. While the template:{{ColorString}} can be used everywhere, e.g. at the "description" field of the {{Information}} to draw such boxes, within Image generation the parameter cb= is provided for that. For File generation description the parameter Colorbox= does the same.
Parameter value: consists in each case of subparameters, separated by slashes.
In general, a pair of subparameters, or a series of such pairs is specified. The first parameter of each pair is a valid CSS color name, a valid Tincture name or a valid hexadecimal color code.
The second parameter can specify a descriptional text, e.g. "rouge" or something else, it may also be a (wiki)link; when it is missing, the first parameter is displayed.
These parameter values can be preceded by a pair of control characters: The first control code may be a "+" to generate a field name; other characters or none won't.
Control code 1 + will generate the standard field name as shown below, with += any other text can be specified.

Uses Lua:

Module:Color2dec

The second control code may specify the type of color boxes:

none or " " or "C" to use the template Legend with parameter pairs – the standard usage.
"B" to use the template ColorBox with single parameter values,
"D" to use the template ColorBox with parameter pairs,,
"L" to use the template Legend with single parameter values, ¹)
"M" to use the template Legend-small with parameter pairs, ²)
"S" to use the template Legend-small with single parameter values,
"T" to use the template Tbc with parameter pairs, and special treatment for the title.

¹) the "L" possibility exists just for completion – normally a "Legend" without an explaining second value will not be useful.

²) the "M" possibility can as well be specified with the second control code "-".

To show it again, formatted as a table:

template	parameters	control code 1	control code 2	Example (xxx/yyy/... stands for the parameter pairs)	field name (title) ⁴)
Legend	pairs	"+" or none	none	`+/ /xxx/yyy/...` or `+/C/xxx/yyy/...`³)	" "=Legend, "C"=Colour(s)
ColorBox	single	"+" or none	`B`000	`+/B/xxx/xxx/...` or `+/B/xxx/xxx/...`	Colour(s)
ColorBox	pairs	"+" or none	`D`	`+/D/xxx/yyy/...` or `+/D/xxx/yyy/...`	Colour(s)
Legend	single	"+" or none	`L`000	`+/L/xxx/xxx/...` or `+/L/xxx/xxx/...`	Legend
Legend-small	pairs	"+" or none	`M`	`+/-/xxx/yyy/...` or `+/M/xxx/yyy/...`	Colour(s)
Legend-small	single	"+" or none	`S`000	`+/S/xxx/xxx/...` or `v/S/xxx/xxx/...`	Color box(es)
Tbc	pairs	none or "e"	`T`	`v/T/xxx/yyy/...` or `e/T/xxx/yyy/...`	Used color(s) ⁵)

³) +/ /xxx/yyy/... can as well be written xxx/yyy/... (without the empty control characters)

but for the control code 2 instead of " " the value "C" may be used to title "Colors" instead of "Legend"

⁴) With the control code 1 += the free selection of another field name than the standard one is possible,, e.g. |cb=+={{I18n/Colors}}/ ...
See some examples of using cb (with control code 2: B, D, M, S and T) at Category:Gratispaideia icons.
Stripes and lines: Legend boxes can be striped by different patterns, and/or mixed with Legend-lines. See examples at the documentation.

Tbc needs decimal coded color codes. Internal functions can convert hexadecimal triplets, tincture names and CSS color names for Tbc.
Other color names are not decimalizable, because of that not all color names can be used for Tbc.
A field name is always created and can't be deselected, independent from the first control code (which can be "e" for Easy border).

Example strings for Tbc:

`e/T/#900/wikidata red/#396/wikidata green/#069/wikidata blue`	hexadecimal triplets & names
`e/T/argent//céleste//gules//sable`	tinctures w/o names
`e/T/CornflowerBlue/#6495ED/BlanchedAlmond/#FFEBCD`	CSS colors, and their hex codes for names
`e/T/#6495ED/blue/cendrée/gris/YellowGreen/green`	colors from mixed sources, + Easy border
`Guatemal colors/T/#FFFFFF/blanco/#4997D0/azul`	with individual `field name`
`<nowiki/> {{Wf\|Drapeau tricolore}}/T/#0055A4/bleu/#FFF/blanc/#EF4531/rouge`	with individual `field name`, + Easy border

⁵) (the individual field name starting with a space, e.g. "<nowiki/> ", for signalling the Easy border request)

SVG source code display

is performed centrally by Image generation; previously it had been an option of some single templates, now it can only be done when such a template is invoked by Image generation. The table shows where the code-categories are defined.

The documentation explains how the different parameters can be used to format the output; a short reference can be found below.

Subcategory specification

The template offers various possibilities to diffuse a category by subcategories.

With sub= a suffix to the category name is specified;
- when this suffix string needs to be prefixed with a semicolon ":" use the parameter s:= or sub:=
  {the display occurs with "lcfirst"; to force an "ucfirst" the parameter su:= can be used).
- or when this suffix string needs to be prefixed with a hyphen "-" use the parameter s-= or sub-=.
An uppercase S= does the same but an in-between space is inserted.
Recommended is to use the parameter s= which bears several advantages:

With a code of one letter (or an abbreviation of some letters) many predefined subcategories are accessable; the subtemplate Igen/sub cares for the expansion.
Such a short code is also used as a topic for the description by many other templates;
while Igen/sub expands only to subcategory names in English, the subtemplate Igen/top transposes multilingual.

Only in cases where the required topic differs from the subcategory, or no subcategory should come in effect, another code can be defined to substitute the s= value. This topic letter can be defined with the parameter topic= or what/w= and becomes expanded instead. ("w" for what= because the "t" had been used for "trailing text", and cannot be used to abbreviate topic=).
Other parameters for subcategories:

■ `!s`= for {{BadSVG}}s	`<s`= for {{Igen/ptx}}
■ `?s`= for {{Rsvg bug}}s	`§s`= for {{TracedSVG}}
■ `&s`= for e.g. {{QGIS}}	`$s`= for {{Commonist}}
■ `gc`= for {{Graphic Lab}}-xx 0

With the parameter sd= always a subcategory differentiation can be defined.

Topics

When as well s= and sub= or S= are defined, sub/S is used for subcategorizing (or suppression with sub=-) and s= can then be used like w= for topic specification. The topic option can alse be suppressed with w=-, independent from s/sub/S.
As said above, the parameter s can be used for subcategorizing; when no parameter topic= (or what/w=) is specified the value of s is also used for the topic text by the national versions of the Created with ... templates. Except of this defaulting the two parameters can be defined and/or suppressed completely independent from each other.
These tables show the conversion of s=, and the conversion & translation of w=.
These topics are passed to many other templates. While a few of the Created with ... templates have default topics defined, only an explicitely specified topic can be passed further.

Subcat & topic

It is also possible to define with one single parameter sub-category and topic, with a subcategory-separator semicolon ":" or minus "-".
Parameter values of "s:" and "s-" specify a subcategory; they are prefixd with a ":" resp. a "-", but except that they are used as-they-are.
When there is neither a parameter "topic", "what"/"w", nor "s" then the parameter values of "s:" / "s-" are used also for topics, with their first letter lower-cased, but not translated.

Parameter values of "s:" and "s-" specify a subcategory which is prefixed with a ":" resp. a "-", the first letter is capitalized and a final (plural-)"s" is added.
Example: s:=digit specifies the subcategory ":Digits" (as is done with s=7).
When there is neither a parameter "topic", "what"/"w", nor "s" then the parameter values of "s:" / "s-" are used also for topics, with their first letter lower-cased, but not translated.
Similar is the result with sub:= and sub-= but neither case changing nor adding of a plural-"s" occurs.
The parameters S: and Sub: are working like s: and sub:, with an additional space after the semicolon.

Usage of "s" and "w"

The parameter s= specifies a topic for subcategorization, and for the display (if no "w=" is specified).
The parameter w= specifies a topic only for the display; it will be nationalized into the user's language.
Example: |s=tl| specifies the subcategory :Text logos, and (without "w=") also the display text "text logo" in different languages;
but with |w=tl|s=l| the subcatory will be :Logos with the nationalized display text "text logo".

Named and unnamed parameters

Each one of the following parameter codes can be used either positional to set taggings with extern templates, or they can be used as parameter names to pass an individual information to the templates. The function is like using the templates with the |t= parameter, either without or with an individual information.
Example:

(positional) "?" can also be written as "t={{SVGbug}}"
(named p.) "?=rendering error" can also be written as "t={{SVGbug|description=rendering error}}"

In general: when subparameters exist, their specification makes the main parameter redundant.
As an example, \ or \=file name invokes {{Superseded}} resp. {{Bitmap version available}}.

\x=file extension and/or
\r=reason will invoke that template as well.

This option is valid for all subparameters.

code	template	passed individual information
% %r %v %f %i %s	{{Igen/emb}}	`\|1={{{%}}}\|2=s\|s={{{s\|}}}` `\|s={{{s\|}}}\|v=r` `\|s={{{s\|}}}\|v=v` `\|1=vf\|s={{{s\|}}}` `\|1=i\|s={{{s\|}}}` `\|1={{{%s}}}\|s={{{s\|}}}\|switch=yes`
~	{{Cdata}}	`\|sub={{{~}}}`
!	{{BadSVG}}	`\|1={{{!}}}\|subcat={{{!s\|}}}`
?	{{Rsvg bug}}	`\|description={{{?}}}\|sub={{{?s}}}`
§	{{TracedSVG}}	`\|1={{{§}}}\|s={{{s\|}}}`
&	{{QGIS}}	`\|1={{{&}}}\|2={{{&&\|}}}`
<	{{Igen/ptx}}	`\|sub={{{<}}}\|s={{{s\|}}}`
^	{{QI}}	`\|SVG={{{^}}}`
>	{{SVGvalid}}	`\|opt=<nowiki/>`
×	{{SimplSVG}}	`\|3={{{000}}}\|4={{{×\|}}}\|5={{{×d\|}}}`
\	{{Superseded}}	`\|1={{{\}}}\|2={{{\r\|}}}`
→	{{Convert to SVG}}	`\|1={{{→\|{{{w\|{{{s\|}}}}}}}}}`
°	{{Easy-border}}	`\|topic={{{°}}}`
ge	{{THV}}	`\|1={{{k\|}}}\|2={{{s\|}}}`

Reference of all parameters

For the setting of parameter #1 and parameter #2 see also #Parameter settings.
The following tables reference all other parameters possibly occurring;

when 10=S all the parameters of SimplSVG or HandSVG can occur as well;
the many parameters when source code is to display are explained there

000 Created with code 000
code	alias	description
c1	code	the source code
d1	text	categorization
e1	expl	explanatory text ahead
f1	style	format attributes
h1^[1]	title^[1]	headline
l1	syntax	language code
n1		note afterwards
p1		preceding note
s1^[1]	collapse^[1]	secluded
two more source codes can be shown; all the parameters are specified like for the first code, but with "2" resp. "3", e.g. `c2` or `code2` and so on
Formatting parameters
+c		global field name
cc		global category
nt		global headline suppress

Final tags

to transclude templates with a 2-byte-code

table
code	template	parm
ni	NoInkscape	14
nu	NoUpdate	21
re	Recent	22
up	Update needed/Outdated	23
lh	Logo history	24
ci	Current	25
ov	Overlay	26
oq	Opaque	27
tr	Translate	28
in	Convert to international	29
ml	Convert to multilang	30
wc	Convert to wikichart	31
wt	Convert to wikitable	32
bl	Colour blind	33
ff	Fictitious flag	34
zf	zoofari	39

code	alias	description
% -%r -%v -%n -%f -%u -%i		the file contains translatable plain text; specifications are "r" for reduced display, with categorizing "v" for reduced display, no ~~categorizing~~ "n" for reduced display/numbers, no ~~categorizing~~ "f" for reduced display in same line, no ~~categorizing~~. "u" when the generated text is invisible. "i" recommends <switch> option
%s %S %C		the file contains multilingual text using the switch option and it should not be maintained with Toolforge `<switch>` controlled variations, with categorizing
%a -%w		to transclude {{Add languages}} for textual watermarks
~^[1] 0~k 0~u		the file is bloated by Adobe PGF CDATA blocks (specify `~=n` to avoid subcategorization with u/U) possible sort key for the category user name for categorizing
! 0 0 0 0 00!c^[1] 00 00!s^[1]		the file contains embedded raster graphics Use `!=a` when it consists only of an embedded raster Use `!=f` when the file is just a Fake SVG Use `!=t` when it is only for topographic structures Use `!=r` when it is for other required structures other category ("-" for none), either full "[[.." or user name (`!c=` has precedence over `U=` and `u=`) subcategory ("-" for none)
? 0?b 0?c 0?f 0?o 0?p 0?r 0?u 0?x 00?s^[1] 00?w 00?t 00?k 00?n	⁇	the file contains SVG bugs blur bug compatibility former bug overwritten bug specify a `phab` number (see parameter 1) replaced bug unsolved bug flowRoot exception subcategory 000 (see {{Rsvg bug}} docu) topic tool sortkey file name for {{Technically replaced}}
§ 0§s		the file is inadequately vectorized possible subcategorizing
& 0&& 0&c^[1] 0&k 0&`l`^[1] 0&s^[1]		the file generation was participated by a with_tool &&=main_tool (default: Inkscape) &c to specify, or "-" suppress, the categorizing &k to specify a sort key &l to specify, or "-" suppress, a logo &s to specify a subcategory
< <h <i <x <v <n 0<s 0<c^[1]		the text has been converted to paths; specifications are "h" for highlighting (also with `<s=h`) "i" to specify that internationalization is required "x" for tagging with Should be text "v" for reduced text, no ~~categorizing~~. only number(s) path text, no ~~categorizing~~ possible subcategorizing no categorizing
^ 0^s 0^t 0^p 0^c 0^w 0^b		type: Quality image and/or Valued image: see Igen/qui. scope timestamp page category (prefixed by 'Valued image of ') topic by
> 0>c^[1]		the file size is too large to display the source code `>c=-` to suppress categorization
× 0×c^[1] 0×d 0×n^[1] 0×t^[1] 0××		the file is extremly simple and easy to draw manually or ×=- to suppress categorization display size for the example, in pixel but it is nowhere used – not worth any effort ! topic for subcategorizing, e.g. m, c, f, ... flag with {{UseXML}} (see examples)
$ 0$c^[1] 0$f^[1] 0$l^[1] 0$s^[1] 0$m 0$u 0$w	0 rcc^[1] rcf^[1] rcl^[1] rcs^[1] rcm rcu 0	the file was uploaded with Commonist Commonist category, e.g. `[[Category:Othercat\| ]]` Commonist linefeed_before, e.g. `$f=br` Commonist logo, e.g. `[[File:xyz.svg\|20px]]` Commonist subcategory Commonist "more" text, e.g. `  explanation` Commonist user, e.g. `{{U\|user}}` to display a topic for Commonist
+		to generate the parameter `Name=` for {{Information field}}
–		to generate a final {{clear-linefeed}}
\+ -\+r -\+t^[1] -\+u -\+l	\r \t^[1] \u \l	this file supersedes another one the reason for superseding topic (default: "w", "s" when not suppressed) option: by user option: `lang=`
\- 0 -\-r -\-x -\-t -\-l	\ 0 \r \x \t \l	the file is superseded by another one, or a Bitmap version exists for an SVG the reason for being superseded an extension (when not `.png`) topic option: `lang=`
\\ -\\r -\\q -\\l	\r \q \l	A vector version is available to that raster image reason text quality tag (s, i) option: `lang=`
\#		insert {{PDF version available}}.
→ ⇒		{{ `Convert to SVG` \| → }} {{ `Convert to SVG` \| ⇒ \| simple }}
← -←s -←t		{{NoInkscape}}: `←`, `←=+` , `←=-` or `←=tt` a style option for NoInkscape, e.g. `←s=0`/h /0h text for a topic in NoInkscape
°		{{ `Easy-border` \| topic = w/s \| pixel = ° }}
—		(U+2014) to categorize Unused SVG images
bf 0bfc		description for {{Broken file}} category
.ff		for Fictitious flag
.bl		for Template:Colorblind
by	U	creates a link to a user name; see Template:By
c^[1]	cat^[1]	change or suppress (`c=-`) category
cat2		name of an additional category that should be used
cb		Color box, see Igen/cbx and colorboxes
cc^[1]		suppress automatic categorization with ' code'
ci -ci2		the Template:{{Current}} interval, for frequent updates possible 2^nd parameter
cni^[1]		only for "Im": category text (or suppression: "-" for none) replaces SVG created with Inkscape:Important
ct	c_text	category text, replaces "created with"
C -Ct -Cc^[1] -Cl -Cf^[1] -C+^[1] -Css^[1]	- - - - c+^[1] ss^[1]	Tinctures a color for the tincture-"tc" parameter a category for the tincture-"cat" parameter ("-" for none) other label than "Tincture" Cf=n or Cf= for no field name "+" for field name (=default) `Css=BY` for Bavarian or other shades
cw		the "Created with" parameter, for logo/cat/tool
e	err	error count ≥ 0, instead of definition with parameter# 2
editor, editoff		parameters for Retouched picture (see `r`)
f -ft -fc		for fictional items, see Igen/fif for other topic for other category
.ff		for Fictitious flag
fn		field name for Information field, instead of the "+"
fw -fwc -fwe -fwo -fwl		Fotowerkstatt, with optional parameters (see description) -changes -editor -orig -orig-lang
g -gb -gc -gd -ge -gf -gi -gj -gP -gr -gw g=`xx` -gc= -gk= -gs=	`gl`	Graphic Lab; g or gl for "Graphic Lab-en" or `g=bn` for "Graphic Lab-bn" or `g=cm` for "Graphic Lab-Commons" or `g=de` for "Graphic Lab-de" or `g=es` for "Graphic Lab-es" or `g=fr` for "Graphic Lab-fr" or `g=it` for "Graphic Lab-it" or `g=he` for "Graphic Lab-he" or `g=pl` for "Graphic Lab-pl" or `g=ru` for "Graphic Lab-ru" or `g=ws` for "Graphic workshop" 00lfor other "`Graphic Lab-xx`", if exists a subcategory for an above Graphic Lab a category sorting key style for Graphic Lab, either nl (new line) or sx (small text)
-in		for Convert to international
k K	key 0	sort key for category (and for THV) upper case "K" with space
l	L	upload info, or categorization info
.lh		for Template:{{Logo history}}
m M	more 0	additional text (use `m=` to suppress the final dot) upper case "M" with space
.ml		for Convert to multilang
msg		additional message box(es)
n N	name 0	tool name of `Other tool` / `Unknown SVG facility` upper case "N" with space
-nu		for Template:NoUpdate
o	opt	W3C validator option (see vo / vopt)
-oq		for Template:Opaque
-ov		for Template:Overlay
orig, origoff		parameters for Retouched picture (see `r`)
p		preceding text
pu		previous user name (for SimplSVG)
r^[1] R		{{Retouched picture}} with parameters (upper case "R" for an advancing clear is not necessary) r/R= modifications (`r=-` if modifications unspecified) editor= / editoff= orig= / origoff=
.re		for Template:Recent
s S s:, su: S: s-	sub^[1] 0 sub:0 Sub: sub-	subcategory; lower case "s" with expand option upper case "S" with prefixed space "␢" `s:` to be prefixed with a semicolon ":" `S:` prefix with semicolon and space ":␢" `s-` to be prefixed with a hyphen/minus "-"
S	S-	to use Template:SimplSVG
sa sb		size (actual) for template SimplSVG size (before)
sc		`sc=u` to prevent the lowercasing of the 1^st `sub`-character
sd		subcategory differentiation
subcat^[1]	!s^[1]	topic for SVG images with embedded raster graphics:Topics
ss^[1]		see `Css`
source		additional text, currently only used by perl and ItB
t T	T1…T7	trailing text upper case "T" with an advancing clear
-tr		for Template:Translate
tw 0t`l`^[1] 0tc^[1] 0tu^[1] 0tx^[1]	0 0 0	specify a tool (camera) for {{Taken with}} logo or "-" category or "-" username or "-" text or "-"
u U	user 0by	user name (or user name link, e.g. {{Ut\|user}}) uppercase "U" creates the user name link
.up		for Template:Update = Outdated
vc vo vt vs^[1] vw	vcat vopt vtxt vstyle^[1] vwidth	validator categorization validator option (also o or opt) validator more-text validator style option, mainly for SimplSVG validator width (not used)
vsub^[1] Vs		subcategory of Text editor ("-" to suppress subcategorizing) "Vs" like "vsub" with space
v^[1] V	vt, vtxt 0	additional validation text upper case "V" with space
w^[1] 0	what^[1] topic^[1]	define (if other than `s`) or suppress (with `w=-`) the code for the topic
.wc		for Convert to wikichart
.wt		for Convert to wikitable
more parameters – mainly for the Created with ... templates (raster graphics)
par1		to specify e.g. a number
mode		e.g. the stacking mode
type, item, par2		not yet used

↑ ^1.00 ^1.01 ^1.02 ^1.03 ^1.04 ^1.05 ^1.06 ^1.07 ^1.08 ^1.09 ^1.10 ^1.11 ^1.12 ^1.13 ^1.14 ^1.15 ^1.16 ^1.17 ^1.18 ^1.19 ^1.20 ^1.21 ^1.22 ^1.23 ^1.24 ^1.25 ^1.26 ^1.27 ^1.28 ^1.29 ^1.30 ^1.31 ^1.32 ^1.33 ^1.34 ^1.35 ^1.36 ^1.37 ^1.38 ^1.39 ^1.40 ^1.41 ^1.42 ^1.43 ^1.44 ^1.45 ^1.46 ^1.47 ^1.48 ^1.49 ^1.50 ^1.51
Suppressable: to suppress the usage of the default value for a parameter "x", use x=- or x=n, or an empty value like x=.

The above documentation is transcluded from Template:Image generation/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

[a-1] 1.0 ^1.1 ^1.2 Every one of the signs ($, +, -) or parameters (%, ~, !, ?, §, &, <, ^, >, ×, \, →, ⇒, °, Ɨ) can be passed in any sequence, each as an argument for one of the unnamed parameters #1 through #9.

[c-2] 2.00 ^2.01 ^2.02 ^2.03 ^2.04 ^2.05 ^2.06 ^2.07 ^2.08 ^2.09 ^2.10 This parameter allows supression with the parameter value "-" (or just the parameter without any value, e.g. cat=)

[3] Every one of the eight signs can be used either as a positional parameter, or as a named parameter passing the value to the corresponding template; see Named and unnamed parameters.

[s-4] 1.00 ^1.01 ^1.02 ^1.03 ^1.04 ^1.05 ^1.06 ^1.07 ^1.08 ^1.09 ^1.10 ^1.11 ^1.12 ^1.13 ^1.14 ^1.15 ^1.16 ^1.17 ^1.18 ^1.19 ^1.20 ^1.21 ^1.22 ^1.23 ^1.24 ^1.25 ^1.26 ^1.27 ^1.28 ^1.29 ^1.30 ^1.31 ^1.32 ^1.33 ^1.34 ^1.35 ^1.36 ^1.37 ^1.38 ^1.39 ^1.40 ^1.41 ^1.42 ^1.43 ^1.44 ^1.45 ^1.46 ^1.47 ^1.48 ^1.49 ^1.50 ^1.51
Suppressable: to suppress the usage of the default value for a parameter "x", use x=- or x=n, or an empty value like x=.

[1]

[3]

[2]

[1]

■ `!c`= for BadSVGs	`^c`= for QI	`cc`= for Created with code/suppression
■ `&c`= for e.g. QGIS	`$c`= for Commonist
■ `<c`= for Path text	`>c`= for Large SVG files
■ `tc`= for Taken with	`Cc`= for Tincture
■ `fc`= for Fictional files	`bfc`= for Broken file
■ `cni`= for SVG created with Inkscape:Important 0	`cw`= the "Created with" category