Template:Infobox file format/doc
This is a documentation subpage for Template:Infobox file format. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Blank syntax
[[File:{{{icon}}}|64px]] | |
[[File:{{{screenshot}}}|300px]] | |
Filename extension | extension[s] |
---|---|
Internet media type | mime |
Type code | typecode |
Uniform Type Identifier (UTI) | uniform type |
UTI conformation | conforms to |
Magic number | magic |
Developed by | developer |
Initial release | {{start date and age |…}} |
Latest release | latest_release_version ({{start date and age |…}}) |
Type of format | genre |
Container for | containerfor |
Contained by | containedby |
Extended from | extendedfrom |
Extended to | extendedto |
Standard | standard (standards) |
Open format? | free |
Website | url |
{{Infobox file format | name = | icon = | iconcaption = | icon_size = | screenshot = | screenshot_size = | caption = |_noextcode = | extension = <!-- or: | extensions = --> |_nomimecode = | mime = | type code = | uniform_type = | conforms_to = | magic = | developer = | released = <!-- {{start date and age|YYYY|mm|dd|df=yes/no}} --> | latest_release_version = | latest_release_date = <!-- {{start date and age|YYYY|mm|dd|df=yes/no}} --> | genre = | container_for = | contained_by = | extended_from = | extended_to = | standard = <!-- or: | standards = --> | free = | url = }}
By default, extension and mime are displayed using <code></code>
; to disable this (in order to customize their formatting), assign _noextcode and/or _nomimecode a value ("on", "true", etc.).
Examples
Template:Infobox file format/sandbox <source lang="xml" style="margin-top:2.75em;overflow:auto;">
Filename extensions | .svg, .svgz |
---|---|
Internet media type | image/svg+xml[1][2] |
Type code |
|
Uniform Type Identifier (UTI) | public.svg-image |
UTI conformation | public.image public.xml |
Developed by | W3C |
Initial release | 4 September 2001 |
Latest release | 1.1 (Second Edition) (16 August 2011 ) |
Type of format | Vector image format |
Extended from | XML |
Standard | W3C SVG |
Open format? | Yes |
Website | www |
</source>
Template:Infobox file format/sandbox <source lang="xml" style="margin-top:2.0em;overflow:auto;">
Filename extension | .odt |
---|---|
Internet media type | application/vnd. |
Uniform Type Identifier (UTI) | org.oasis. [3] |
UTI conformation | org.oasis-open. public.composite- |
Developed by | |
Type of format | Document file format |
Extended from | XML |
Standard | ISO/IEC 26300:2006 |
Open format? | Yes |
</source>
Parameters
- name
- The name of the file format.
- icon
- A file icon used by either the application that popularized the format or a common free icon. Alias is
|logo=
. - iconcaption
- caption describing the icon.
- screenshot
- A screen shot of the file format in use.
- caption
- caption to the screen shot.
- extension (or extensions)
- The format's filename extension or extensions. Set
|_noextcode=
to disable the default<code></code>
formatting. - mime
- The MIME type of the file. Set
|_nomimecode=
to disable the default<code></code>
formatting. - typecode
- The type code of the file, used by Mac OS Classic.
- uniform type
- The Uniform Type Identifier, used by contemporary macOS computers and iOS devices.
- conforms to
- The immediate parents of the UTI. For example,
public.png
would conform topublic.image
- magic
- A number or other data structure usually near the beginning of a file used to identify the file contents.
- owner
- The owner of the format.
- released
- The date the format was publicly released.
- latest_release_version
- Latest version number of the format.
- latest_release_date
- Date the latest version was released.
- genre
- The genre of the file format.
- containerfor
- If the file is a container for another data type, list it here.
- containedby
- If the file type is typically housed in another file type, list it here. For example: Audio and video data are most often housed in a media container such as QuickTime et al.
- extendedfrom
- If the file format is based on another, list it here.
- extendedto
- If a new format is derived from this one, list it here.
- standard (or standards)
- If the format is part of a standard or standards, list it/them here.
- free
- Is it a free/open format?
- url
- URL of the file format's website, specification, etc.
TemplateData
Infobox file format
<templatedata>
{
"description": "Consistently-formatted table for presenting information about file formats",
"params": {
"child": {
"label": "Child",
"description": "Settings this to \"yes\" allows the infobox to be embedded into another infobox. It also causes name parameter to be ignored.",
"type": "string"
},
"name": {
"description": "The name of the file format.",
"type": "line",
"suggested": true,
"label": "Name",
"default": "Pagename"
},
"icon": {
"suggested": true,
"description": "An icon used by either the application that popularized the format or a common free icon.",
"type": "string",
"aliases": [
"logo"
],
"label": "Icon"
},
"iconcaption": {
"aliases": [
"logocaption"
],
"label": "Icon caption",
"description": "Caption describing the icon.",
"type": "string"
},
"icon_size": {
"aliases": [
"logo_size"
],
"label": "Icon size",
"type": "string",
"default": "64px",
"description": "Size of the icon to show including a unit (most likely pixels - 'px')."
},
"screenshot": {
"type": "string",
"label": "Screenshot",
"description": "A screenshot of the file format in use."
},
"caption": {
"type": "string",
"label": "Caption",
"description": "Caption to the screenshot."
},
"screenshot_size": {
"label": "Screenshot size",
"type": "string",
"default": "300px",
"description": "Size of the screenshot to show including a unit (most likely pixels - 'px')."
},
"extension": {
"label": "Extension",
"description": "The format's filename extension, if only one.",
"type": "string",
"suggested": true
},
"extensions": {
"label": "Extensions",
"description": "The format's filename extensions, if more than one.",
"type": "string"
},
"_noextcode": {
"label": "No in extension",
"description": "If set to 'true', then extensions won't be formatted using
.",
"type": "string"
},
"mime": {
"label": "MIME type",
"type": "string",
"description": "The MIME type of the file.",
"suggested": true
},
"_nomimecode": {
"label": "No
in MIME",
"description": "If set to 'true', then MIME won't be formatted using
.",
"type": "string"
},
"uniform_type": {
"label": "Uniform Type Identifier (UTI)",
"description": "The Uniform Type Identifier, used by contemporary macOS computers and iOS devices.",
"type": "string",
"aliases": [
"uniform type"
]
},
"conforms_to": {
"label": "UTI conformation",
"description": "The immediate parents of the UTI. For example, public.png would conform to public.image.",
"type": "string",
"aliases": [
"conforms to"
]
},
"magic": {
"label": "Magic number",
"description": "A number or other data structure usually near the beginning of a file used to identify the file contents.",
"type": "string"
},
"developer": {
"aliases": [
"owner"
],
"label": "Developed by",
"description": "The owner of the format.",
"type": "string",
"suggested": true
},
"type": {
"aliases": [
"genre"
],
"label": "Type of format",
"description": "The type of the file format, what does it store (e.g. Vector image format).",
"type": "string",
"suggested": true
},
"released": {
"label": "Initial release",
"description": "The date the format was publicly released.",
"type": "string"
},
"latest_release_version": {
"label": "Latest release version",
"description": "Latest version number of the format.",
"type": "string",
"aliases": [
"latest release version"
]
},
"latest_release_date": {
"label": "Latest release date",
"description": "Date the latest version was released.",
"type": "string",
"aliases": [
"latest release date"
]
},
"container_for": {
"label": "Container for",
"description": "Data type this file format is container for. For instance, audio and video data is often housed in a container like Quick Time or Matroska (MKV).",
"type": "string",
"aliases": [
"container for",
" containerfor"
]
},
"contained_by": {
"label": "Contained by",
"description": "File type this type is usually housed in. For instance, audio and video data is often housed in a container like Quick Time or Matroska (MKV).",
"type": "string",
"aliases": [
"contained by",
" containedby"
]
},
"extended_from": {
"label": "Extended from",
"description": "The format that this one is based on, if any.",
"type": "string",
"aliases": [
"extended from",
" extendedfrom"
]
},
"extended_to": {
"label": "Extended to",
"description": "The format that this one is base for, if any.",
"type": "string",
"aliases": [
"extended to",
" extendedto"
]
},
"standard": {
"label": "Standard",
"description": "Standard this format is part of, if only one.",
"type": "string"
},
"standards": {
"label": "Standards",
"description": "Standards this format is part of, if more than one.",
"type": "string"
},
"free": {
"label": "Open format?",
"type": "string",
"description": "Is it a free/open format?"
},
"url": {
"label": "Website",
"description": "URL of the file format's website, specification, etc.",
"type": "string",
"suggested": true
},
"type_code": {
"label": "Type code",
"description": "The type code of the file used by Mac OS Classic.",
"type": "string",
"aliases": [
"type code",
" typecode"
]
}
},
"paramOrder": [
"child",
"name",
"icon",
"icon_size",
"iconcaption",
"screenshot",
"screenshot_size",
"caption",
"extension",
"extensions",
"_noextcode",
"mime",
"_nomimecode",
"type_code",
"uniform_type",
"conforms_to",
"magic",
"developer",
"type",
"released",
"latest_release_version",
"latest_release_date",
"container_for",
"contained_by",
"extended_from",
"extended_to",
"standard",
"standards",
"free",
"url"
],
"format": "block"
}
</templatedata>