Template:Progress meter/doc

Usage

Required parameters:

• current/1=: The current progress to the goal. Note that goal defaults to 100 if not specified. Usage: {{Progress meter|<current value>}} or {{Progress meter|current=<current value>}}

Optional parameters:

• goal=: The goal. Defaults to 100 if not specified.
• height=: The height of the progress part of the bar, defaults to 50 if unspecified. Make sure to not specify unit: height=60(correct) (vs.) height=60px(incorrect). CANNOT USE PERCENTAGE AS UNIT. It's been tried, and it will not work.
• width=: The width of the progress part of the bar, defaults to 1000px if unspecified. Can either be in px or %.
• comment1=: Comment that appears above the bar.
• comment2=: Comment that appears below the bar.
• grad=: If yes, then it will display graduations.
  • grads=: Number of graduations to display, defaults to 9.
  • gradwidth=: Width of graduation marks, defaults to 10 unless specified. As described above and below, only use number, not number and unit. Note that grad width may have to be decreased in order to fit the bar size without obscuring the bar.
  • gradcolor=: The color of the graduations. Defaults to black, rules as described below for input regarding color apply.
• display=: If yes, then it will display the current number on the progress bar, and the goal on the thermometer. Defaults to the right side.
  • align=: Right, left, or center. Note that this is only for the progress bar. The goal number will always be displayed on the right.
  • fontcolor1=: Font color for current amount. Rules for coloring applies as seen for other parameters.
  • fontcolor2=: Font color for goal amount. Same rules as above apply.
• moz=: If yes, then the corners of the bar will be rounded. Default size is 110px, for altering this size, see below.
  • mozsize=: Size of rounded corners. Defaults to 110px unless specified. Make sure that you enter in just the number, not the number and unit: mozsize=<number>(correct) (vs.) mozsize=<number>px(incorrect).
• background1=: Background color for entire bar, defaults to transparent. If using a color other than color names (e.g., blue/red), then make sure you type out the full hash (e.g., #ffffff, versus ffffff)
• background2=: Background for the 'progress' part of the bar, defaults to #2222EE. Same rules apply as said above.
• bordercolor=: Border color for the entire bar. Note that this is not for the 'progress' part of the bar. Defaults to blue.
• percent=: Percentage bar is complete. Will appear if 'yes'. Anything else and it will not.
  • percentdec=': Decimal places percentage goes past decimal. Optional, default is 0.
  • percentpref=' : Prefix of percentage note. Can be anything. If not supplied, percentage by default is between ()s.

Examples

{{Progress meter|current=52|moz=yes|grad=yes|display=yes|comment1=comment 1|comment2=comment 2|width=100%}}

Gets:

comment 1  

100

52

comment 2

{{Progress meter|current=52|moz=yes|grad=yes|display=yes|comment1=comment 1|comment2=comment 2|width=50%}}

Gets:

comment 1  

100

52

comment 2

{{Progress meter|current=10|moz=yes|grad=yes|display=yes|comment1=comment 1|comment2=comment 2|width=100%}}

Gets:

comment 1  

100

10

comment 2

{{Progress meter|current=10|moz=yes|grad=yes|display=yes|comment1=comment 1|comment2=comment 2|width=50%}}

Gets:

comment 1  

100

10

comment 2