User:Andenor/Template:Infobox conworld/doc

Most of this documentation was pulled directly from the documentation for Template:Infobox language, the template upon which this template is based.

This template is used create an infobox detailing a constructed world or setting.

Usage

{{infobox conworld
| name          = Name of World
| altname       = Alternate name of world
| nativename    = The name of the world in a native language or a second additional name
| pronunciation = An IPA pronunciation of the name
| inhabitants   = A list of the inhabitants of the world (races, species, etc.)
| fam1          = A family of languages spoken there
| ...
| fam10         = A family of languages spoken there
| lang1         = A specific language spoken there
| ...
| lang10        = A specific language spoken there
| creator       = Name of the creator of the world
| created       = Date of creation
|image         = image at top of info box. Use format "image name.png", without "file/image" or brackets.
|imagesize     = override default image size (currently 250px). Use units ("123px", "12em")
|imagealt      = alt text for the image
|imagecaption  = caption to appear under image
|imageheader   = brief header for image (appears in the left-hand column)
|map           = image at bottom of info box. Use format "image name.png", without "file/image" or brackets.
|mapsize       = override default map size (currently 350px). Use units ("123px", "12em"). Affects both maps.
|mapalt        = alt text for the map
|mapcaption    = caption to appear under map
|map2          = a second map
|mapalt2       = alt text for the second map
|mapcaption2   = caption to appear under both maps
|boxsize       = overrides default width of infobox, currently set at 22em. Format must include units ("12em" or "123px").
                 Useful when an article has various infoboxes aligned in a column. (Box will automatically expand to fix map wider than default box width.)
|notice        = IPA/ipa [adds notice for IPA notation]
|notice        = Indic/indic [adds notice for Indic scripts]
|notice        = signnotice [adds links for sign languages]
|notice2       = [adds a 2nd notice]
}}

Placement

The template should placed at the very top of the wikitext of the article, before any text. The absolute basic syntax is as shown below:

{{Infobox conworld ← this calls the template

|name=name of conworld ← the name of the language needs to be given

}} ← this ends the template call

However, you will probably want to add more than just this. Other parameters are listed below, they can be incorporated anywhere between the first and last lines, and in any order.

Additional parameters

There are several more parameters that can be defined between the opening and closing lines. These are:

|altname=additional name of the language [not every one, but one a reader would be likely to look for]

|nativename=native name, or a second alternative name [most cases as of 2012 not actually the native name]

Optional parameters

Some parts of the template remain invisible unless they are specifically called. Only use these parameters if they are required.

|pronunciation=pronunciation of the native name of the language in IPA → remember to enclose the transcription

Images in the template

You cannot put large images into the language template: they just make it very messy. You can place a small image at the top of the template using the following parameters:

|image=image name.png

|imagesize=200px ← overrides the default image size

|imagealt=alt text

|imagecaption=caption

|imageheader=very simple description of image ('logo', 'map', 'script', etc.) ← this is placed in the left-hand column, and so needs to be short

If you have a slightly larger image or two, such as a map, you can place at the bottom of the template, spanning both columns, with the following parameter:

|map(2)=image name.png

|mapsize=300px ← overrides the default image size

|mapalt(2)=alt text

|mapcaption(2)=caption

The usual image markup applies for both images. Alt text is for visually impaired readers, and the caption is for all readers; typically they should have little in common (see WP:ALT).

Footer notice

A notice or notices may be placed at the bottom of the infobox:

|notice(2)=ipa ← places a notice about the Unicode fonts used for displaying IPA

|notice(2)=signnotice ← adds various links for sign languages

|notice(2)=Indic ← places a notice about Indic-font support