Template:Prioritisation/doc
This is a documentation subpage for Template:Prioritisation. It contains usage information, categories and other content or metadata that is not part of the original template. |
Usage
Static slide bars. To indicate priorities, but also units of measure like length, temperature etc... Has multi-language support automatically from the calling page.
Each bar has 5 point markers on the unit bar, thus 4 sections which can be configured in width and colours. The slider changes colour according it's position in 5 different colours, matching the configurable colour range of the bar.
Example
A slide bar with red palette, including a label and unit bar.
Red slidebar with slider at 75%. Defined units.
→ {{Prioritisation|label=yes|type=WorkgrouptestPriority|width=3|unitbar=yes|lcolor=red|mcolor=red|hcolor=red|position=0.75|unit1=Low|unit2=|unit3=Medium|unit4=|unit5=High}}
Green red slidebar for temperature with slider at 30%. Defined units and scaled to 75%.
→ {{Prioritisation|label=yes|type=Temperature|width=5|vscale=0.75|unitbar=yes|lcolor=green|mcolor=green|hcolor=red|position=0.3|unit1=0°C|unit2=10°C|unit3=20°C|unit4=30°C|unit5=40°C}}
Bare blue slidebar with slider at 100%.
→ {{Prioritisation|label=yes|type=Workgroup {{Prioritisation|label=|width=3|unitbar=|lcolor=blue|mcolor=blue|hcolor=blue|position=1|unit1=|unit2=|unit3=|unit4=|unit5=}}
Templatedata
Creates a static but highly configurable slide bar.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Label displayed ? | label | Label for the slide bar. Describes what the slide bar represents. May be any formatted text and include images.
| Boolean | optional |
Type of data in the bar | type | Describes the type of data in the bar. Currently implemented types (multi-lingual) are: Priority, Temperature, Length, Height, Distance.
| String | suggested |
Width of a bar section | width | Width of a bar section. Use this parameter to adjust the with of the bar, f.i. to accommodate wide unit descriptions.
| Number | suggested |
Scale | vscale | Scaling of the whole bar. To scale down use fractions, to scale up number above 1.
| Number | suggested |
Display unit bar divisions | unitbar | Displays the unit bar markers (always 5) under the slide bar
| Boolean | optional |
Low range colour palette | lcolor | Selection of one of the 3 predefined colour palettes for the lower range. Pre-defined colour palettes include: red, green and blue.
| String | optional |
Medium range colour palette | mcolor | Selection of one of the 3 predefined colour palettes for the medium range.Pre-defined colour palettes include: red, green and blue
| String | optional |
High range colour palette | hcolor | Selection of one of the 3 predefined colour palettes for the high range.Pre-defined colour palettes include: red, green and blue
| String | optional |
Position of the slider | position | Fraction to fix the position of the slider: 0 < x < 1. Slider will adopt colour from the nderlying slide bar configured colour.
| Number | suggested |
Label for the first unit marker | unit1 | Use this parameter to define a a label (with units of measurement) for the first marker on the unit bar. To display no text enter a space.
| String | optional |
Label for the second unit marker | unit2 | Use this parameter to define a a label (with units of measurement) for the second marker on the unit bar. To display no text enter a space.
| String | optional |
Label for the third unit marker | unit3 | Use this parameter to define a a label (with units of measurement) for the third marker on the unit bar. To display no text enter a space.
| String | optional |
Label for the fourth unit marker | unit4 | Use this parameter to define a a label (with units of measurement) for the fourth marker on the unit bar. To display no text enter a space ' '.
| String | optional |
Label for the fifth unit marker | unit5 | Use this parameter to define a a label (with units of measurement) for the fifth marker on the unit bar. To display no text enter a space.
| String | optional |