Template:Image generation
es werden die entsprechenden Kategorisierungen vorgenommen — diese können zahlreich sein.
the appropriate categorizing occurs — it may result in many categories.
la catégorisation appropriée a lieu - il peut en résulter de nombreuses catégories.
 | Note: This template is used on a great 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.
Afterwards, changes can initially be done at and tested with Template:Image generation/sandbox: [].
|
 | Please test any changes in the template's /sandbox and consider discussing changes at the talk page before implementing them. |
 | Uses Lua: |
- W3C validation
- SVG tool
- optional: SVG code used for creation
and 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 than |other fields={{Igen|C|+|<}} which does exactly the same.
Igen/coa was a version for Coats of arms, in special with COAInformation.
Now Coats of arms are serviced with COAInformation and IgenCoa, after conversion.
Usage
Or use the shorthandSee 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 code, or expressed like in the following examples:
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 contains either
- tool name abbreviation letter (default:
Ifor Inkscape) - tool name
- parameters
%,~,!,?,§,&,<,^,>or sign$,+,-and more.
- tool name abbreviation letter (default:
- parameter #2 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.
- parameters
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}}}"
Abbreviation of the tool name, case-insensitive:
Note: "
| Inkscape | optional | |
2 | either character "v" (valid) (if absent, v is assumed with SVG files)
e=) | v | optional | |
3[1] | necessary because the template cannot determine from where it is transcluded:
Note: when a 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
If any one of these seven parameters is specified the " $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
| empty | optional | |
eerr | error count | when invalid SVG: error count from W3C validation ("0" for valid, "-1" for uncheckable) (has precedence over any argument of parameter 2) Other tool is always implied. | empty | optional |
mmore | more text | optional additional text (use M= to precede that text with a space) | . | optional |
c[2]cat | categories | category/categories, complete with brackets (and sorting), or without; or suppress with c=-plain text without brackets becomes completed with [[Category: ]] | empty | optional |
C | Color | the tincture can be defined | empty | optional |
cb | color boxes | for more details see section #Color boxes | empty | optional |
s[2]sub | subcategory | suffix to the category name for diffusion but also an information for subtemplates
| empty | optional |
kkey | sort key | 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 |
vvt vtxt | valid, invalid | additional text for Valid/Invalid SVG box (use V= to precede that text with a space) | empty | optional |
oopt | option | to set or overwrite the display source option for ValidSVG/InvalidSVG | empty | optional |
nname | tool name | 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 |
uuser U by | user | user name, or other text. May be coded e.g. with {{U}}, {{Uc}}, {{Ud}}, {{Ut}}, … Use by creates a user link. May be coded with "[" or "{" (see {{By}}) | empty | optional |
codec1…c3 | code display | display of the source code used for generation, e.g. the SVG code. In this case
| empty | optional |
vsub[2]Vs | vsub | 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[2]vstyle | vstyle | vstyle option: vs= or vs=fl for float-left (= same line) | - | optional |
pP | preceding | additional preceding text; to be displayed left or above of the boxes | empty | optional |
tT | trailing text | additional trailing text; is displayed right or below of the boxes If tags or secondary tools should appear in another sequence, use
T cares for a newline before | empty | optional |
ggl | graphic lab | specify the national {{Graphic lab}} with the ISO 639-1 language code (uses the topics-subcategory), e.g. | empty | optional |
r[2] | retouched | specify the {{Retouched picture}}, with parameters r= and editor= editoff= orig= origoff= See Retouched picture for more information. | empty | optional |
w[2] | what (topic) | With w= the topic can be altered or suppressedSee 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.
Specific information
Subtemplates
The template uses several specific subtemplates, e.g.
- {{Nil2}} – 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/Image}}- {{Igen/cod}} – for syntax of {{Created with code}}
- {{Igen/csd}} – creates subcategory differentiation
- {{Igen/csf}} – checks whether an SVG drawing is a structural formula
- {{Igen/cwt}} – analizer whether tool exists
- {{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/glc}} – Graphic Lab CoA treatment
- {{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/twt}} – adapter for {{Taken with}}
- {{Igen/THV}} – display & caregorize THV
- {{Igen/upl}} – extends one-letter-codes to category names
- {{Igen/wph}} – Wikipedia Project Heraldry display
- {{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
- ↑ a b c 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. - ↑ a b c d e f g h i j k 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
| Input | Result |
|---|---|
{{ Igen | I }}
|
|
{{ Igen | I | cf = n }}
|
|
{{ Igen | I | 1 }}
|
 This W3C-invalid vector image was created with Inkscape. {{ Igen | I | e = 1 }}
|
{{ Igen | I | + }}
|
see next line how it appears in the Information box |
| SVG development |  This vector image was created with Inkscape. |
{{ Igen | - }}
|
( "nil" transclusion - it does nothing) |
{{ Igen | A }}
|
 This graphic was created with Adobe Illustrator. |
{{ Igen | A$ }}
|
This graphic was created with Adobe Illustrator.  This file was uploaded with Commonist. |
{{ Igen | IA }}
|
This graphic was created with Adobe Illustrator,  and with Inkscape. |
{{ Igen | Im }}
|
 |
{{ Igen | B }}
|
 This structural formula was created with BKchem-Inkscape. |
{{ Igen | C }}
|
 This structural formula was created with ChemDraw. |
{{ Igen | D }}
|
|
{{ Igen | H }}
|
 . |
{{ Igen | G }}
|
 This plot was created with Gnuplot. |
{{ Igen | J }}
|
 This plot was created with JFreeChart. |
{{ Igen | L | n }}
|
 This graphic was created with LibreOffice. |
{{ Igen | M | s | e = 0 }}
|
 This vector image was created with MetaPost. |
{{ Igen | P | o = n | e = 1 }}
|
 This W3C-invalid vector image was created with pstoedit. |
{{ Igen | U | 12 | > }}
|
 This oversized W3C-invalid vector image was created with an unknown tool. |
{{ Igen | Q | 17 | e = 23 }}
|
 This W3C-invalid vector image was created with QGIS. err= value has precedence) |
{{ Igen | S | $ }}
|
|
{{ Igen | ArcMap }}
|
name "ArcMap" |
{{ Igen | GeoGebra | n }}
|
"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
nat parameter #2 clarifies that the file is non-SVG - to tag a file which is not SVG the
nneeds 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
| placement | other fields | standalone | ||||||
| parameters | p1 | p2 | p3 | p4 | p1 | p2 | p3 | p4 |
|---|---|---|---|---|---|---|---|---|
| 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=0for "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
sbspecifies thesize-before, andsathesize-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:
default (parameter skipped, orvs=-/vs=n) - small layout with 2 lines:
vs=(orvs=flfor "float-left") - medium layout, 3 lines:
vs=z(orvs=Z) - large layout with 3 lines:
vswith 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 tincture variation.
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;
it can as well be expressed as an argument of {{Xconv}}, e.g. {{ Xconv | rgb(204,51,102) }} ( ), or {{ Xconv | 75%50%100% }} ( ) - The second parameter can specify a descriptional text, e.g. "rouge" or something else, it may also be a (wiki)link;
it can as well be expressed as an argument of {{Xconv}}. When it is missing (specified empty), 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: |
- 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 |
+/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 |
+/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 |
+/S/xxx/xxx/... or /S/xxx/xxx/...
|
Color box(es) |
| Tbc | pairs | none or "e" | T |
/T/xxx/yyy/... or e/T/xxx/yyy/...
|
Used color(s) ⁵) |
- ³)
/ /xxx/yyy/...can as well be writtenxxx/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}}/ ...
- without the
+(just|cb=/) flags will get the field name "Flag colors".
See some examples of using cb (with control code 2: B, D, M, S and T) and of += at Category:Wikimedia 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:
/T/#900/wikidata red/#396/wikidata green/#069/wikidata blue |
hexadecimal triplets & names |
/T/argent//céleste//gules//sable |
tinctures w/o names |
/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.
Category
All the Created with ... templates categorize to "Created with ...", the SVG created with ... templates to "[in]valid SVG created with ...".
This automatic generated category can be customized with subcategory specification and/or sorting keys (key=).
- It is strongly recommended to change that reasonable categorizing only in cases of very good reason!
With the parameter "cat=" (or short "c=", also "category=") the automatic categorizing can be overwritten:
- with
cat=-every categorization will be suppressed (it can as well be done with "cat=n" or just "cat="). - another value without "[[" brackets (e.g.
cat=xxx), will be completed with the specified values of subcategory and/or sorting key, brackets and namespace:
e.g.[[Category:{{{cat}}}{{{sub|}}}|{{{key|}}}]] - when the value starts with brackets (e.g.
cat=[[…), it will be used as-it-is: nothing is changed, specified values of the parameters sub and key are then ignored.
Other parameters for categories:
■ !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 |
cw= the "Created with" category
|
The parameter cw has three functions:
- the
logowill be {{ F | {{{cw}}} logo.svg }} - the
toolnamewill be the link {{ W | {{{cw}}} }} - the
categorywill be {{ C | Created with {{{cw}}} }}
to simulate together with e.g. Other tool a not-yet existent tool.
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 parameters:=orsub:=
{the display occurs with "lcfirst"; to force an "ucfirst" the parametersu:=can be used). - or when this suffix string needs to be prefixed with a hyphen "
-" use the parameters-=orsub-=.
- when this suffix string needs to be prefixed with a semicolon "
- 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 |
With the parameter sd= always a subcategory differentiation can be defined.
Topics
See also: Template:Igen/top. 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
See also: Template:Igen/top. 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"
See also: Template:Igen/top. 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".
Graphic Lab
For the connection of files with the Graphic Lab exist multiple possibilities.
Graphic labs are in general for all images, special subcategories exist for coats of arms, flags and maps.
Dependent to the need these are divided into more subcategories, and e.g. the CoA Lab-fr has many user subcats.
Some graphic lab subcategories contain only a few items, while others are extremly crowded and may need further subcategorizing.
Image generation knows many two-letter codes for graphic lab access, consisting of the letter g for graphic lab, and another character for the nationality.
Comparable to the Template:W which also has in most cases a one-letter abbreviation for the national Wikipedia, this system is effectiv but has limits.
Because of the manageable total of graphic labs, this seems sufficient and clear enough: f stands for fr, h for hu, i for it and so on.
With the two-letter code g× as parameter at any position Igen is enforced to a special treatment; most of it is done by the subtemplate Igen/lab.
User category: can be defined with the two-letter-code specifying a user name, e.g. gH=ARK|s=c categorizes the file to CoA Lab-ch:ARK.
Same can be done with |u=ARK|gH|s=c. To avoid categorization, write |u=ARK|s=c|gH=
The conversion script
To avoid the necessity of defining ever and ever again long parameter combinations, such defintions can be deposited for each user and automatically transfered.
From each definition, the module creates a complete {{ Igen | ... | ... | ... }} transclusion parameter and passes it to the file description.
It is possible to have more than one definition for a user (with different keys!), and the parameter values can be manually modified.
This treatment in intended for coats of arms using the Template:COAInformation but it can as well be used for any other file;
an interface template can serve for the connection to the module and the stored parameters.
The definitions are stored in a module-intern LUA table; it needs some care but not much skill to modify it or to add definitions.
The automatism is done by the cleanup script, which can be performed as the last step of different flow modes.
These are the different flows:
| 1: ToCoa only | ToCoa script | e1 | |||
| 2: ToCoa & SVG | ToCoa script | e1 | SVGcheck script | cleanupscript | e2 |
| 3: Coa + cleanup | ToCoa script | e1 | ---------------→ | cleanupscript | e2 |
| 4: SVGcheck | SVGcheck script | cleanup script | e2 | ||
| 5: cleanup only | cleanup script | e2 |
- Explanation:
- 1) in any case, an Information template can be converted to a COAInformation template
e1after the conversation, the script offers the changed description in edit mode; final edits can be done before the conversion is saved.
- 2) for SVG files, after the steps as above the SVGcheck script can be started, which continues with the cleanup.
e2the cleanup script will offer the changed description in edit mode for final editing before it is published- after that publishing save, Imge generatkion will run and the success can immediately be seen;
- of course it will be better to have first a preview, to check whether it is free of errors and looks good !
- 3) after the conversion can directly proceeded to cleanup - for raster images th SVGcheck is not possible.
- 4) but for SVG images always the SVGcheck can be performed, which continues with the cleanup.
- The cleanup can be performed for any file, when necessary repeatedly.
In the case that a file description is done with COAInformation, the cleanup script compares the author name with an internal user list and provides the parameter |image = with the found key. Modifications can be done by the editing user before the changes are published.
The cleanup script can detect whether the image is an element or a raster graphic, and select the appropriate key;
but it cannot see whether it's an ecclesiastical image, this is evident only for the editing user who has to do the modification.
The Module IgenCoa
Keys for some national labs are further diffused, e.g.
| g_lab | coa | charges | eccles. | individ. | excl. cat |
| gd | d | dc | de | di | dx |
| ge | e | ec | ee | ei | ex |
| gf | f | fc | fe | fi | fx |
Parameter reference
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 extensionand/or\r=reasonwill 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|}}}
|
| ~ | {{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=Sall the parameters of SimplSVG or HandSVG can occur as well; - the many parameters when source code is to display are explained there
| Created with code | ||
|---|---|---|
| code | alias | description |
| c1 | code | the source code |
| d1 | diffusion of category | |
| e1 | explanatory text ahead | |
| f1 | style | format attributes |
| g1 | greater or smaller, and type of font | |
| h1[1] | title[1] | headline |
| l1 | syntax | language code |
| n1 | note afterwards | |
| 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", | ||
| Formatting parameters | ||
| +c | global field name | |
| cc | global category | |
| nt | global headline suppress | |
| p1 | number | headline "preferred", note byte count |
Final tags
to transclude templates with a 2-byte-code
| code | template | parm |
|---|---|---|
| ni | NoInkscape | 14 |
| nu | NoUpdate | 21 |
| re | Recent | 22 |
| up | Update needed/Outdated | 23 |
| lh | Logo history | 24 |
| ci | Current | 25 |
| dm | Disputed map | 43 |
| 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 |
| rd | Redrawn with Text Editor | 35 |
| fi | Fake sports logo | 36 |
| bf | Broken file | 37 |
| rs | Restoration | 38 |
| zf | zoofari | 39 |
| ob | Out of borders | 41 |
| ar | Artifacts | 42 |
| cb | Coablazon | 43 |
| rf | COAref | 44 |
Reference list
| code | alias | description |
|---|---|---|
| % %r %m %M %v %n %f %u %i %I |
the file contains translatable plain text; specifications are "r" for reduced display, with categorizing "m" like "r" for modifyable text "M" like "m" with the  box"v" for reduced display, no "n" for reduced display/numbers, no "f" for reduced display in same line, no "u" when the generated text is invisible. "i" recommends <switch> option "I" like "i" with the box
| |
| %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 (invisible) textual watermarks, %sc=subcat | |
| ~[1] ~k ~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 | |
| ! !c[1] !s[1] !k[1] |
the file contains embedded raster graphics Use !=a when it consists only of an embedded rasterUse !=f when the file is just a Fake SVGUse !=x when the file is a Fake SVG with just textUse !=t when it is only for topographic structuresUse !=r when it is for other required structuresother category ("-" for none), either full "[[.." or user name ( !c= has precedence over U= and u=)subcategory ("-" for none) a sorting key within the category | |
| ? ?b ?c ?f ?o ?p ?r ?u ?x ?s[1] ?w ?t ?k ?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 (see {{Rsvg bug}} docu) topic tool sortkey file name for {{Technically replaced}} |
| § §s |
the file is inadequately vectorized possible subcategorizing | |
| & && &c[1] &k & l[1]&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 <l <s <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 only number(s) path text, no due to Librsvg restrictions, no possible subcategorizing no categorizing | |
| ^ ^s ^t ^p ^c ^w ^b |
type: Quality image and/or Valued image: see Igen/qui. scope timestamp page category (prefixed by 'Valued image of ') topic by | |
| > >c[1] |
the file size is too large to display the source code>c=- to suppress categorization
| |
| × ×c[1] ×d ×k ×n[1] ×s ×t[1] ×× |
the file is extremly simple and easy to draw manually or ×=- to suppress categorization display size for the example, in pixel key but it is nowhere used – not worth any effort ! subc topic for subcategorizing, e.g. m, c, f, ... flag with {{UseXML}} (see examples) | |
| $ $c[1] $f[1] $l[1] $s[1] $m $u $w |
cf[1] cl[1] cs[1] cm cu |
the file was Uploaded with Commonist Commonist category, e.g. [[Category:Othercat| ]]Commonist linefeed_before, e.g. $f=brCommonist logo, e.g. [[File:xyz.svg|20px]]Commonist subcategory Commonist "more" text, e.g. explanationCommonist user, e.g. {{U|user}}to display a topic for Commonist |
| + +c |
to generate the parameter Name= for {{Information field}}field name for Created with code | |
| – | 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=
|
| \- \-r \-x \-t \-l |
\ \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 ←=tta 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 bfc |
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 2nd 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 fwt fws |
Fotowerkstatt, with optional parameters (see description) changes editor orig orig-lang topic style | |
| g gb gc gd ge gf gH gi gj gP gr gs gt gw g= xxgc= 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-ch"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=sv for "Graphic Lab-sv"or g=tr for "Graphic Lab-tr"or g=ws for "Graphic workshop"for other " Graphic Lab-xx", if exists(use g=Fi for "Graphic Lab-fi") 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[1] K |
key |
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 |
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 |
tool name of Other tool / Unknown SVG facilityupper 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 ( | |
| rd | for Template:Redrawn with Text Editor | |
| re | for Template:Recent | |
| rf | for Template:COAref | |
| s S s:, su: S: s- |
sub[1] sub: 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 |
| S* | to use {{sni}} | |
| S+ | to use {{sni}}, with parameter %p | |
| S& | to use {{rd}} & {{sni}} | |
| sa sb |
size (actual) for template SimplSVG size (before) | |
| sc | sc=u to prevent the lowercasing of the 1st 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 t l[1]tc[1] tu[1] tx[1] |
specify a tool (camera) for {{Taken with}} logo or "-" category or "-" username or "-" text or "-" | |
| u U |
user by |
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 |
additional validation text upper case "V" with space |
| w[1] |
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 | |