Template:FormatInfo

From Just Solve the File Format Problem
(Difference between revisions)
Jump to: navigation, search
(Initial formatting of usage documentation.)
(Usage note, and long list of possible parameters.)
Line 16: Line 16:
 
{{FormatInfo
 
{{FormatInfo
 
| name                  =  
 
| name                  =  
 +
| extensions            =
 +
| mimetypes              =
 +
| pronom                =
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
===Parameters===
 +
;name: The name of the file format (optional - will default to the page name)
 +
;extensions: The format's known filename extensions, space separated, including the dot, e.g. ".pdf .fdf"
 +
;mimetypes: The MIME type of the format.
 +
;pronom: The [[Sources/PRONOM|PRONOM]] ID of the format, e.g. "fmt/45".
 +
 +
===Potential Parameters===
 +
;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.
 +
;type code: The Type Code of the file, used by Mac OS Classic.
 +
;uniform type: The Uniform Type Identifier (UTI), used by Mac OS X and iOS.
 +
;conforms to: The UTI of the parent format in the conformance hierarchy.
 +
;magic: A sequence of byte values that can be used to identify the file contents, usually located close to the start of the file.
 +
;released: The date the format was publicly released.
 +
;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: 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.
 +
  
 
==Examples==
 
==Examples==
  
 
</noinclude>
 
</noinclude>

Revision as of 03:09, 4 November 2012

Contents

Usage

{{FormatInfo
| name                   = 
| extensions             = 
| mimetypes              = 
| pronom                 = 
}}

Parameters

name
The name of the file format (optional - will default to the page name)
extensions
The format's known filename extensions, space separated, including the dot, e.g. ".pdf .fdf"
mimetypes
The MIME type of the format.
pronom
The PRONOM ID of the format, e.g. "fmt/45".

Potential Parameters

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.
type code
The Type Code of the file, used by Mac OS Classic.
uniform type
The Uniform Type Identifier (UTI), used by Mac OS X and iOS.
conforms to
The UTI of the parent format in the conformance hierarchy.
magic
A sequence of byte values that can be used to identify the file contents, usually located close to the start of the file.
released
The date the format was publicly released.
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
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.


Examples

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox