 | This is the template sandbox page for Template:Article length bar (diff). |
 | This template is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
 | This template uses TemplateStyles: |
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.
Usage edit
{{Article length bar|ArticleName}}{{Article length bar|ArticleName|mode=vert}}
Parameters edit
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 § Notes.
Styling params edit
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 § Per-user style.
|mode=– set mode tovertto change the bar to a 96 x 28px vertical bar; (default: a horizontal bar, 14 x 64px)|nokb=– set toyesto 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 § Notes ).|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 edit
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 § Notes ). 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: 150000 bytes)|T2=– yellow until this byte length, then red; (default: 225000 bytes)|TMAX=– articles this size fill the bar to 100%; larger values than this do not extend past the right border; (default: 325000 bytes)|L0MAX=– max size of the green area in percent; derivable from T1; see note below; (default: 46 )|L1MAX=– high point of the yellow area in percent; see note; (default: 69 )
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 edit
{{Article length bar|Battle of Kitcheners' Wood}}→{{Article length bar|Second Battle of Ypres}}→{{Article length bar|Assassination of Archduke Franz Ferdinand}}→{{Article length bar|Battle of Jutland}}→{{Article length bar|World War I}}→{{Article length bar|France}}→{{Article length bar|France|style=height:2px;|nokb=y}}→{{Article length bar|France|spark=y}}→{{Article length bar|France|style=height:24px; width:128px; padding:3px 0 0 3px}}→{{Article length bar|2022 in science}}→{{Article length bar|France|mode=vert}}→
Parameters: T1, T2, TMAX
{{Article length bar|France}}→{{Article length bar|France|T1=100000|T2=150000|TMAX=200000}}→{{Article length bar|France|T1=200000|T2=275000|TMAX=425000}}→
Notes edit
The length value retrieved for a given article is the raw size of the wikicode in bytes ({{PAGESIZE}}). Pagesize is easier to compute than prose word count, and can be a rough proxy for relative article size, but should be used with caution.
Sparklines are useful for embedding small graphics in running text. For example, a Talk page discussion about a country article:
...can be seen in the relative sizes of France , Germany , and Italy.
with the bars appearing at the same size as the surrounding text, and remaining proportionate under zooming. Use § param |spark=y to generate a sparkline.
Per-user style edit
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 aab-bar and aab-bar-vert defined on the article length bar graphic by appropriate modification of your Special:MyPage/common.css. (t.b.a. ...)