Template:FormatInfo
From Just Solve the File Format Problem
(Difference between revisions)
(it's much easier to see the line when there are not thousands of spaces (removed 8)) |
(Added Kaitai Struct link (approved by xmc on #archiveteam-bs)) |
||
| Line 69: | Line 69: | ||
}}{{#if:{{{uniform type|}}}| | }}{{#if:{{{uniform type|}}}| | ||
{{FormatInfo/row|UTI|{{{uniform type}}}}} | {{FormatInfo/row|UTI|{{{uniform type}}}}} | ||
| + | }}{{#if:{{{kaitai struct|}}}| | ||
| + | {{FormatInfo/row|Formal Spec (.ksy)|[http://formats.kaitai.io/{{{kaitai struct}}}/index.html {{{kaitai struct}}}.ksy]}} | ||
}}{{#if:{{{conforms to|}}}| | }}{{#if:{{{conforms to|}}}| | ||
{{FormatInfo/row|Conforms To|{{{conforms to}}}}} | {{FormatInfo/row|Conforms To|{{{conforms to}}}}} | ||
| Line 104: | Line 106: | ||
| type code = | | type code = | ||
| uniform type = | | uniform type = | ||
| + | | kaitai struct = | ||
| conforms to = | | conforms to = | ||
| released = | | released = | ||
| Line 127: | Line 130: | ||
;type code: '''(optional)''' The Type Code of the file, used by Mac OS Classic. | ;type code: '''(optional)''' The Type Code of the file, used by Mac OS Classic. | ||
;uniform type: '''(optional)''' The Uniform Type Identifier (UTI), used by Mac OS X and iOS. | ;uniform type: '''(optional)''' The Uniform Type Identifier (UTI), used by Mac OS X and iOS. | ||
| + | ;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. | ||
;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. | ||
;released: '''(optional)''' The date the format was publicly released. | ;released: '''(optional)''' The date the format was publicly released. | ||
Revision as of 17:18, 22 June 2017
Contents |
Usage
{{FormatInfo
| name =
| formattype =
| subcat =
| subcat2 =
| subcat3 =
| subcat4 =
| subcat5 =
| thiscat =
| extensions =
| mimetypes =
| locfdd =
| fourccs =
| pronom =
| type code =
| uniform type =
| kaitai struct =
| conforms to =
| released =
| image =
| caption =
}}
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}}.
- 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.
- uniform type
- (optional) The Uniform Type Identifier (UTI), used by Mac OS X and iOS.
- 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.
- conforms to
- (optional) The UTI of the parent format in the conformance hierarchy.
- 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.
- charset
- For character encodings, the value of the charset parameter used to identify it in MIME headers
- 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
- magic
- A sequence of byte values that can be used to identify the file contents, usually located close to the start of the file.
- container for
- A list of formats this format can contain.
- contained by
- A list of formats that may contain this format.
- extended from
- Any formats this one was based upon.
- extended to
- Any formats that have been derived from this one.
- spec
- URL of the format specification.
- spec availability
- Type of availability the specification, e.g. commercial, free.
- patent license
- Unknown, Disputed, Encumbered, (F)RAND, Royalty-Free, Unencumbered.
- compression
- Types of compression. Whether Lossy, Lossless, or Both, and whether Optional or Always compressed. i.e. JPEG is Always Lossy.
- endianness
- Big-endian or Little-endian byte ordering.
- developed by
- Who developed the format.
- maintained by
- Who now maintains the format.
- reference impl
- Link to page about the reference implementation of this format, if any.
- embeddable metadata
- Kinds of metadata that can be embedded in this format.
- tpm
- Technical Protection Mechanisms supported by the format, e.g. encryption.
- dependencies
- External resources that files in this format may depend upon, e.g. fonts, or even hardware.
- error resiliance
- Is this format able to detect damage or recover from damage to the bitstream.
- namespace
- The namespace-uri that defines the file format if it is XML-based.
