Module:IgenCoa/doc

Category:Module documentation#IgenCoa/doc

This module enables simplification when Template:COAInformation is used.

It is intended to be invoked from {{COAInformation}} with {{#invoke:IgenCoa|main|parameter_string}} to generate the parameters for | image =0 and to pass the returned code to the Template:Image generation. See the flow chart for more information.[clarification needed]

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.

The module's argument is a single string containing all the parameters. Therefore neither the pipe character nor the equal sign can be used within this string.

These characters, when needed, have to be replaced: pipes by slashes, equal signs by tildes.

Usage


{{IgenCoa |1= }}

Parameters in the module's argument

Template parameters

ParameterDescriptionDefaultStatus
1The only required parameter specifies

    either a complete {{Igen|.....}} definition, with all the tags, in curly brackets with pipes
    or a tool name (e.g. I, Im, Ic; A, AH, IA)

    or a short code for a user entry (e.g. TK for User:TomKr), case-insensitive
emptyrequired
2possible W3C error count[clarification needed]0 (valid)optional
3topic for the file, e.g. c, ce, eh (or something else)coptional
4shortcode for a national graphic lab, e.g. gd, ge, gf (or something else)emptyoptional
5validation style, e.g. fl or no (or something else)emptyoptional
gc ~can specify or suppress a subcategory within the graphic lab, e.g. ":TomKr" (with :)[clarification needed]emptyoptional
sd ~can specify or suppress a Graphic Lab subcategory differentiation[clarification needed]emptyoptional
U ~can specify or suppress a user for the text (with link) — oremptyoptional
u ~can specify or suppress a user for the text (without link) (see description)emptyoptional
su ~
sub ~:
can specify or suppress a subcategory within
"Valid SVG created with ..." or "Invalid SVG created with ..."
emptyoptional
ca ~
cat2 ~
can specify or suppress an additional category,
either with [[Category:Xxxx]] or just the name Xxxx
emptyoptional
more parametersneed to be specified in the format name ~ value (instead of name = value)

All Image generation-specified parameters can be passed, using the name~value notation:
replacements are needed: for pipes slashes, for equal signs tildes,
for slashes backslashes (or broken pipes), for spaces underscores (or ).

When a parameter value is itself a template transclusion, within its curly brackets all characters, including equal signs, pipes and slashes, are allowed.
emptyoptional

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

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_labcoaelementeccles.indiv.catonly
g_dddcdedidx
g_eeeceeeiex
g_fffcfefifx

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

WpCoa LabProject
dedidw = Wikipedia:WikiProjekt_Wappen
eseige = THV
frfigf = 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.
usagecoaelementeccles.raster
Igen topiccceeh
table keyUuUucUueUur

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.

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.
  • 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.[clarification needed]

Table of the predefinitions

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

Table display
#keytoolertoplabgcsdUusubcat
1a3Icgi:Arrow303A3Arrow303Coats of arms by Arrow303
2a6Icgf:Anno16A6Anno16
3adIcgf:Adalric67ADAdalric67
4alIcHi:AlimanALAliman5040
5anIcge:AnenjaANAnenjaContribuciones de Anenja
6aoIcgi:AshoppioAOAshoppio
7apIcgf:ApnAPApn
8arIcgf:ArocheARAroche
9auIcgf:AupsAUAups
10avIcgp:Aviz2000AVAviz2000
11b1IcB1B1mbo
12b2Icgf:BarsupilamiB2Barsupilami1512
13b4Acgi:BaselunaB4Baseluna014
14baIcgP:BastianowBABastianow
15bbrUncgp:Brian BoruBBBrian Boru
16bcIcgf:ByacCBCByacC
17beIcgf:Bear17BEBear17
18bfIcgf:BrookfordBFBrookford
19bnF8cgH:BerninaBNBernina
20brIcgf:BriegBRBrieg
21bzIcgf:BenzebuBZBenzebuth198
22c1AcC1COAmaker17
23c2DcsuC2Care
24cbIcgf:CelbusroCBCelbusro
25ccrUnehgp:CatChessCCCatChess
26chIcgf:ChatsamChatsamBlason chatsam
27chxIcgf:ChatsamChatsam
28cnIcgf:CaranornCNCaranorn
29cpIehph:CPhoenixCP
30csIcdnnl:ChrisChris die SeeleCoA by Chris die Seele
31cvIcCVCsavil
32cyIcgf:CyygmaCYCyygma
33czIccs
34d9I5cgH:Delta-9D9Delta-9
35daIcnl:DArchDAD'ArchCoat of Arms by Arch
36dkrUncgs:Dan KoehlDKDan KoehlCoats of arms by Dan Koehl
37dlIcdi:D.S.LiuzzoDLDavid Liuzzo
38dtxIcdnDoc TaxonCoA by Doc Taxon
39emIcge:EchandoEMEchando una mano
40enIcgB:EnekorgaENEnekorga
41erIcge:ErlenmeyerERErlenmeyerContribuciones de Erlenmeyer
42esIcgH:EspanderoESEspandero
43etIAcgf:EtxekoETEtxeko
44euIcgc:EuryrelEUEuryrel
45eueIehgc:EuryrelEUEuryrel
46f2Icdi:Flow2F2Flow2
47f5Icgf:F5JMHF5F5JMH
48foIcsu:FennOFOFenn-O-maniC
49fqIcgi:FacquisFQFacquis
50frIcgH:FränsmerFRFränsmer
51g2Icgi:Gb89.2G2Gb89.2
52gbIcgH:GerhardBGBGerhard Bräunlich
53glIcdwnil:GliwiGliwiCoA by Gliwi
54goIcGOGunnar.offel
55grIcgf:GretazGRGretaz
56gtIcgf:GroteddyGTGroteddy
57gyIehph:G_YoshGY
58heIcei:HeralderHEHeralder
59hsIcgf:HSaloméHSenry Salomé
60ihIHc
61ilIcgc:IlzolendeILIlzolende
62iwIcgP:Isidor WIWIsidor Welti
63j2IcJ2James2813
64j6Icgf:Jacques63J6Jacques63
65j9Icgf:Jean92J9Jean92 dit le Comte
66jkIcJürgen KrauseCoA by Jürgen KrauseCOA by User:Jürgen Krause
67jlIcgf:Jacques LysJLJacques Lys
68jnIcgf:Jimmy44Jimmy44Files by User:Jimmy from fr.wikipedia
69jneIehgf:Jimmy44Jimmy44Files by User:Jimmy from fr.wikipedia
70jpIcgf:JpgibertJpgibertCoA by JPGibert
71jrIcph:J-RonnJRJ-Ronn
72jreIehph:J-RonnJRJ-Ronn
73jwTcdi:JwnabdJWJwnabdCoats of arms drawn by User:Jwnabd
74k2Tcgf:KontributorK2Kontributor 2K
75kiAcsk:KrumpiKIKrumpiCoats of arms by Krumpi
76l2DcL2Leonid 2
77l5rUncdi:Lothar520L5Lothar520
78lhrUncdi:LoschLHLosch
79lpIcsx:Lokal_ProfilLPLokal_ProfilImages by Lokal_Profil/CoA
80luIcdi:Ludger1961LULudger1961
81lvDcgr:LobachevLV Lobachev
82maIcgf:ManassasMAManassas
83mbIcgh:MadboyMadboy74CoA by Madboy74
84mcIehei:MacucalMCMacucalUser:Macucal
85mgUncgP:MagulMGMagul
86mgrUncgP:MagulMGMagul
87mlIcdwno:MaxxLMaxxLCoA by MaxxL
88mnIcge:MiguillenMNMiguillen
89moIcgH:ManoillonMOManoillon
90mrIcgf:MaclaurenMRMaclauren
91mxIcdi:MaxwxyzMXMaxwxyz
92n7IcN7Nanin7
93ngIcgc:Ng556NGNg556
94ngeIehgc:Ng556NGNg556
95npIcgp:NPortuguêsNPN.Português
96oOc
97odBlenderncgf:OdejeaODOdejeaFiles by Odejea/PNG coat of arms
98odeIehgf:OdejeaOdejeaFiles by Odejea/SVG ecclesiastical coat of arms
99odrBlenderncgf:OdejeaODOdejeaFiles by Odejea/PNG coat of arms
100phIcdi:PerhelionPHPerhelion
101plIcgP
102pnIcdi:PhilnatePNPhilnate
103poAcgr:PopadiusPOPopadius
104r2IcR2RaFaDa20631
105rcAcRCRegicollis
106rgrUncdi:RepgowRGRepgow
107rqIcRQRoqz
108rvIcgi:RuthvenRuthvenCoA by Ruthven
109rveIehgi:RuthvenRuthvenCoA by Ruthven
110s0Icgf:Spax89Spax89CoA by Spax89
111s7Icgf:SsireS7Ssire
112saIcSASajoR
113saeIehSASajoR
114seIcdi:Simon.ESimon.ellerCoA by Simon Eller
115sfIcSFSrfortes
116sjIcSJSsolbergj
117skwIcgdsxSteveKCOA by SteveK
118smIcSMSamhanin
119soIcgc:SodacanSOSodacan
120spIcgf:SpedonaSPSpedona
121sqIcge:SanchoPSanchoPanzaXXIGraphics by User:SanchoPanzaXXI
122sqfIcgf:SanchoPSanchoPanzaXXIGraphics by User:SanchoPanzaXXI
123srIcgf:SanglierTSanglierTPictures by SanglierT
124sreIehgf:SanglierTSanglierTPictures by SanglierT
125syPhotoshopncgf:SyryatsuSYSyryatsuPNG blason par Syryatsu
126syrPhotoshopncgf:SyryatsuSYSyryatsuPNG blason par Syryatsu
127taIcgH:TaktaalTATaktaal
128tcIcgf:TwocatsTCTwocats
129tfIccs:TFerenczyTFTFerenczy
130tkIcgf:TomKrTKTomKr
131tlIcgf:LanaudTLThom.Lanaud
132toIcnl:Tom-LTOTom-L
133trUncdi:TRystauTRT. Rystau
134trrUncdi:TRystauTRT. Rystau
135tuUnehTUTomáš Urban
136turUnehTUTomáš Urban
137tvIcgf:TretinvilleTVTretinvilleBlasons Tretinville
138v1AcV1ViniciusBR11
139v9Icgi:Vale93bVale93bCoA by Vale93bU:Vale93b
140v9eIehgi:Vale93bVale93bCoA by Vale93bU:Vale93b
141vaIcgf:B.ValletteVABruno
142vdIcgf:VddbertVDVddbert
143vdeIehgf:VddbertVDVddbert
144whTcdi:WalderichWHWalderich
145wkAcgc:KaliforniykaWKKaliforniyka
146xvIcge:XavigivaxXVXavigivax
147ylIcgf:Yves LGYLYves LG
148yrIcgf:YricordelYRYricordel
149zaIcgf:Zardoz91ZAZardoz91
150ziIcgf:ZigeunerZIZigeuner
151zoIcgf:ZorlotZOZorlot
==================
1aAc
2dIcgd
3dcIcegd
4deIehgd
5diIcdi
6dxIcgd
7eIcge
8ecIcege
9eeIehge
10eiIcei
11exIcge
12fIcgf
13fcIcegf
14feIehgf
15fiIcfi
16fxIcgf
17gcIcgc
18hIcgH
19iIc
20iaIAc
21imImc
22itIcgi
23nlIcnl
24pbIcgf
25rieUneh
26rirUnc
27ruIcgr
28skIcflSteveKCoA by SteveKCOA by SteveK
29tT0c
30uUc
==================
1zzzzUcgc:??substitute:
Category:Module documentation