Template:FormatInfo
From Just Solve the File Format Problem
(Difference between revisions)
Dan Tobias (Talk | contribs) (Added more of the potential parameters) |
Dan Tobias (Talk | contribs) |
||
(13 intermediate revisions by 2 users not shown) | |||
Line 56: | Line 56: | ||
</li></ul> | </li></ul> | ||
}}{{#if:{{{extensions|{{{extension|}}}}}}| | }}{{#if:{{{extensions|{{{extension|}}}}}}| | ||
− | {{FormatInfo/row|Extension(s)|{{{extensions|{{{extension}}}}}}}} | + | {{FormatInfo/row|[[Filename extension|Extension(s)]]|{{{extensions|{{{extension}}}}}}}} |
}}{{#if:{{{mimetypes|{{{mimetype|}}}}}}| | }}{{#if:{{{mimetypes|{{{mimetype|}}}}}}| | ||
− | {{FormatInfo/row|MIME Type(s)|{{{mimetypes|{{{mimetype}}}}}}}} | + | {{FormatInfo/row|[[MIME types|MIME Type(s)]]|{{{mimetypes|{{{mimetype}}}}}}}} |
}}{{#if:{{{locfdd|}}}| | }}{{#if:{{{locfdd|}}}| | ||
{{FormatInfo/row|LoCFDD|{{{locfdd}}}}} | {{FormatInfo/row|LoCFDD|{{{locfdd}}}}} | ||
}}{{#if:{{{fourccs|}}}| | }}{{#if:{{{fourccs|}}}| | ||
− | {{FormatInfo/row|FourCC|{{{fourccs}}}}} | + | {{FormatInfo/row|[[FourCC]]|{{{fourccs}}}}} |
}}{{#if:{{{pronom|}}}| | }}{{#if:{{{pronom|}}}| | ||
− | {{FormatInfo/row|PRONOM|{{{pronom}}}}} | + | {{FormatInfo/row|[[PRONOM]]|{{{pronom}}}}} |
}}{{#if:{{{type code|}}}| | }}{{#if:{{{type code|}}}| | ||
− | {{FormatInfo/row|Type Code|{{{type code}}}}} | + | {{FormatInfo/row|[[Macintosh type/creator code|Type Code]]|{{{type code}}}}} |
}}{{#if:{{{uniform type|}}}| | }}{{#if:{{{uniform type|}}}| | ||
− | {{FormatInfo/row|UTI|{{{uniform type}}}}} | + | {{FormatInfo/row|[[Uniform Type Identifier|UTI]]|{{{uniform type}}}}} |
}}{{#if:{{{wikidata|}}}| | }}{{#if:{{{wikidata|}}}| | ||
− | {{FormatInfo/row|Wikidata ID|{{{wikidata}}}}} | + | {{FormatInfo/row|[[Wikidata identifier|Wikidata ID]]|{{{wikidata}}}}} |
}}{{#if:{{{compression|}}}| | }}{{#if:{{{compression|}}}| | ||
− | {{FormatInfo/row|Compression|{{{compression}}}}} | + | {{FormatInfo/row|[[Compression]]|{{{compression}}}}} |
}}{{#if:{{{extended from|}}}| | }}{{#if:{{{extended from|}}}| | ||
− | {{FormatInfo/row|Extended From|{{{extended from}}}}} | + | {{FormatInfo/row|Extended From|[[{{{extended from}}}]]}} |
+ | }}{{#if:{{{extended to|}}}| | ||
+ | {{FormatInfo/row|Extended To|[[{{{extended to}}}]]}} | ||
}}{{#if:{{{magic|}}}| | }}{{#if:{{{magic|}}}| | ||
− | {{FormatInfo/row|Magic Bytes|{{{magic}}}}} | + | {{FormatInfo/row|[[Magic]] Bytes|{{{magic}}}}} |
}}{{#if:{{{kaitai struct|}}}| | }}{{#if:{{{kaitai struct|}}}| | ||
− | {{FormatInfo/row|Kaitai Struct Spec|[http://formats.kaitai.io/{{{kaitai struct}}}/index.html {{{kaitai struct}}}.ksy]}} | + | {{FormatInfo/row|[[Kaitai Struct|Kaitai Struct Spec]]|[http://formats.kaitai.io/{{{kaitai struct}}}/index.html {{{kaitai struct}}}.ksy]}} |
}}{{#if:{{{spec|}}}| | }}{{#if:{{{spec|}}}| | ||
{{FormatInfo/row|Spec|{{{spec}}}}} | {{FormatInfo/row|Spec|{{{spec}}}}} | ||
+ | }}{{#if:{{{spec availability|}}}| | ||
+ | {{FormatInfo/row|Spec Availability|{{{spec availability}}}}} | ||
}}{{#if:{{{reference impl|}}}| | }}{{#if:{{{reference impl|}}}| | ||
{{FormatInfo/row|Reference Implementation|{{{reference impl}}}}} | {{FormatInfo/row|Reference Implementation|{{{reference impl}}}}} | ||
Line 86: | Line 90: | ||
{{FormatInfo/row|Conforms To|{{{conforms to}}}}} | {{FormatInfo/row|Conforms To|{{{conforms to}}}}} | ||
}}{{#if:{{{charset|}}}| | }}{{#if:{{{charset|}}}| | ||
− | {{FormatInfo/row|IANA charset|[http://www.iana.org/assignments/charset-reg/{{{charset}}} {{{charset}}}]}} | + | {{FormatInfo/row|[[IANA character set name|IANA charset]]|[http://www.iana.org/assignments/charset-reg/{{{charset}}} {{{charset}}}]}} |
}}{{#if:{{{charsetaliases|}}}| | }}{{#if:{{{charsetaliases|}}}| | ||
{{FormatInfo/row|IANA aliases|{{{charsetaliases}}}}} | {{FormatInfo/row|IANA aliases|{{{charsetaliases}}}}} | ||
Line 92: | Line 96: | ||
{{FormatInfo/row|IANA MIBenum|{{{mibenum}}}}} | {{FormatInfo/row|IANA MIBenum|{{{mibenum}}}}} | ||
}}{{#if:{{{codepage|}}}| | }}{{#if:{{{codepage|}}}| | ||
− | {{FormatInfo/row|Code Page|{{{codepage}}}}} | + | {{FormatInfo/row|[[Code page identifier|Code Page]]|{{{codepage}}}}} |
}}{{#if:{{{cfstringencoding|}}}| | }}{{#if:{{{cfstringencoding|}}}| | ||
{{FormatInfo/row|CFStringEncoding|{{{cfstringencoding}}}}} | {{FormatInfo/row|CFStringEncoding|{{{cfstringencoding}}}}} | ||
Line 98: | Line 102: | ||
{{FormatInfo/row|NSStringEncoding|{{{nsstringencoding}}}}} | {{FormatInfo/row|NSStringEncoding|{{{nsstringencoding}}}}} | ||
}}{{#if:{{{endianness|}}}| | }}{{#if:{{{endianness|}}}| | ||
− | {{FormatInfo/row|Endianness|{{{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|}}}| | }}{{#if:{{{released|}}}| | ||
{{FormatInfo/row|Released|{{{released}}}}} | {{FormatInfo/row|Released|{{{released}}}}} | ||
Line 135: | Line 149: | ||
| compression = | | compression = | ||
| extended from = | | extended from = | ||
+ | | extended to = | ||
| magic = | | magic = | ||
| kaitai struct = | | kaitai struct = | ||
| spec = | | spec = | ||
+ | | spec availability= | ||
| reference impl = | | reference impl = | ||
| conforms to = | | conforms to = | ||
− | |||
| charset = | | charset = | ||
| charsetaliases = | | charsetaliases = | ||
Line 148: | Line 163: | ||
| nsstringencoding = | | nsstringencoding = | ||
| endianness = | | endianness = | ||
+ | | tpm = | ||
+ | | error resilience = | ||
+ | | patent license = | ||
+ | | developed by = | ||
+ | | maintained by = | ||
+ | | released = | ||
| image = | | image = | ||
| caption = | | caption = | ||
Line 172: | Line 193: | ||
;compression: Types of compression. Whether Lossy, Lossless, or Both, and whether Optional or Always compressed. i.e. JPEG is Always Lossy. | ;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 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. | ;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. | ;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: 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. | ;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. | ;conforms to: '''(optional)''' The UTI of the parent format in the conformance hierarchy. | ||
− | |||
;charset: '''(optional)''' For character encodings: IANA charset parameter value. | ;charset: '''(optional)''' For character encodings: IANA charset parameter value. | ||
;charsetaliases: '''(optional)''' For character encodings: Variant IANA charset parameter values. | ;charsetaliases: '''(optional)''' For character encodings: Variant IANA charset parameter values. | ||
Line 185: | Line 207: | ||
;nsstringencoding: '''(optional)''' For character encodings: NSStringEncoding. | ;nsstringencoding: '''(optional)''' For character encodings: NSStringEncoding. | ||
;endianness: Big-endian or Little-endian byte ordering. | ;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. | ;image: '''(optional)''' Illustration to show in infobox. | ||
;caption: '''(optional)''' Caption for image | ;caption: '''(optional)''' Caption for image | ||
Line 199: | Line 227: | ||
;container for: A list of formats this format can contain. | ;container for: A list of formats this format can contain. | ||
;contained by: A list of formats that may contain this format. | ;contained by: A list of formats that may contain this format. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
;embeddable metadata: Kinds of metadata that can be embedded in 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. | ;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. | ;namespace: The namespace-uri that defines the file format if it is XML-based. | ||
Latest revision as of 06:18, 12 June 2021
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.