साँचा:Progress bar/doc

यह प्रलेखन उपपृष्ठ साँचा:Progress bar के लिए है।
इसमें उपयोग विधि की जानकारी, श्रेणियाँ और वह वस्तुएँ हैं जो कि असली साँचा के पृष्ठ पर नही हैं।

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Usage

{{Progress bar|value}}

This template draws a progress bar. By default, the value to supply as the parameter is the percent, from 0 to 100 (e.g. 1 would mean 1%, .1 would be 0.1%). If a value isn't specified or is invalid, the bar displays 0%. Values greater than 100% will display incorrectly, although the text label will be correct.

Optional parameters

height = height of the progress bar in pixels; defaults to 2
width = width of the progress bar; defaults to 75%
text = message to display after %; defaults to: completed (estimate)
total = amount to use as the denominator (instead of 100), allows the template to compute the percentage on the fly
header = no (or any value other than "yes", which is the default) suppresses the display of the percentage on the top line
color1 = the colour of the filled portion of the progress bar
color2 = the colour of the background of the progress bar
decimal = the number of decimal places to round to; defaults to 1

Examples

Default configuration

{{Progress bar|5}} :

5% completed (estimate)

With custom header text

{{Progress bar|5|text=done}} :

5% done

Without header text

{{Progress bar|80|header=no|text=does not display here}} :

Custom height and width

{{Progress bar|80|height=4|width=50%}} :

80% completed (estimate)

Custom total

{{Progress bar|5|total=5}} :

100% completed (estimate)

साँचा:Progress templates