Module:IgenCoa/doc
CodeDiscussionEditHistoryLinksLink count Subpages:DocumentationTestsResultsSandboxLive code All modules
This is the documentation page for Module:IgenCoa
This module enables simplification when Template:COAInformation is used.
It is intended to generate the parameters for | image =
- to be invoked from Template:COAInformation with {{ #invoke: IgenCoa | main | parameter_string }}
- and to pass the returned code to the Template:Image generation. See the flow chart for more information.
For test purposes it can be invoked from other templates, and return to another template.
It is also possible to be invoked from files with Information-description, via the adapter template Igenc.
Be aware that the parameters need to be separated by slashes "/" and not by pipes "|"
The parameter is one string containing all the sub-parameters.
Therefore neither the pipe character, nor the equal sign can be used within this string.
These characters, when needed, had to be replaced: pipes by slashes, equal signs by tildes.
Usage
{{IgenCoa |1= }}
"Usage" above, and "Template parameters" below are nonsense in this case.
See instead Module usage.
Module parameters
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
1 | The only required parameter specifies
■ either a complete TK for User:TomKr), case-insensitive | empty | required | |
2 | possible W3C error count | 0 (valid) | optional | |
3 | topic for the file, e.g. c, ce, eh (or something else) | c | optional | |
4 | shortcode for a national graphic lab, e.g. gd, ge, gf (or something else) | empty | optional | |
5 | validation style, e.g. fl or no (or something else) | empty | optional | |
gc ~ | can specify or suppress a subcategory within the graphic lab, e.g. ":TomKr" (with :) | empty | optional | |
sd ~ | can specify or suppress a Graphic Lab subcategory differentiation | empty | optional | |
U ~ | can specify or suppress a user for the text (with link) — or | empty | optional | |
u ~ | can specify or suppress a user for the text (without link) (see description) | empty | optional | |
su ~sub: ~ | can specify or suppress a subcategory within "Valid SVG created with ..." or "Invalid SVG created with ..." | empty | optional | |
ca ~cat2 ~ | can specify or suppress an additional category, either with [[Category:Xxxx]] or just the name Xxxx | empty | optional | |
more parameters | need to be specified in the format name ~ value (instead of name = value)All Image generation-specified parameters can be passed, using the | empty | 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
See also
Template:{{COAInformation}}, Template:{{Image generation}}, Category:CoA Lab;
Template:Igenc ≡ Igen/coa: with Igenc predefined keys can be used even for files with Information instead of COAInformation
Module usage
{{ #invoke:IgenCoa | main | parameter_string }}
Normally the user has nothing to do with this module, it works in the background.
The 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.
An example: |image = {{Image generation|Im|6|+|gf|s=eh}} stands for :
- SVG file created with Inkscape-Important,
- for Projet Blason,
- showing ecclesiastical heraldry,
- W3C-invalid because of 6 W3C-errors;
Equivalent are |image = Im/6/eh/gf and |image = Fe/6/tool~Im, 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~Ito Inkscape. - When e.g. the topic "c" is predefined, it can be substituted with e.g.
/s~ceto Coa-element. - When e.g. no graphic lab is predefined, it can be added with e.g.
/g~esto 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, add
/~~username(the first~is the tag, the second~is for the=)
- to specify the user causing that, add
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 care, /g~it is equal to / g ~ it.
- Replacements:
- For needed spaces pass the understroke
_(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]]
- Table expansion:
This is mere technical information for people wanting to chance 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.
- up to 11 parameters can be defined for each entry, with
nilfor unused positions
- when less than 11 are needed, further
nilfilling 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.
These national wikipedias have projects which are linked standardwise, while the CoA Lab (parm 4) is linked "individuell":
Wp Coa Lab Project de di dw = Wappenwerkstatt 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 writtenimage = Ph//dworimage = 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.
Abis for SVG files, internal userkeyAbris for raster images; - the cleanup script needs only one userkey for a user, for both SVG and not-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.
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
cefor "coa element", andehfor "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
coreorr,
- 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
rorcand 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
Treatment for Coats of Arms, elements and ecclesiasticals
Besides the "normal" CoAs are there also elements used for drawing vector image CoA, and the group of CoAs used by religious leaders of the Roman Catholic Church.
Another differentiation exists for bitmap (raster image) CoAs.
These groups exist
- SVG CoA: the standard processing.
- SVG CoA elements: two possibilities
- either they have an own userkey, the standard key with "c".
- when the key for |image is this Uuc key, it is used.
- when the key for |image is just Uu, the Uuc key is searched and used, when found.
- when the key for |image is just Uu and no Uuc key exists, the Uu key is used;
- It should be modified with topic
ce, and probaly other parameters (tool);- Otherwise the element is treated as a standard SVG CoA.
- SVG ecclesiastical CoA
- cannot be detected automatically; the |image key should be Uue or Uu modified with
eh.
- cannot be detected automatically; the |image key should be Uue or Uu modified with
- SVG ecclesiastical elements
- BMP CoA
- either they have an own userkey, the standard key with "r".
- when the key for |image is this Uur key, it is used.
- when the key for |image is just Uu, the Uur key is searched and used, when found.
- when the key for |image is just Uu and no Uur key exists, it should be modified.
- BMP elements are rare
- BMP ecclesiastical CoA
- does not get yet a special treatment, all raster CoAs are the same.
With modifictions, all different groups can be processed with one userkey. But the automatic treatment is only possible when each group has an own key predefined, e.g. Uuc, Uue, Uur.
Table of the predefinitions
{{#invoke:IgenCoa|distab}} (sorted by key: first all the user keys, then the pseudo keys)