Difference between revisions of "User:Wolfman 123/Sandbox/Progress bar/doc"

From Feed The Beast Wiki
Jump to: navigation, search
(Doc for test template)
 
m
 
Line 4: Line 4:
 
<nowiki>{{</nowiki>Progress bar|<value><nowiki>}}</nowiki>
 
<nowiki>{{</nowiki>Progress bar|<value><nowiki>}}</nowiki>
   
This template draws a progress bar. The <tt>value</tt> to supply as the parameter is the percent, from 0 to 0.01 or 0.99 to 1 or 1.01 to 99.99 or 100. 14 would mean 14%, .14 would be 0.14%. If you don't specify a value, it returns 0%.
+
This template draws a progress bar. The <code>value</code> to supply as the parameter is the percent, from 0 to 0.01 or 0.99 to 1 or 1.01 to 99.99 or 100. 14 would mean 14%, .14 would be 0.14%. If you don't specify a value, it returns 0%.
   
 
=== Optional parameters ===
 
=== Optional parameters ===
*<tt>height</tt> =
+
*<code>height</code> =
*<tt>width</tt> = defaults to 75%
+
*<code>width</code> = defaults to 75%
*<tt>text</tt> = message to display after %; defaults to: completed <small>(estimate)</small>
+
*<code>text</code> = message to display after %; defaults to: completed <small>(estimate)</small>
*<tt>total</tt> = amount to use as the denominator (instead of 100), allows the template to compute the percentage on the fly
+
*<code>total</code> = amount to use as the denominator (instead of 100), allows the template to compute the percentage on the fly
*<tt>header</tt> = no (or any value other than "yes", which is the default) suppresses the display of the percentage on the top line
+
*<code>header</code> = no (or any value other than "yes", which is the default) suppresses the display of the percentage on the top line
   
 
<includeonly>
 
<includeonly>

Latest revision as of 16:46, 26 November 2018

Template-info.png Documentation

Usage

{{Progress bar|<value>}}

This template draws a progress bar. The value to supply as the parameter is the percent, from 0 to 0.01 or 0.99 to 1 or 1.01 to 99.99 or 100. 14 would mean 14%, .14 would be 0.14%. If you don't specify a value, it returns 0%.

Optional parameters

  • height =
  • width = 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


This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.