Template:Infobox device/doc: Difference between revisions

From Guild of Archivists
(Created page with "This template is for articles about devices and machines. It will automatically add Category:Devices to the article. == Usage == {{Infobox device | name = {{{name}}} | i...")
 
(Update documentation to cover new 'dni-dictionary' parameter.)
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
| image = {{{image}}}
| image = {{{image}}}
| imagecaption = {{{imagecaption}}}
| imagecaption = {{{imagecaption}}}
| dni-name = {{{dni-name}}}
| dni-dictionary = {{{dni-dictionary}}}
| location = {{{location}}}
| location = {{{location}}}
}}
}}
Line 12: Line 14:
| image  
| image  
| imagecaption  
| imagecaption  
| dni-name
| dni-dictionary
| location
| location
}}
}}
Line 17: Line 21:


== Parameters ==
== Parameters ==
'''name''' <br />
<templatedata>
When this parameter is absent, the infobox will automatically use the article's page title.
{
 
"params": {
'''image'''<br />
"name": {
Supply a file name with an image of the device or machine. Don't provide the full <nowiki>[[File:…]]</nowiki> tag, just the file name (e.g. "KI.jpg").
"label": "Name",
 
"description": "When this parameter is absent, the infobox will automatically use the article's page title.",
'''imagecaption'''<br />
"type": "string",
You can optionally include a caption that will appear beneath the image. Use this rather than '''name''' to provide additional information or context for the image you include.
"autovalue": "{{PAGETITLE}}"
 
},
'''location'''<br />
"image": {
If a device or machine exists in a specific Age or location, provide a link to that location's article using this parameter. If the device is portable (such as the [[KI]]), do not include this parameter.
"label": "Image",
"description": "Supply a file name with an image of the device or machine. Don't provide the full <nowiki>[[File:…]]</nowiki> tag, just the file name (e.g. \"KI.jpg\").",
"type": "wiki-file-name",
"suggested": true
},
"imagecaption": {
"label": "Caption",
"description": "You can optionally include a caption that will appear beneath the image. Use this rather than '''name''' to provide additional information or context for the image you include.",
"type": "string"
},
"dni-name": {
"label": "D'ni Name",
"description": "If the device has a D'ni name, provide it here in Dnifont format, ''without'' the accompanying <nowiki><dni></dni></nowiki> tags.",
"type": "string",
"suggested": true
},
"location": {
"label": "Location",
"description": "If a device or machine exists in a specific Age or location, provide a link to that location's article using this parameter. If the device is portable (such as the [[KI]]), do not include this parameter.",
"type": "string",
"suggested": true
},
"dni-dictionary": {
"label": "D'ni Dictionary Name",
"description": "If the device has a corresponding dictionary entry, provide the name of that entry here. Do not include the <code>Dictionary:</code> namespace, that will be added automatically.",
"suggested": true
}
},
"description": "This template is for articles about devices and machines. It will automatically add [[:Category:Devices]] to the article."
}
</templatedata>
<includeonly>[[Category:Infobox templates]]</includeonly>
<includeonly>[[Category:Infobox templates]]</includeonly>

Latest revision as of 08:07, 25 July 2024

This template is for articles about devices and machines. It will automatically add Category:Devices to the article.

Usage[edit source]

{{{name}}}
[[File:{{{image}}}|270px]]
{{{imagecaption}}}
Name in D'ni [[Dictionary:{{{dni-dictionary}}}|{{{dni-name}}}]]
Location {{{location}}}
{{Infobox device
| name
| image 
| imagecaption 
| dni-name
| dni-dictionary
| location
}}

Parameters[edit source]

This template is for articles about devices and machines. It will automatically add [[:Category:Devices]] to the article.

Template parameters

ParameterDescriptionTypeStatus
Namename

When this parameter is absent, the infobox will automatically use the article's page title.

Auto value
{{PAGETITLE}}
Stringoptional
Imageimage

Supply a file name with an image of the device or machine. Don't provide the full <nowiki>[[File:…]]</nowiki> tag, just the file name (e.g. "KI.jpg").

Filesuggested
Captionimagecaption

You can optionally include a caption that will appear beneath the image. Use this rather than '''name''' to provide additional information or context for the image you include.

Stringoptional
D'ni Namedni-name

If the device has a D'ni name, provide it here in Dnifont format, ''without'' the accompanying <nowiki><dni></dni></nowiki> tags.

Stringsuggested
Locationlocation

If a device or machine exists in a specific Age or location, provide a link to that location's article using this parameter. If the device is portable (such as the [[KI]]), do not include this parameter.

Stringsuggested
D'ni Dictionary Namedni-dictionary

If the device has a corresponding dictionary entry, provide the name of that entry here. Do not include the <code>Dictionary:</code> namespace, that will be added automatically.

Unknownsuggested