Template:Inform

DescriptionInform	-file-
Date	2024
Source	Own work
Author	Username
Permission (Reusing this file)	I, the copyright holder of this work, release this work into the public domain. This applies worldwide. In some countries this may not be legally possible; if so: I grant anyone the right to use this work for any purpose, without any conditions, unless such conditions are required by law.

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Inform/doc.

en-1	The description below was composed by a non-native English speaker. You are cordially invited to improve the literal quality of any textual expression.

This template is complicated, and its documentation is incomplete, incorrect and highly unclear. Until its completion, it may be wiser to prefer the more mature {{Information}} template.

Information template - for file description with many useful defaultings
for e.g. SVG images the parameter "image" can be used, instead of abusing other fields.^{[clarification needed]}
Support: It can reduce upload work when a prefilled upload form is established.

Deutsch: Diese Hilfsvorlage kann verwendet werden, solange die eigentliche Vorlage {{Information}}
keine vernünftigen Aliase anbietet für die unhandlichen, historisch gewachsenen Parameternamen.

English: This auxiliary template can be used as long as the actual {{Information}} template does not provide reasonable aliases for the unwieldy, historically grown parameter names.^{[clarification needed]}

Español: Esta plantilla auxiliar se puede utilizar siempre que la plantilla {{Information}} no proporcione
alias razonables para los nombres de parámetros poco manejables y que han crecido históricamente.

Français : Ce modèle d'aide peut être utilisé tant que le modèle {{Information}}
proprement dit ne propose pas d'alias raisonnables pour les noms de paramètres
peu pratiques qui ont évolué au fil du temps.

Italiano: Questo template ausiliario può essere usato finché il template primario {{Information}}
non fornisce alias ragionevoli per i nomi dei parametri, ingombranti e storicamente cresciuti.

Nederlands: Dit hulpsjabloon kan worden gebruikt zolang het eigenlijke sjabloon {{Information}}
geen redelijke aliassen biedt voor de logge, historisch gegroeide namen van de parameters.

Polski: Ten pomocniczy szablon może być używany tak długo, jak długo właściwy szablon {{Information}}
nie oferuje rozsądnych aliasów dla nieporęcznych, historycznie rozrośniętych nazw parametrów.

Português: Este modelo auxiliar pode ser utilizado desde que o modelo actual {{Information}} não
oferece pseudónimos razoáveis para os nomes de parâmetros complicados, historicamente crescidos.

Layouts

---

Equal-length parameter names allow a better table-like view. When parameter names are used, they are only accepted in lower case notation.

{{ Inform
0 | 0
0 | 0
0 | 0
0 | 0
0 | 0
 }}

{{ Inform
0 | 1 =  
0 | 2 =  
0 | 3 =  
0 | 4 =  
0 | 5 = 
 }}

{{ Inform
0 | de =  
0 | da =  
0 | so =  
0 | au =  
0 | im = 
 }}

{{ Inform
0 | desc =  
0 | date =  
0 | sour =  
0 | auth =  
0 | imag = 
 }}

Copy whatever you want to use. The 4-letter-names may be a good compromise between name-shortness and clarity of parameter meaning.

Usage

{{Inform |1= |2= |3= |4= }}

Parameters passed by name need to use the name's exact case (generally fully lowercase).

The parameters date and author should always have values!^{[clarification needed]} For uploading, the prefilled upload form is suggested.

Template parameters

