View source for Template:Infobox file format/doc

{{Documentation subpage}}
<!----EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE---->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

== Blank syntax ==
{{Generic template demo |_display=italics
 |name |icon={{{icon}}} |iconcaption |screenshot={{{screenshot}}} |caption
 |extension=''extension''[''s''] |mime |typecode |uniform type |conforms to |magic |developer
 |released=<span style{{=}}"font-size:90%;white-space:nowrap;"><nowiki>{{start date and age |…}}</nowiki></span> |latest_release_version
 |latest_release_date=<span style{{=}}"font-size:90%;white-space:nowrap;"><nowiki>{{start date and age |…}}</nowiki></span>
 |genre |containerfor |containedby |extendedfrom |extendedto |standard={{nowrap|''standard'' &nbsp;(''standards'')}} |free |url
}}

<pre style="overflow:auto;">
{{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 = 
}}
</pre>
By default, ''extension'' and ''mime'' are displayed using {{tag|code}}; to disable this (in order to customize their formatting), assign ''_noextcode'' and/or ''_nomimecode'' a value ("on", "true", etc.).

{{clear}}

== Examples ==

{{Infobox file format{{\sandbox}}
| 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/}}
}}
<syntaxhighlight lang="xml" style="margin-top:2.75em;overflow:auto;">
{{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/}}
}}
</syntaxhighlight>

{{clear}}

{{Infobox file format{{\sandbox}}
| name = OpenDocument Text
| icon = [[File:ODF textdocument 48x48.png|ODF textdocument icon]]
| screenshot = | caption = 
| extension = .odt
| mime = application/vnd.<br/>&nbsp;oasis.opendocument.<br/>&nbsp;text
| type_code = 
| uniform_type = <code>org.oasis.<br/>&nbsp;opendocument.text</code><ref>(www.huw.id.au ref)</ref>
| conforms_to = {{nowrap|<code>org.oasis-open.<br/>&nbsp;opendocument</code><br/><code>public.composite-<br/>&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 = 
}}
<syntaxhighlight lang="xml" style="margin-top:2.0em;overflow:auto;">
{{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 = 
}}
</syntaxhighlight>

{{clear}}

== Parameters ==

; name         : The name of the file format.
; icon         : A [[icon (computing)|file icon]] used by either the application that popularized the format or a common free icon. Alias is {{para|logo}}.
; iconcaption  : caption describing the icon.
; screenshot   : A [[screen shot]] of the file format in use.
; caption      : caption to the screen shot.
; extension {{nobold|(or '''extensions''')}} : The format's [[filename extension]] or extensions. Set {{para<!--|plain-->|_noextcode}} to disable the default monospace font.
; mime         : The [[MIME]] type of the file. Set {{para<!--|plain-->|_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, <code>public.png</code> would conform to <code>public.image</code>
; magic        : A [[file format#Magic number|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 [[Digital container format|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 {{nobold|(or '''standards''')}} : If the format is part of a [[Technical standard|standard]] or standards, list it/them here.
; free         : Is it a free/open format?
; url          : URL of the file format's website, specification, etc.

<div style="display:none;">{{reflist}}</div>

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"description": "Consistently-formatted table for presenting information about file formats",
	"format": "{{_\n| _____________ = _\n}}\n",
	"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 code style in extension",
			"description": "If set to 'true', then extensions won't be formatted using monospace font.",
			"type": "string"
		},
		"mime": {
			"label": "MIME type",
			"type": "string",
			"description": "The MIME type of the file.",
			"suggested": true
		},
		"_nomimecode": {
			"label": "No code style in MIME",
			"description": "If set to 'true', then MIME won't be formatted using monospace font.",
			"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"
	]
}
</templatedata>

== Tracking category ==
* {{clc|Pages using infobox file format with unknown parameters}}

<includeonly>{{basepage subpage| 
<!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Software infobox templates|File format]]
[[Category:Embeddable templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>