Template:Infobox file format/doc

From HandWiki
< Template:Infobox file format
Revision as of 19:54, 25 November 2020 by imported>Jworkorg (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Blank syntax

name
[[File:{{{icon}}}|64px]]
iconcaption
[[File:{{{screenshot}}}|300px]]
caption
Filename extensionextension[s]
Internet media typemime
Type codetypecode
Uniform Type Identifier (UTI)uniform type
UTI conformationconforms to
Magic numbermagic
Developed bydeveloper
Initial release{{start date and age |…}}
Latest release
latest_release_version
({{start date and age |…}})
Type of formatgenre
Container forcontainerfor
Contained bycontainedby
Extended fromextendedfrom
Extended toextendedto
Standardstandard  (standards)
Open format?free
Websiteurl
{{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

{{Infobox file format
| name = Scalable Vector Graphics
| icon = 
| iconcaption = | screenshot = | caption = 
|_noextcode = on
| extensions = .svg, .svgz
|_nomimecode = on
| mime = image/svg+xml<ref>(w3.org ref)</ref><ref>(ietf.org ref)</ref>
| type_code = {{hlist |"svg" |"svgz"}}
| uniform_type = <code>public.svg-image</code>
| conforms_to = <code>public.image</code><br/><code>public.xml</code>
| magic = 
| developer = [[World Wide Web Consortium|W3C]]
| released = {{start date and age|2001|09|04|df=yes}}
| latest_release_version = 1.1 (Second Edition)
| latest_release_date = {{start date and age|2011|08|16|df=yes}}
| genre = [[Vector image format]]
| container_for = | contained_by = 
| extended_from = [[XML]]
| extended_to = 
| standard = [http://www.w3.org/TR/SVG/ W3C SVG]
| free = Yes
| url = {{URL|http://www.w3.org/Graphics/SVG/}}
}}

Template:Infobox file format/sandbox

{{Infobox file format
| name = OpenDocument Text
| icon = [[File:ODF textdocument 48x48.png|ODF textdocument icon]]
| screenshot = | caption = 
| extension = .odt
| mime = application/vnd.<br/>&amp;nbsp;oasis.opendocument.<br/>&amp;nbsp;text
| type_code = 
| uniform_type = <code>org.oasis.<br/>&amp;nbsp;opendocument.text</code><ref>(www.huw.id.au ref)</ref>
| conforms_to = {{nowrap|<code>org.oasis-open.<br/>&amp;nbsp;opendocument</code><br/><code>public.composite-<br/>&amp;nbsp;content</code>}}
| magic = 
| developer = {{hlist |[[Sun Microsystems]] |[[OASIS (organization)|OASIS]]}}
| released = 
| latest_release_version = | latest_release_date = 
| genre = [[Document file format]]
| container_for = | contained_by = 
| extended_from = [[XML]]
| extended_to = 
| standard = ISO/IEC 26300:2006
| free = [[OpenDocument#Licensing|Yes]]
| url = 
}}

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 monospace font.
mime
The MIME type of the file. Set |_nomimecode= to disable the default monospace font.
type_code
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 to public.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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Infobox file format

Consistently-formatted table for presenting information about file formats

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Childchild

Settings this to "yes" allows the infobox to be embedded into another infobox. It also causes name parameter to be ignored.

Stringoptional
Namename

The name of the file format.

Default
Pagename
Linesuggested
Iconicon logo

An icon used by either the application that popularized the format or a common free icon.

Stringsuggested
Icon sizeicon_size logo_size

Size of the icon to show including a unit (most likely pixels - 'px').

Default
64px
Stringoptional
Icon captioniconcaption logocaption

Caption describing the icon.

Stringoptional
Screenshotscreenshot

A screenshot of the file format in use.

Stringoptional
Screenshot sizescreenshot_size

Size of the screenshot to show including a unit (most likely pixels - 'px').

Default
300px
Stringoptional
Captioncaption

Caption to the screenshot.

Stringoptional
Extensionextension

The format's filename extension, if only one.

Stringsuggested
Extensionsextensions

The format's filename extensions, if more than one.

Stringoptional
No code style in extension_noextcode

If set to 'true', then extensions won't be formatted using monospace font.

Stringoptional
MIME typemime

The MIME type of the file.

Stringsuggested
No code style in MIME_nomimecode

If set to 'true', then MIME won't be formatted using monospace font.

Stringoptional
Type codetype_code type code typecode

The type code of the file used by Mac OS Classic.

Stringoptional
Uniform Type Identifier (UTI)uniform_type uniform type

The Uniform Type Identifier, used by contemporary macOS computers and iOS devices.

Stringoptional
UTI conformationconforms_to conforms to

The immediate parents of the UTI. For example, public.png would conform to public.image.

Stringoptional
Magic numbermagic

A number or other data structure usually near the beginning of a file used to identify the file contents.

Stringoptional
Developed bydeveloper owner

The owner of the format.

Stringsuggested
Type of formattype genre

The type of the file format, what does it store (e.g. Vector image format).

Stringsuggested
Initial releasereleased

The date the format was publicly released.

Stringoptional
Latest release versionlatest_release_version latest release version

Latest version number of the format.

Stringoptional
Latest release datelatest_release_date latest release date

Date the latest version was released.

Stringoptional
Container forcontainer_for container for containerfor

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).

Stringoptional
Contained bycontained_by contained by containedby

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).

Stringoptional
Extended fromextended_from extended from extendedfrom

The format that this one is based on, if any.

Stringoptional
Extended toextended_to extended to extendedto

The format that this one is base for, if any.

Stringoptional
Standardstandard

Standard this format is part of, if only one.

Stringoptional
Standardsstandards

Standards this format is part of, if more than one.

Stringoptional
Open format?free

Is it a free/open format?

Stringoptional
Websiteurl

URL of the file format's website, specification, etc.

Stringsuggested

Tracking category