Parameter	Description		Default	Status
1 de desc[ription]	Description (see description) When the field is empty: default is the filename		{{ F | F }}	optional
2 da date	Date The format should be yyyy-mm-dd When the value is ~~~~~: the next cleanup[clarification needed] corrects the format		prefilled fupload fffform	suggested
3 so sour[ce]	Source When the field is empty: default is {{Own}}		{{ Own }}	optional
4 au auth[or]	Author (see more information) This field should never be empty		prefilled fupload fffform	suggested
5 im imag[e]	Image The parameters for the Image generation template (the current {{Information}} requires to abuse other fields)[clarification needed]		empty	optional
6 ve vers[ion]	Other versions[clarification needed]		empty	optional
7 ol oloc	Object location/Geolocation also aliases: o[bject ]loc[ation] = oloc		empty	optional
cl cloc	Camera location/Geolocation also aliases: c[amera ]loc[ation] = cloc		empty	optional
8 fi fiel[ds]	Other fields[clarification needed]		empty	optional
9 f1 of 1	Other fields 1[clarification needed]		empty	optional
pe perm[ission]	Permission A permission/license template inside the InfoBox		{{PD-self}} ("-" to avoid)[clarification needed]	optional
p2 per2	more permission(s)[clarification needed]		empty	optional
li lice[nse]	License A license template below of the InfoBox		empty	optional
l2 lic2	more license(s)[clarification needed]		empty	optional
a2 aut2	Second text to "author"[clarification needed]		empty	optional
c2 col2	Second column See information and examples		empty	optional
w2 wid2	width of second column in percent, e.g. 14		empty	optional
ca cate[gory]	category (with or without surrounding [[Category:...]])		empty	optional
cs cats[ort]	category or categories (without surrounding [[Category:...]])[clarification needed]		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: no user group specified

See also

{{Information}}

Localization

This template is not intended to be localized.

• |desc= or |de= is the neutral description parameter.

For localizing the description exist also short codes for some privileged languages,

• |desd= or |dd= for German text,
• |dese= for an English description,
• |desf= or |df= for French text,
• |desi= or |di= for Italian text,
• |desk= or |dk= for Korean text,
• |desn= or |dn= for Dutch text,
• |desp= or |dp= for Portuguese text,
• |desu= or |du= for Ukrainian text,
• |desE= or |dE= for Spanish text,
• |desP= or |dP= for Polish text,
• |desr= or |dr= for Russian text,
• |des2= or |d2= neutral but after all other languages.^{[clarification needed]}

By the both neutral parameters any language can be used, with or without Language templates.

Default values

1. desc: Often the filename (of course without the .extension) is a sufficient description
2. date: Presetting for upload is possible with prefilled upload form
3. sour: The default value {{Own}} is used
4. auth: Presetting for upload is possible with prefilled upload form
5. perm: The default value {{PD-self}} is used (when there is also no license)

The template gets a really advantage and useability when it is used with the prefilled form

• date ef- with automatic value for upload date (which is often a good default); when ~~~~~ is used, the next cleanup will correct it.
• author - the name of the uploading user (which in most cases will be a good default)

^{[clarification needed]}

Future expansions

Completions

Some parameter values are automatically completed or substituted (no matter how the parameter name is written):

• |auth = xxxx is completed to |auth = {{U|xxxx}}
• |lice = PD-… is completed to |lice = {{PD-…}} (same with perm=)
• |lice = xxxx is completed to |lice = {{PD-xxxx}} (same with perm=)
• |cloc = xx/xx: all "/" are replaced by "|" (same with oloc=)

The Author parameter

This parameter can be specified in various ways.

