Template:Binpre/doc

Purpose
binpre provides a swift and uniform method to add a disambiguating footnote where the prefixes K, M, G, T are used to refer to multiples of a power of 1024, instead of the common 1000.

Usage

 * creates the named footnote for the first use on a page. A References section should already exist.
 * creates a reference to the already created footnote

For a single usage in a section,  should directly follow the unit to be disambiguated, e.g.  . When multiple such units are used in a sentence or short section,   should be put after the end of the sentence or section.

Parameters
binpre takes a single, optional parameter, first, indicating the first use on a page, creating the named footnote binpre. Additional uses without a parameter refer to that already created, named footnote.

Usage advice
Do not use this multiple times in the same article without good reason. If the article's choice of prefix is uniformly binary, there is no need to repeat the template throughout. If the article constantly switches between decimal and binary prefixes, first consider rewriting the article. If that cannot be done, please do not rely solely on templates such as this one - instead make it immediately apparent to the reader which prefix is meant. An article where the reader constantly must double-check whether each instance of "kB" or "MB" refers to the binary or the decimal should probably be considered a poorly written article.