Template:Compression Infobox

From ModdingWiki
Jump to: navigation, search
Compression Infobox
Format typeCompression algorithm
I/O unit sizeUnknown

This template is used to display an information box containing details about a compression algorithm. This is different to a file format, and refers to the actual compression algorithm itself. See LZW Compression for example use.

Valid parameters and examples are:

Parameter/example Condition Purpose Valid values
Type = Stream N/A Compression algorithm type
  • Block - algorithm processes data in blocks (typically more than 8 bytes at a time)
  • Stream - algorithm processes data in a continuous stream of bits or bytes
UnitSize = 1-bit N/A How big are the blocks, or stream operations?
  • 4 kB for an algorithm working on 4kB blocks
  • 1-bit for a stream algorithm reading one bit at a time, e.g. the LZ family
  • 1-byte for an algorithm working at the byte level (no bit-shifting operations)
  • Other sizes as needed
Games = {{Game|GameName}} {{Game|GameName}} N/A Name of all games that use this format Any wiki page name, as a parameter to the Game template

Default values are shown if the parameter is omitted, so do not use any parameters unless the value is known (most of the defaults say "unknown")