• For uploads very easy with the prefilled upload form.^{[clarification needed]}
• When its first two characters are either {{ or [[ it is passed as-is.^{[clarification needed]}
• Otherwise, when the first character is one of & ( . < [ _ { ~, a module is invoked to determine: when the first two characters

are either () <> [] {}, or && (( .. << __ ~~, this prefixing is removed and the remaining string is passed as-it-is;

character strings with a single leading character as e.g. & < [ are passed without being changed.

• Any other character string is passed as parameter of the Template:{{U}}.

Licenses

It is expected that every file description contains either a permission or a license. When neither is specified, the template defaults the permission with a PD-self. This default can be avoided with |permission=-.

As a possible abbreviation, it is not necessary to write the parameter name for these often used simple licenses:
when the 5th or 6th parameter is just |self or |shape or |text, it becomes completed to |permission={{PD-...}};
when the 7th or 8th parameter is just |self or |shape or |text, it becomes completed to |license={{PD-...}}.

All other simple licenses, e.g. PD-chart, PD-chem, PD-font, PD-logo, PD-map, PD-scan, PD-sign, PD-simple, PD-wpdc, ... need named parameters pe/perm= resp.li/lice=. Parameter values become completed as told in #Completions.

With |per2= resp. |lic2= anything can added to a permission/license, e.g a plain text explanation or another template. When the only value is "i" or "t" (or "it"), the Insignia and/or Trademark template is generated.

Categorizations

The parameter catg (ca) serves for simple categorization, no module is invoked.
With cats (cs) also more complicated parameter values can be passed:

• slashes "/" are replaced by pipes, thus allowing sortkey-subparameters
• several categories, separated by linefeeds, can be specified (see example)

Essential note:

Be aware that with the current version of Cat-a-lot categories which are set by catg or cats cannot be treated – a severe disadvantage!

Subtemplates

as e.g. {{Image generation}}, {{Location}}, {{Object location}} can be written either in the complete form, or just the parameters separated by slashes

Image generation

• |image={{Igen|U|+|gw|%|°|s=c|×|C=a/b/c}} or |imag=U;c/gw/%/°/×/C~a¦b¦c

"/" becomes substituted to "|"

"~" becomes substituted to "+" (named parameters)

"¦" becomes substituted to "/" (parameter lists, as for tinctures)

A shortcutting is supported for |s= and/or |w=

tool;sss/... is expanded to {{Igen|tool|...|s=sss}}

tool:www/... is expanded to {{Igen|tool|...|w=www}}

tool;sss:www/... is expanded to {{Igen|tool|...|s=sss|w=www}}

Geo locations

• |location={{Location|9°10′11.8″N 12°13′14.8″E|dim:200}} or |cloc=9°10′11.8″N, 12°13′14.8″E/dim:200
• |oloc={{Object location|9|10|11.8|N|12|13|14.8|E|dim:200_heading:SW}} or |oloc=9/10/11.8/N/12/13/14.8/E/dim:200_heading:SW

"/" becomes substituted to "|"

See an example for the coding of geo-locations, and the compass values for the headimg.

Layout comparison

Most of the parameters are numbered and can be defined either by position or by name. Names can be fully specified or abbreviated to a length of 2 or 4 characters. All styles (lengths) can be mixed, but equal-length parameter names allow a better view:

{{ Inform
0 | 0
0 | 0
0 | 0
0 | 0
0 | 0
0 | 0
0 | 
 }}
example

{{ Inform
0 | 1 =  
0 | 2 =  
0 | 3 =  
0 | 4 =  
0 | 5 =  
0 | 6 =  
0 | 7 = 
 }}
example

{{ Inform
0 | de =  
0 | da =  
0 | so =  
0 | au =  
0 | im =  
0 | ve =  
0 | ol = 
 }}
example

{{ Inform
0 | desc =  
0 | date =  
0 | sour =  
0 | auth =  
0 | imag =  
0 | vers =  
0 | oloc = 
 }}
SVG example, JPG example

but

{{ Inform
0 | description =  
0 | date =  
0 | source =  
0 | author =  
0 | other fields =  
0 | other versions =  
0 | object location = 
 }}
example  (with geolocation)

^{[clarification needed]}

Example

An invocation without parameters ({{Inform}}) generates:

DescriptionInform	{{F|F}}
Date	2024
Source	Own work
Author	Username
Permission (Reusing this file)	I, the copyright holder of this work, release this work into the public domain. This applies worldwide. In some countries this may not be legally possible; if so: I grant anyone the right to use this work for any purpose, without any conditions, unless such conditions are required by law.

Minimum

With the parameters or their abbreviations

1. date (optional)
2. auth
3. catg (optional)

a complete file description can be performed, whith useful defaults of desc, perm and sour.