About this plugin
ProgPress provides a simple
shortcode for creating
progress meters on your WordPress site. They can be used to track
just about anything where you count up towards a goal: word-count,
fundraising, etc. You can put them in individual posts and pages, or
include them in text widgets.
To insert a meter simply use the [progpress] shortcode:
[progpress title="My Project" goal="100000" current="1234"]
The [progpress] shortcode has the following options:
- Required:
- title: A string containing The title for your meter.
- goal: A number. The one you are working towards.
- current: A number showing how far along you are.
- Optional:
- previous: You can put your previous value of current here
if you want to highlight your most recent progress update. It’s
not visible using the default styling (but it doesn’t hurt
anything).
- label: What it is that you’re counting, like "words" for
example.
- separator: A character or string to display between
current and goal. Defaults to "/".
- class: An extra CSS class to apply to the meter container.
Useful if you track different projects with different styles.
- prefix: A character or string to display before each number
(like ‘$’). Off by default.
ProgPress was designed to be customizable via CSS. I’ve provided
some examples in the Screenshots section.
NaNoWriMo Support
If you are participating in NaNoWriMo, ProgPress can automatically
track your progress. Just enable the additional ProgPress –
NaNoWriMo Support plugin (in addition to ProgPress), and set the
nanowrimo attribute to your NaNoWriMo username (this is a change
from last year where your user id was used).
[progpress title="My NaNoWriMo Progress" nanowrimo="jczorkmid" label="words"]
So as to not overload their servers, the plugin caches your word count
info, so it may not update immediately when you update your word count
org.
Note that as of November 10, 2011 the NaNoWriMo Word Count API is
not yet officially released. At times it seems to return invalid
errors saying your user doesn’t exist, or you don’t have a novel in
progress this year. In my testing this clears itself up after a bit,
and once some data has been loaded WordPress will cache it rather than
continue to display errors if it keeps going up and down.
More Info
- Check out my other WordPress
plugins.
- Check out this excellent ProgPress Setup & Customization
Guide
for some additional CSS examples.
Thanks
Special thanks to Kris Johnson,
K. L. Kerr, Chris
Miller, Debbie Ohi,
and Scott Philips for their feedback and
support.