Template:hcount

From Homestar Runner Wiki

(Difference between revisions)
Jump to: navigation, search
(add second parameter to count by values other than 1)
(document second parameter and countby)
 
Line 4: Line 4:
'''Usage:'''
'''Usage:'''
:<code><nowiki>{{ </nowiki> hcount | ''countername'' }}</code>
:<code><nowiki>{{ </nowiki> hcount | ''countername'' }}</code>
-
where ''countername'' is the name of the counter being used. '''''This parameter is required.'''''  Place this template at the beginning of each cell of a given column.   
+
where ''countername'' is the name of the counter being used. '''''This parameter is required.'''''  Place this template at the beginning of each cell of a given column.  You can specify custom increment values for the counter (''note that brackets denote optional parameters''):
 +
 
 +
:<code><nowiki>{{ </nowiki> hcount | ''countername'' [ | ''increment'' ] }}</code>
'''IMPORTANT:'''  
'''IMPORTANT:'''  
Line 12: Line 14:
This ensures that the table is sorted correctly (in proper numerical order). You may also reset up to '''6''' counters with the {{tl|hresetcount}} template. (''Note that brackets denote optional parameters''):
This ensures that the table is sorted correctly (in proper numerical order). You may also reset up to '''6''' counters with the {{tl|hresetcount}} template. (''Note that brackets denote optional parameters''):
:<code><nowiki>{{</nowiki>[[Template:hresetcount|hresetcount]] | ''countername1'' [ |''countername2'' ] [ | ''countername3'' ] [ |''countername4'' ] [ |''countername5'' ] [ |''countername6'' ] }}</code>
:<code><nowiki>{{</nowiki>[[Template:hresetcount|hresetcount]] | ''countername1'' [ |''countername2'' ] [ | ''countername3'' ] [ |''countername4'' ] [ |''countername5'' ] [ |''countername6'' ] }}</code>
-
Optionally, you may set the initial value to something other than the default value of 10,000. (''However, this is not recommended and in most cases, unnecessary''):  
+
Optionally, you can set the hidden counter value to something other than the default value of 10,000 and count by something other than the default value of 1. (''It is recommended to use a value with all nines if counting by a negative value.'') :  
-
:<code><nowiki>{{</nowiki>[[Template:hresetcount|hresetcount]] | ''countername''  | v=100000 }}</code>
+
:<code><nowiki>{{</nowiki>[[Template:hresetcount|hresetcount]] | ''countername''  | v=9999 | countby=-1 }}</code>
-
This resets the counter to a value of 100,000.
+
This resets the hidden counter to a value of 9,999 (once the proper increment of -1 is applied when calling the counter).
'''Technical Information:'''
'''Technical Information:'''

Current revision as of 16:52, 4 February 2021

1 This template is for adding a hidden count meant for use in a sortable table.

Usage:

{{ hcount | countername }}

where countername is the name of the counter being used. This parameter is required. Place this template at the beginning of each cell of a given column. You can specify custom increment values for the counter (note that brackets denote optional parameters):

{{ hcount | countername [ | increment ] }}

IMPORTANT:

Please be sure to first reset the counter before making any calls to this template in order to a sufficiently high enough by using the {{hresetcount}} template:

{{hresetcount | countername}}

This ensures that the table is sorted correctly (in proper numerical order). You may also reset up to 6 counters with the {{hresetcount}} template. (Note that brackets denote optional parameters):

{{hresetcount | countername1 [ |countername2 ] [ | countername3 ] [ |countername4 ] [ |countername5 ] [ |countername6 ] }}

Optionally, you can set the hidden counter value to something other than the default value of 10,000 and count by something other than the default value of 1. (It is recommended to use a value with all nines if counting by a negative value.) :

{{hresetcount | countername | v=9999 | countby=-1 }}

This resets the hidden counter to a value of 9,999 (once the proper increment of -1 is applied when calling the counter).

Technical Information:

  • The counter in hcount is separate from that of vcount. The vcount template appends "_visible" to the counter name specified in the first parameter.

[edit] See Also

Personal tools