Template:FormatInfo

From Just Solve the File Format Problem
(Difference between revisions)
Jump to: navigation, search
(Parameters: Add links to additional templates)
Line 73: Line 73:
 
}}{{#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 Spec|[http://formats.kaitai.io/{{{kaitai struct}}}/index.html {{{kaitai struct}}}.ksy]}}
 +
}}{{#if:{{{spec|}}}|
 +
{{FormatInfo/row|Spec|{{{spec}}}}}
 
}}{{#if:{{{conforms to|}}}|
 
}}{{#if:{{{conforms to|}}}|
 
{{FormatInfo/row|Conforms To|{{{conforms to}}}}}
 
{{FormatInfo/row|Conforms To|{{{conforms to}}}}}
Line 87: Line 89:
 
}}{{#if:{{{nsstringencoding|}}}|
 
}}{{#if:{{{nsstringencoding|}}}|
 
{{FormatInfo/row|NSStringEncoding|{{{nsstringencoding}}}}}
 
{{FormatInfo/row|NSStringEncoding|{{{nsstringencoding}}}}}
 +
}}{{#if:{{{endianness|}}}|
 +
{{FormatInfo/row|Endianness|{{{endianness}}}}}
 
}}{{#if:{{{released|}}}|
 
}}{{#if:{{{released|}}}|
 
{{FormatInfo/row|Released|{{{released}}}}}
 
{{FormatInfo/row|Released|{{{released}}}}}
Line 153: Line 157:
 
;wikidata: '''(optional)''' Wikidata title ID. Use [[Template:wikidata|<nowiki>{{wikidata}}</nowiki>]].
 
;wikidata: '''(optional)''' Wikidata title ID. Use [[Template:wikidata|<nowiki>{{wikidata}}</nowiki>]].
 
;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.
 
;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.
Line 161: Line 166:
 
;cfstringencoding: '''(optional)''' For character encodings: CFStringEncoding.
 
;cfstringencoding: '''(optional)''' For character encodings: CFStringEncoding.
 
;nsstringencoding: '''(optional)''' For character encodings: NSStringEncoding.
 
;nsstringencoding: '''(optional)''' For character encodings: NSStringEncoding.
 +
;endianness: Big-endian or Little-endian byte ordering.
 
;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 178: Line 184:
 
;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.
 
;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.
 
;spec availability: Type of availability the specification, e.g. commercial, free.
 
;patent license: Unknown, Disputed, Encumbered, (F)RAND, Royalty-Free, Unencumbered.
 
;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.
 
;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.
 
;developed by: Who developed the format.
 
;maintained by: Who now maintains the format.
 
;maintained by: Who now maintains the format.

Revision as of 15:04, 25 January 2020

File Format
Name FormatInfo
Ontology

Contents

Usage

{{FormatInfo
| name             = 
| formattype       = 
| subcat           = 
| subcat2          = 
| subcat3          = 
| subcat4          = 
| subcat5          = 
| thiscat          = 
| extensions       = 
| mimetypes        = 
| locfdd           = 
| fourccs          =
| pronom           =
| type code        =
| uniform type     =
| wikidata         =
| kaitai struct    =
| conforms to      = 
| released         =
| charset          =
| charsetaliases   =
| codepage         =
| mibenum          =
| cfstringencoding =
| nsstringencoding =
| 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}}, 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}}.
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.
conforms to
(optional) The UTI of the parent format in the conformance hierarchy.
released
(optional) The date the format was publicly released.
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.
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 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 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.
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.

Examples

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox