Template:Article length bar/doc

Generates a configurable, progress bar-style graphic that may be used to visually display the length of a given article relative to a theoretical maximum. The bar changes color when certain thresholds of appropriate or excessive article size are exceeded.

Parameters
There is one required parameter, four styling params, and five configuration params:
 * 1 – name of the article; required. This is used to derive the article length; see.

Styling params
All styling parameters are optional. Using them changes the appearance for all users viewing the page where the template appears. To alter the appearance only for yourself, see.


 * mode – set mode to to change the bar to a 96 x 28px vertical bar; (default: a horizontal bar, 14 x 64px)
 * nokb – set to to suppress display of the rounded kilobyte size in the length bar. This also suppresses the tooltip.
 * spark – set to a non-empty value to generate an inline, sparkline-ish bar in running text. (See ).
 * style – you may add any CSS parameters applicable to an HTML inline element to alter the appearance of the length bar, such as size, width, border, etc.

Configuration params
All configuration params are optional. Configuration params alter predefined constants which govern color transition points within the length bar. By default, these are designed to reflect the length of articles that "probably" or "definitely" should be split (see ). Altering these values changes the point where color transitions begin in the length bar.
 * T1 – green up to this byte length, then switches to yellow; (default: bytes)
 * T2 – yellow until this byte length, then red; (default: bytes)
 * TMAX – articles this size fill the bar to 100%; larger values than this do not extend past the right border; (default: bytes)
 * L0MAX – max size of the green area in percent; derivable from T1; see note below;  (default: )
 * L1MAX – high point of the yellow area in percent; see note; (default: )

Normally, there is no reason to change these from the default values, and the recommendation is not to use them. One reason to do so might be to compare articles within a skewed sample set, such as comparing a set of stub articles, or comparing a set of articles appearing near the top of the longest articles list.

Note: L0MAX and L1MAX are derivable as a raw byte size converted to a percent, and thus locked to the values of T1 and T2, respectively. If you change either T1 or T2, please also change the former to match:
 * L0MAX is derived as: (T1 * 100 / TMAX), round to 0 decimal places
 * L1MAX is derived as: (T2 * 100 / TMAX) round 0

Examples


Parameters: T1, T2, TMAX

Per-user style
You can modify the appearance of the bar for yourself only without affecting anyone else, or make the bar disappear completely through the use of predefined CSS classes and  defined on the article length bar graphic by appropriate modification of your Special:MyPage/common.css. (t.b.a. ...)