Usage

This page is generated using a template designed to document templates rather than modules. Therefore, the synopsis right above is bogus, and the following "Template parameters" section is misnamed and its presentation is wrong. See instead Module usage.

Parameters in the module's argument

See also

Module usage

{{ #invoke:IgenCoa | main | parameter_string }}

Normally the user has nothing to do with this module, it works in the background.^{[clarification needed]}

The simpleSVGcheck.js script will generate a useful parameter_string for {{COAInformation}}, but it can be modified when necessary.

The format is |image=parameter_string; it can be either a complete {{Igen|....}} clause, or slash-separated parameters.

For example, |image={{Image generation|I|6|+|gf|s=eh}} stands for :

• SVG file created with Inkscape,
• for 'Projet:Blasons',
• showing ecclesiastical heraldry,
• W3C-invalid because of 6 W3C-errors;

Equivalent are |image = I/6/eh/gf and |image = Fe/6/tool~I, which shows the two main cases:

parameter 1 is the code for either a tool (like Inkscape), or the table key for the table of predefined user options.

Every single parameter can be modified, all parameters can be added, and each value transfer from the table can be excluded with the value -.

• When e.g. the tool "Adobe" is predefined, it can be substituted with e.g. /tool~I to Inkscape.
• When e.g. the topic "c" is predefined, it can be substituted with e.g. /s~ce to Coa-element.
• When e.g. no graphic lab is predefined, it can be added with e.g. /g~es to CoA Lab-es.
• When e.g. a graphic lab is predefined, it can be suppressed with the minus value e.g. /g~-.

Examples:

To add the tag % for embedded text, add /%

To add the tag ~ for PGF data, add /~;

to specify the user causing that^{[clarification needed]}, add /~~username (the first ~ is the tag, the second ~ is for the =)

Any other tag or parameter for {{Image generation}} can be specified this mode, positionals just preceded by a slash, named parameters with slash + name + tilde + value.

Spaces don't matter; /g~it is equal to / g ~ it.

Replacements:

For needed spaces pass the underscore _ (or the character ↔, U+2194 double arrow).

For needed slash use the backslash \ (or the broken bar ¦)

For needed backslash use the inverted exclamation ¡

User name:

For {{Igen}} the uppercase "U" and the lowercase "u" are mutually exclusive, U has precedence when both are specified.
By this module a "u" in the usertable is overwritten by a "U" in the usertable (therefore it has no sense to predefine both);
an input "u~" overwrites all values from the usertable, and an input "U~" overwrites (or suppresses) everything.
Note: A "u~" is just text, it is not necessarily a valid user name. It can be wikicode, as e.g. [[User:name|display]]

Modifying the table:

This is mere technical information for people wanting to change entries, or to add new ones.

• Entries for new users should be inserted in alphabetical order;

to distinguish, "c" is often used for charges (elements). and "e" for ecclesiasticals.^{[clarification needed]}

• up to 11 parameters can be defined for each entry, with nil for unused positions

when less than 11 are needed, further nil filling is not necessary after the last value.

• more user entries can be specified, there is no technical limit.

But some codes are reserved pseudo keys, e.g. for tools like "I", or for labs like "fi" for "fr" individuell.^{[clarification needed]}

g_lab	coa	element	eccles.	indiv.	catonly
g_d	d	dc	de	di	dx
g_e	e	ec	ee	ei	ex
g_f	f	fc	fe	fi	fx

These national wikipedias have projects which are linked standardwise, while the CoA Lab (parm 4) is linked "individuell":^{[clarification needed]}

Wp	Coa Lab	Project
de	di	dw = Wikipedia:WikiProjekt_Wappen
es	ei	ge = THV
fr	fi	gf = Projet:Blasons
pl	[ Pi ]	gP = WPGW vector image

• Simplification: A graphic lab modification is corrrectly written e.g image = Ph///dw
  but it will be understood when written image = Ph//dw or image = Ph/dw

The catonly option avoids the invocation of the Graphic Lab but categorizes to it, without the icon box.

Most predefinitions are for SVG files; raster images are drawn with often unknown tools.

All usernames and their keys must be also defined in the cleanup script.

For raster graphics, user keys of 2 characters become internally appended with an "r"; when userkey e.g. Ab is for SVG files, internal userkey Abr is for raster images. The cleanup script needs only one userkey for a user, for both SVG and non-SVG; it can detect whether it is a raster file, and an element ('charge'), but only the user can see if it's an ecclesiastical CoA.^{[clarification needed]}

It is very irritating that the topics used by Igen differ completely from the keys used in this table.

While for the topics the "c" was expanded to ce for "coa element", and eh for "eccelsiastical heraldry",

the table has to allow that one user may draw as well coa and elements and eccelsiasticals.

The user key "Uu" may get expanded with "c" for charges, or "e" for ecclesisatical, or "r" for raster images.

usage	coa	element	eccles.	raster
Igen topic	c	ce	eh
table key	Uu	Uuc	Uue	Uur

With modification, the Igen topic is the third parameter, e.g. |image = Uu//eh

Search mode: The search key may consist of two or three characters.

• three character key: first is searched whether that entry exists; when not and the third key character is c or e or r, another search is performed with this key reduced to two characters.
• two character key: first is searched whether that entry exists; when not and it is a raster image or an element, the key is expanded with r or c and another search is performed with this key.

A user may have up to four keys: the 2-character key and its expansions with c or e or r.

Table of the predefinitions

{{#invoke:IgenCoa|distab}} (sorted by key: first all the user keys, then the pseudo keys)^{[clarification needed]}