rvm_counter

This plugin provides the following tag(s):

• <txp:rvm_counter />

<txp:rvm_counter />

Returns a number that is incremented each time this tag is called. Counter values are stored in the txp_discuss_nonce table without conflicting with comment nonces.

Attributes

• name="text"
  Explicit name (max 20 chars) for this counter to differentiate it from another counter. Default is an empty string.
• offset="integer"
  Positive or negative offset for the counter. This is added to the actual counter value before returning it. Default is 0.
• reset="integer"
  Reset the counter to the specified value upon the next call of this counter tag. In most cases using the ‘offset’ attribute is easier.
• step="integer"
  Positive or negative counter step size. Default is set to ‘1’, meaning the counter is increased by 1 each time it is called.
• width="integer"
  Minimum width of the counter when displayed. Small counter values are zero-padded (left side) to reach the specified minimum width. Default is unset.

Examples

Default, nameless counter:

<txp:rvm_counter />

A counter named ‘example’:

<txp:rvm_counter name="example" />

Reset the ‘example’ counter to 10. Note that you have to remove the reset attribute after the counter is reset:

<txp:rvm_counter name="example" reset="10" />

Use an offset of -10. Suppose the counter is currently at 25, then it would display 15:

<txp:rvm_counter offset="-10" />

Add left side zero-padding to make the counter value 5 digits wide. If the counter is set to 25, this would display 00025:

<txp:rvm_counter width="5" />

Display the current counter value, without changing it:

<txp:rvm_counter step="0" />