Template:FormatInfo

From Just Solve the File Format Problem
(Difference between revisions)
Jump to: navigation, search
(Initial formatting of usage documentation.)
 
(82 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
<table class="infobox formatinfo" border="0" style="float: right; border: 1px solid #666666; max-width: 15%; background-color: #F8F8F8; padding: 0.25em; margin: 0.25em 1em;">
+
<table class="infobox formatinfo" border="0" style="float: right; border: 1px solid #666666; max-width: 25%; overflow: hidden; background-color:{{#switch: {{{formattype}}}
−
{{FormatInfo/row|<includeonly>Name</includeonly>|{{{name|<includeonly>{{PAGENAME}}</includeonly>}}}}}
+
|electronic=#F8E0F7
−
{{#if:{{{extensions|}}}|
+
|physical=#F6E3CE
−
{{FormatInfo/row|Extension(s)|{{{extensions}}}}}
+
|organic=#CEF6CE
−
}}{{#if:{{{mimetypes|}}}|
+
|Languages=#CEE3F6
−
{{FormatInfo/row|MIME Type(s)|{{{mimetypes}}}}}
+
|#F8E0F7
 +
}};
 +
padding: 0.25em; margin: 0.25em 1em;">
 +
<tr>
 +
<th colspan="2">[[File Formats|File Format]]<includeonly>[[Category:File Formats]]</includeonly></th>
 +
</tr>
 +
{{FormatInfo/row|Name|{{{name|{{PAGENAME}}}}}{{DEFAULTSORT:{{{name|{{PAGENAME}}}}}}}}}
 +
{{FormatInfo/row
 +
| Ontology
 +
|
 +
<ul><li>
 +
{{#switch: {{{formattype}}}
 +
|electronic=[[Electronic File Formats]]<includeonly>[[Category:Electronic File Formats]]</includeonly>
 +
|physical=[[Physical File Formats]]<includeonly>[[Category:Physical File Formats]]</includeonly>
 +
|organic=[[Organic File Formats]]<includeonly>[[Category:Organic File Formats]]</includeonly>
 +
|[[{{{formattype|Electronic File Formats}}}]]<includeonly>[[Category:{{{formattype|Electronic File Formats}}}]]</includeonly>
 +
}}
 +
<ul><li>
 +
{{#if:{{{subcat|}}}
 +
|[[{{{subcat}}}]]<includeonly>[[Category:{{{subcat}}}]]</includeonly>
 +
<ul><li>
 +
{{#if:{{{subcat2|}}}
 +
|[[{{{subcat2}}}]]<includeonly>[[Category:{{{subcat2}}}]]</includeonly>
 +
<ul><li>
 +
{{#if:{{{subcat3|}}}
 +
|[[{{{subcat3}}}]]<includeonly>[[Category:{{{subcat3}}}]]</includeonly>
 +
<ul><li>
 +
{{#if:{{{subcat4|}}}
 +
|[[{{{subcat4}}}]]<includeonly>[[Category:{{{subcat4}}}]]</includeonly>
 +
<ul><li>
 +
{{#if:{{{subcat5|}}}
 +
|[[{{{subcat5}}}]]<includeonly>[[Category:{{{subcat5}}}]]</includeonly>
 +
<ul><li>
 +
{{#if:{{{thiscat|}}}|[[{{{thiscat}}}]]<includeonly>[[Category:{{{thiscat}}}| ]]</includeonly>|[[{{{name|{{PAGENAME}}}}}]]}}
 +
</li></ul>
 +
|{{#if:{{{thiscat|}}}|[[{{{thiscat}}}]]<includeonly>[[Category:{{{thiscat}}}| ]]</includeonly>|[[{{{name|{{PAGENAME}}}}}]]}}
 +
}}
 +
</li></ul>
 +
|{{#if:{{{thiscat|}}}|[[{{{thiscat}}}]]<includeonly>[[Category:{{{thiscat}}}| ]]</includeonly>|[[{{{name|{{PAGENAME}}}}}]]}}
 +
}}
 +
</li></ul>
 +
|{{#if:{{{thiscat|}}}|[[{{{thiscat}}}]]<includeonly>[[Category:{{{thiscat}}}| ]]</includeonly>|[[{{{name|{{PAGENAME}}}}}]]}}
 +
}}
 +
</li></ul>
 +
|{{#if:{{{thiscat|}}}|[[{{{thiscat}}}]]<includeonly>[[Category:{{{thiscat}}}| ]]</includeonly>|[[{{{name|{{PAGENAME}}}}}]]}}
 +
}}
 +
</li></ul>
 +
|{{#if:{{{thiscat|}}}|[[{{{thiscat}}}]]<includeonly>[[Category:{{{thiscat}}}| ]]</includeonly>|[[{{{name|{{PAGENAME}}}}}]]}}
 +
}}
 +
</li></ul>
 +
</li></ul>
 +
}}{{#if:{{{extensions|{{{extension|}}}}}}|
 +
{{FormatInfo/row|[[Filename extension|Extension(s)]]|{{{extensions|{{{extension}}}}}}}}
 +
}}{{#if:{{{mimetypes|{{{mimetype|}}}}}}|
 +
{{FormatInfo/row|[[MIME types|MIME Type(s)]]|{{{mimetypes|{{{mimetype}}}}}}}}
 +
}}{{#if:{{{locfdd|}}}|
 +
{{FormatInfo/row|LoCFDD|{{{locfdd}}}}}
 
}}{{#if:{{{fourccs|}}}|
 
}}{{#if:{{{fourccs|}}}|
−
{{FormatInfo/row|FourCC|{{{fourccs}}}}}
+
{{FormatInfo/row|[[FourCC]]|{{{fourccs}}}}}
 
}}{{#if:{{{pronom|}}}|
 
}}{{#if:{{{pronom|}}}|
−
{{FormatInfo/row|PRONOM|[http://www.nationalarchives.gov.uk/PRONOM/{{{pronom}}} {{{pronom}}}]}}
+
{{FormatInfo/row|[[PRONOM]]|{{{pronom}}}}}
 +
}}{{#if:{{{type code|}}}|
 +
{{FormatInfo/row|[[Macintosh type/creator code|Type Code]]|{{{type code}}}}}
 +
}}{{#if:{{{uniform type|}}}|
 +
{{FormatInfo/row|[[Uniform Type Identifier|UTI]]|{{{uniform type}}}}}
 +
}}{{#if:{{{wikidata|}}}|
 +
{{FormatInfo/row|[[Wikidata identifier|Wikidata ID]]|{{{wikidata}}}}}
 +
}}{{#if:{{{compression|}}}|
 +
{{FormatInfo/row|[[Compression]]|{{{compression}}}}}
 +
}}{{#if:{{{extended from|}}}|
 +
{{FormatInfo/row|Extended From|[[{{{extended from}}}]]}}
 +
}}{{#if:{{{extended to|}}}|
 +
{{FormatInfo/row|Extended To|[[{{{extended to}}}]]}}
 +
}}{{#if:{{{magic|}}}|
 +
{{FormatInfo/row|[[Magic]] Bytes|{{{magic}}}}}
 +
}}{{#if:{{{kaitai struct|}}}|
 +
{{FormatInfo/row|[[Kaitai Struct|Kaitai Struct Spec]]|[http://formats.kaitai.io/{{{kaitai struct}}}/index.html {{{kaitai struct}}}.ksy]}}
 +
}}{{#if:{{{spec|}}}|
 +
{{FormatInfo/row|Spec|{{{spec}}}}}
 +
}}{{#if:{{{spec availability|}}}|
 +
{{FormatInfo/row|Spec Availability|{{{spec availability}}}}}
 +
}}{{#if:{{{reference impl|}}}|
 +
{{FormatInfo/row|Reference Implementation|{{{reference impl}}}}}
 +
}}{{#if:{{{conforms to|}}}|
 +
{{FormatInfo/row|Conforms To|{{{conforms to}}}}}
 +
}}{{#if:{{{charset|}}}|
 +
{{FormatInfo/row|[[IANA character set name|IANA charset]]|[http://www.iana.org/assignments/charset-reg/{{{charset}}} {{{charset}}}]}}
 +
}}{{#if:{{{charsetaliases|}}}|
 +
{{FormatInfo/row|IANA aliases|{{{charsetaliases}}}}}
 +
}}{{#if:{{{mibenum|}}}|
 +
{{FormatInfo/row|IANA MIBenum|{{{mibenum}}}}}
 +
}}{{#if:{{{codepage|}}}|
 +
{{FormatInfo/row|[[Code page identifier|Code Page]]|{{{codepage}}}}}
 +
}}{{#if:{{{cfstringencoding|}}}|
 +
{{FormatInfo/row|CFStringEncoding|{{{cfstringencoding}}}}}
 +
}}{{#if:{{{nsstringencoding|}}}|
 +
{{FormatInfo/row|NSStringEncoding|{{{nsstringencoding}}}}}
 +
}}{{#if:{{{endianness|}}}|
 +
{{FormatInfo/row|[[Endianness]]|{{{endianness}}}}}
 +
}}{{#if:{{{tpm|}}}|
 +
{{FormatInfo/row|TPM|{{{tpm}}}}}
 +
}}{{#if:{{{error resilience|}}}|
 +
{{FormatInfo/row|Error Resilience|{{{error resilience}}}}}
 +
}}{{#if:{{{patent license|}}}|
 +
{{FormatInfo/row|Patent License|{{{patent license}}}}}
 +
}}{{#if:{{{developed by|}}}|
 +
{{FormatInfo/row|Developed By|{{{developed by}}}}}
 +
}}{{#if:{{{maintained by|}}}|
 +
{{FormatInfo/row|Maintained By|{{{maintained by}}}}}
 +
}}{{#if:{{{released|}}}|
 +
{{FormatInfo/row|Released|{{{released}}}}}
 +
}}
 +
{{#if:{{{image|}}}|
 +
<tr><td align="center" colspan="2">
 +
[[Image:{{{image}}}|200px|{{{caption}}}]]
 +
</td></tr>
 +
}}
 +
{{#if:{{{caption|}}}|
 +
<tr><td align="center" colspan="2">
 +
<small>{{{caption}}}</small>
 +
</td></tr>
 
}}
 
}}
 
</table>
 
</table>
−
<noinclude>
+
<includeonly>{{#if:{{{formattype|}}}||[[Category:FormatInfo without formattype]]}}{{#if:{{{subcat|}}}||[[Category:FormatInfo without subcat]]}}{{#ifeq:{{{formattype|electronic}}}|electronic|{{#if:{{{extensions|}}}||[[Category:FormatInfo without extensions]]}}{{#if:{{{mimetypes|}}}||[[Category:FormatInfo without mimetypes]]}}|}}</includeonly><noinclude>
 
== Usage ==
 
== Usage ==
 
<pre>
 
<pre>
 
{{FormatInfo
 
{{FormatInfo
−
| name                   =  
+
| name             =
 +
| formattype      =
 +
| subcat          =
 +
| subcat2          =
 +
| subcat3          =
 +
| subcat4          =
 +
| subcat5          =
 +
| thiscat          =
 +
| extensions      =
 +
| mimetypes        =
 +
| locfdd          =
 +
| fourccs          =
 +
| pronom          =
 +
| type code        =
 +
| uniform type    =
 +
| wikidata        =
 +
| compression      =
 +
| extended from    =
 +
| extended to      =
 +
| magic            =
 +
| kaitai struct    =
 +
| spec            =
 +
| spec availability=
 +
| reference impl  =
 +
| conforms to      =
 +
| charset          =
 +
| charsetaliases  =
 +
| codepage        =
 +
| mibenum          =
 +
| cfstringencoding =
 +
| nsstringencoding =
 +
| endianness      =
 +
| tpm              =
 +
| error resilience =
 +
| patent license  =
 +
| developed by    =
 +
| maintained by    =
 +
| released        =
 +
| image            =
 +
| caption          =
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
===Parameters===
 +
;name: '''(optional)''' The name of the file format. ''Default: <nowiki>{{PAGENAME}}</nowiki>''
 +
;formattype: '''(optional)''' The [[File Formats|type]] of the file format. Choose 'electronic', 'physical', or 'organic', or specify your own. ''Default: electronic''
 +
;subcat: '''(optional)''' The subcategory of the file format.
 +
;subcat2: '''(optional)''' An additional subcategory of the file format.
 +
;subcat3: '''(optional)''' An additional subcategory of the file format.
 +
;subcat4: '''(optional)''' An additional subcategory of the file format.
 +
;subcat5: '''(optional)''' An additional subcategory of the file format.
 +
;thiscat: '''(optional)''' Special parameter for indicating ontology of a non-terminal subcategory page.
 +
;extensions: '''(optional)''' The format's known filename extensions. Use [[Template:ext|<nowiki>{{ext}}</nowiki>]], or [[Template:Noext|<nowiki>{{Noext}}</nowiki>]] if it is known to be extensionless.
 +
;mimetypes: '''(optional)''' The MIME type of the format. Use [[Template:mimetype|<nowiki>{{mimetype}}</nowiki>]].
 +
;locfdd: '''(optional)''' Identifier for this format from the Library of Congress Sustainability of Digital Formats, e.g. "fdd000314". Use [[Template:LoCFDD|<nowiki>{{LoCFDD}}</nowiki>]].
 +
;fourccs: '''(optional)''' FourCC code
 +
;pronom: '''(optional)''' The [[Sources/PRONOM|PRONOM]] ID of the format, e.g. "fmt/45". Use [[Template:PRONOM|<nowiki>{{PRONOM}}</nowiki>]].
 +
;type code: '''(optional)''' The Type Code of the file, used by Mac OS Classic. Use [[Template:Type Code|<nowiki>{{Type Code}}</nowiki>]].
 +
;uniform type: '''(optional)''' The Uniform Type Identifier (UTI), used by Mac OS X and iOS. Use [[Template:UTI|<nowiki>{{UTI}}</nowiki>]].
 +
;wikidata: '''(optional)''' Wikidata title ID. Use [[Template:wikidata|<nowiki>{{wikidata}}</nowiki>]].
 +
;compression: Types of compression. Whether Lossy, Lossless, or Both, and whether Optional or Always compressed. i.e. JPEG is Always Lossy.
 +
;extended from: Any formats this one was based upon.
 +
;extended to: Any formats that have been derived from this one.
 +
;magic: A sequence of byte values that can be used to identify the file contents, usually located close to the start of the file.
 +
;kaitai struct: '''(optional)''' An identifier of a format at [http://formats.kaitai.io Kaitai Struct] project, e.g. "ico" would result in a link to http://formats.kaitai.io/ico/index.html generated.
 +
;spec: URL of the format specification.
 +
;spec availability: Type of availability the specification, e.g. commercial, free.
 +
;reference impl: Link to page about the reference implementation of this format, if any.
 +
;conforms to: '''(optional)''' The UTI of the parent format in the conformance hierarchy.
 +
;charset: '''(optional)''' For character encodings: IANA charset parameter value.
 +
;charsetaliases: '''(optional)''' For character encodings: Variant IANA charset parameter values.
 +
;codepage: '''(optional)''' For character encodings: Code page number (IBM/MS).
 +
;mibenum: '''(optional)''' For character encodings: IANA MIBenum.
 +
;cfstringencoding: '''(optional)''' For character encodings: CFStringEncoding.
 +
;nsstringencoding: '''(optional)''' For character encodings: NSStringEncoding.
 +
;endianness: Big-endian or Little-endian byte ordering.
 +
;tpm: Technical Protection Mechanisms supported by the format, e.g. encryption.
 +
;error resilience: Is this format able to detect damage or recover from damage to the bitstream.
 +
;patent license: Unknown, Disputed, Encumbered, (F)RAND, Royalty-Free, Unencumbered.
 +
;developed by: Who developed the format.
 +
;maintained by: Who now maintains the format.
 +
;released: '''(optional)''' The date the format was publicly released.
 +
;image: '''(optional)''' Illustration to show in infobox.
 +
;caption: '''(optional)''' Caption for image
 +
 +
===Potential Parameters===
 +
This is a list of parameters that could be included in this template.
 +
 +
;mime & mime aliases: Split mimetypes into primary type and known aliases.
 +
;version: The version of the format, e.g. "1.4" for PDF 1.4
 +
;previous version: Link to page about the previous version of this format.
 +
;next version: Link to page about the next version of this format.
 +
;back compat: Whether this version is backwards compatible with the previous version.
 +
;wikipedia: Name of the Wikipedia page that describes this format, e.g. "JPEG 2000" will be rendered as [[Wikipedia:JPEG 2000|JPEG 2000]]
 +
;container for: A list of formats this format can contain.
 +
;contained by: A list of formats that may contain this format.
 +
;embeddable metadata: Kinds of metadata that can be embedded in this format.
 +
;dependencies: External resources that files in this format may depend upon, e.g. fonts, or even hardware.
 +
;namespace: The namespace-uri that defines the file format if it is XML-based.
  
 
==Examples==
 
==Examples==
  
 +
 +
[[Category:File Formats| ]]
 
</noinclude>
 
</noinclude>

Latest revision as of 06:18, 12 June 2021

File Format
Name FormatInfo
Ontology

Contents

[edit] Usage 

{{FormatInfo
| name             = 
| formattype       = 
| subcat           = 
| subcat2          = 
| subcat3          = 
| subcat4          = 
| subcat5          = 
| thiscat          = 
| extensions       = 
| mimetypes        = 
| locfdd           = 
| fourccs          =
| pronom           =
| type code        =
| uniform type     =
| wikidata         =
| compression      =
| extended from    =
| extended to      =
| magic            =
| kaitai struct    =
| spec             =
| spec availability=
| reference impl   =
| conforms to      = 
| charset          =
| charsetaliases   =
| codepage         =
| mibenum          =
| cfstringencoding =
| nsstringencoding =
| endianness       =
| tpm              =
| error resilience =
| patent license   =
| developed by     =
| maintained by    =
| released         =
| image            =
| caption          =
}}

[edit] Parameters

name
(optional) The name of the file format. Default: {{PAGENAME}}
formattype
(optional) The type of the file format. Choose 'electronic', 'physical', or 'organic', or specify your own. Default: electronic
subcat
(optional) The subcategory of the file format.
subcat2
(optional) An additional subcategory of the file format.
subcat3
(optional) An additional subcategory of the file format.
subcat4
(optional) An additional subcategory of the file format.
subcat5
(optional) An additional subcategory of the file format.
thiscat
(optional) Special parameter for indicating ontology of a non-terminal subcategory page.
extensions
(optional) The format's known filename extensions. Use {{ext}}, or {{Noext}} if it is known to be extensionless.
mimetypes
(optional) The MIME type of the format. Use {{mimetype}}.
locfdd
(optional) Identifier for this format from the Library of Congress Sustainability of Digital Formats, e.g. "fdd000314". Use {{LoCFDD}}.
fourccs
(optional) FourCC code
pronom
(optional) The PRONOM ID of the format, e.g. "fmt/45". Use {{PRONOM}}.
type code
(optional) The Type Code of the file, used by Mac OS Classic. Use {{Type Code}}.
uniform type
(optional) The Uniform Type Identifier (UTI), used by Mac OS X and iOS. Use {{UTI}}.
wikidata
(optional) Wikidata title ID. Use {{wikidata}}.
compression
Types of compression. Whether Lossy, Lossless, or Both, and whether Optional or Always compressed. i.e. JPEG is Always Lossy.
extended from
Any formats this one was based upon.
extended to
Any formats that have been derived from this one.
magic
A sequence of byte values that can be used to identify the file contents, usually located close to the start of the file.
kaitai struct
(optional) An identifier of a format at Kaitai Struct project, e.g. "ico" would result in a link to http://formats.kaitai.io/ico/index.html generated.
spec
URL of the format specification.
spec availability
Type of availability the specification, e.g. commercial, free.
reference impl
Link to page about the reference implementation of this format, if any.
conforms to
(optional) The UTI of the parent format in the conformance hierarchy.
charset
(optional) For character encodings: IANA charset parameter value.
charsetaliases
(optional) For character encodings: Variant IANA charset parameter values.
codepage
(optional) For character encodings: Code page number (IBM/MS).
mibenum
(optional) For character encodings: IANA MIBenum.
cfstringencoding
(optional) For character encodings: CFStringEncoding.
nsstringencoding
(optional) For character encodings: NSStringEncoding.
endianness
Big-endian or Little-endian byte ordering.
tpm
Technical Protection Mechanisms supported by the format, e.g. encryption.
error resilience
Is this format able to detect damage or recover from damage to the bitstream.
patent license
Unknown, Disputed, Encumbered, (F)RAND, Royalty-Free, Unencumbered.
developed by
Who developed the format.
maintained by
Who now maintains the format.
released
(optional) The date the format was publicly released.
image
(optional) Illustration to show in infobox.
caption
(optional) Caption for image

[edit] Potential Parameters

This is a list of parameters that could be included in this template.

mime & mime aliases
Split mimetypes into primary type and known aliases.
version
The version of the format, e.g. "1.4" for PDF 1.4
previous version
Link to page about the previous version of this format.
next version
Link to page about the next version of this format.
back compat
Whether this version is backwards compatible with the previous version.
wikipedia
Name of the Wikipedia page that describes this format, e.g. "JPEG 2000" will be rendered as JPEG 2000
container for
A list of formats this format can contain.
contained by
A list of formats that may contain this format.
embeddable metadata
Kinds of metadata that can be embedded in this format.
dependencies
External resources that files in this format may depend upon, e.g. fonts, or even hardware.
namespace
The namespace-uri that defines the file format if it is XML-based.

[edit] Examples

Retrieved from "http://fileformats.archiveteam.org/index.php?title=Template:FormatInfo&oldid=40029"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox