Vorlage:Inform/doc

{{autotranslate|Infor|Redirects/i18n}}

• |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,
• |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.

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)

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.
• When its first two characters are either {{ or [[ it is passed as-it-is.
• 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/nor is specified, the template defaults the permission with a PD-self.
When that is unwished, the defaulting can be avoided with "-" as a permission value.

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/gw/%/°/s~c/×/C~a¦b¦c

"/" becomes substituted to "|"

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

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

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

The template accepts only lower case parameter names. Equal-length parameter names allow a better view:

{{ Infor
0 | 0
0 | 0
0 | 0
0 | 0
0 | 0
0 | 0
0 | 
 }}
example

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

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

{{ Infor
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)

Either positional parameters can be used, or named parameters, the names abbreviated to a length of 2 or 4 letters; in any case as well full length names can be used, in any mixture.

Example

The empty template {{Infor}} generates:

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.