ProgPress: A Progress Meter Plugin for WordPress

Please use the support forum if you need assistance.

Description

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 shortcode:

The 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.

Installation

Extract the zip file and just drop the contents in the

wp-content/plugins/

directory of your WordPress installation and then
activate the Plugin from Plugins page.

You can configure the options from the settings page.

FAQ

Q. I’m seeing the shortcode source when I try and use it in a text widget.
A. As of this writing WordPress does not support shortcodes in text
widgets. ProgPress has the ability to enable all shortcodes in
text widgets (not just ), but it is turned off by
default. It can be enabled on the ProgPress settings page.

The code is based on a proposed patch to WordPress core. Hopefully
this feature is added to WordPress itself at some later date. I’ve
tried to code defensively so if the feature is added to WordPress in
the future, having it enabled in the plugin should not have any negative
side effects.

Q. What are the default styles? What does the markup look like?
A. Please check out the Examples section on the settings page. It
will generate markup and display the default styles for the currently
installed version of ProgPress when you click “Load Examples”. I’ve
done this rather than put a static copy here that I might forget to
update in future.

Q. What’s all this about shortcodes? I’ve been using ProgPress in a different way for ages!
A. Since ProgPress pre-dates shortcodes being added to WordPress it
originally used an older syntax based on HTML comments. This syntax is
still supported (although newer features like label have not been
back-ported). It can be enabled on the ProgPress settings page.

You add a progress meter by including the following in a post or in a
text widget:

<!--progpress|title|goal|current|previous|label-->

Only these five options are supported, only the first three are
required.

Q. Besides shortcodes and HTML comments, is there any other way I can use ProgPress to generate meters?
A. Sure. You can call the jcp_progpress_generate_meter function
directly.

<?php if (function_exists('jcp_progpress_generate_meter')){  
       echo jcp_progpress_generate_meter("title", 100, 50, 25, "label");
}?>

The arguments to the function are:

title

, goal, current, previous, label, separator, class,
and prefix (in that order).

Q. How will the meter show up in my RSS feeds?
A. Inline styles (based on the default styles) are used to ensure the
meters render in RSS readers.

Screenshots

  1. progpress screenshot 1

    This meter was generated using the default styles.

    defaults
    73,023/180,000 words
    <pre><code>2. Make the meter blue and remove padding.</code></pre>div.jcp_pp_meter {
    padding: 0;
    }
    div.jcp_pp_prog {
    background-color: #22a;
    }
    div.jcp_pp_new {
    background-color: #22f;
    }

    `

    48,000/50,000

  2. progpress screenshot 2

    Image Based

    div.jcp_pp_meter {
    padding: 0;
    height: 33px;
    background-image: url(pp_bg_remain.jpg);
    }
    div.jcp_pp_prog,div.jcp_pp_new {
    background-image:url(pp_bg_current.jpg);
    }

    Test Also
    350/500 pages

Other Notes

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 Error:NaNoWriMo Wodcount API Error (username="jczorkmid") user does not exist

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
at nanowrimo.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

Thanks

Special thanks to Kris Johnson,
K. L. Kerr, Chris
Miller
, Debbie Ohi,
and Scott Philips for their feedback and
support.

Changelog

1.2.1

  • Fixed caching timeout (whoops)

1.2

  • Updated the ProgPress – NaNoWriMo Support plugin for 2011
  • Pretty printing of numbers now handled via number_format_i18n for better
    international support.
  • Admin JavaScript should only load on the ProgPress admin page.

1.1

  • Added the ProgPress – NaNoWriMo Support plugin
  • Added jcp_progpress_shortcode_atts filter
  • Added phpdoc

1.0

  • Added the shortcode.
  • Pretty print large numbers (inserting commas, etc).
  • Added class, prefix, and separator options
  • Added option to enable shortcodes in text widgets.
  • Rewrote the README (hopefully it’s more helpful now).
  • Added some extra tags to the markup to make it easier to style
    individual sections.

0.8.6

  • fixed bug with width calculation
  • provide production and development versions of javascript and css

0.8.5

  • Migrated to new WordPress admin API.
  • Moved default styles to external style sheet.
  • Added ability to view default style sheet to settings page.
  • Added a bit more content to the README.

0.8.2

  • Use inline styles in RSS feeds.
  • Changed filter priorities to deal with WordPress changes.

0.8.1

  • Added title attributes to meter sections.
  • Better path determination logic.

0.8

  • Removed try/catch in place of PHP version detection.
  • Updated styles

0.1

  • initial release

54 Comments

  1. [...] thanks to Jason Penney’s wonderful plugin, ProgPress for providing the [...]

  2. Debbie Ohi says:

    Love your plugin, Jason! I tried making a Paypal donation via your WordPress plugin page, but got an error message. :-(

  3. Jason Penney says:

    @Debbie Ohi – Yikes! Thanks so much for pointing that out. Not sure why that stopped working, but it should be all set now.

  4. Lia Keyes says:

    Any chance you could do one for blogger? I love what you’ve done here!

  5. [...] directly, but are seeing it some other way, I’m testing an update to my ProgPress plug-in that should make the progress meter show up at the top of this post. I know it works in Google [...]

  6. Kristen says:

    Hi Jason,
    I tried to activate the plugin and got an error message in WordPress:

    “Plugin could not be activated because it triggered a fatal error.

    Parse error: syntax error, unexpected ‘{‘ in wp-content/plugins/progpress/wp-progpress.php on line 114 ”

    I’m running WordPress v2.8. Is this error due to a problem with one of the settings on my server?

    Thanks in advance for your help!

  7. Jason Penney says:

    @Lia Keyes – I wish I could, but I’d have no idea where to begin.

    @Kristen – Is your hosting provider running php4? I’m not sure I ever tested ProgPress on php4, but looking at it now I think it might not work. I think I need to make a few other adjustments for WP 2.8.1+, so I’ll see what I can do about fixing your issue at the same time.

  8. Kristen says:

    Hi Jason,
    In the server specs, it says my host is running PHP 4.4.9. It also said “You can enable PHP 5.2.5 as CGI binary using FastCGI”. I tried enabling PHP 5.2.5 and was able to activate the ProgPress plugin but unfortunately the switch caused other problems, like not even being able to login to WordPress at all through Firefox and not being able to perform some of the other functions in WordPress through IE 7 either. So it looks like the problem is due to the PHP version my host is running.

  9. [...] updated my ProgPress Plug-in. This version should (hopefully) solve the issue with php4 that recently came to light. It [...]

  10. Jason Penney says:

    @Kristen – Please try the newest version. It should clear up the issue.

  11. Luke says:

    Hello!

    Where do I edit the css for the plugin? I want to do some custom css, but when I added the css lines above to my theme style sheet, the progress meter didn’t change at all?

    Thanks!

    Luke

  12. [...] ProgPress is an awesome tool for us you like to see our progress in visual detail.  Nicely done Jason Penny.  So, ignore the post below with the other Progmeter in it…that will be the last [...]

  13. Hello, sailor! I love what you’ve done here — it’s the most straightforward and easy-to-use progress bar plugin for WP out there. I even hacked it a bit to display percents the way that I like (number %, instead of 5/100 %). It wasn’t anything difficult, but I can send you the code if you like.

  14. Kassie says:

    i cannot get the actual bar to show in my sidebar.. i don’t really get how to activate it to appear.. what am i not doing?

  15. Shane says:

    This is the second fundraiser meter I have tried to install into my sidebar. I even used the PHP Sidebar widget instead of the standard HTML one to insert the code. My stats are showing up in plain text with no progress bar. Please help.
    http://www.stpatrickschurchrestorationfund.com

    Thanks,

    Shane

  16. Shane says:

    I seem to get it to work. Anyway to add in coma’s and $ signs in the numbers? I think it would look better to have $45,000 as oppose to 45000. Pretty cool plugin.. thanks!

  17. [...] writing, but unfortunately I couldn’t find a widget that would do the trick. I tried ProgPress because it allows tracking of multiple projects in a single widget, but the progress bar appeared [...]

  18. Cindi says:

    This looks like a great plugin – we’re going to use it for quilt progress on our blog! Just two questions – 1. Is there a way to add a picture of what we’re making progress on? 2. How do you change the color of the bar?

  19. Cindi says:

    My apologies – I figured out how to get the picture in. Now just need to know how to change the color! Thanks so much – it looks great!!

  20. Cindi says:

    See what happens when you leave me alone to experiment? Figured out how to change the color. Now the only thing we’d like to do is delete the “50/100% complete” line and just leave the meter. It’s the only thing I can’t figure out.

    This is GREAT!!!! I’ve had to tweak it just a little but it’s going to work perfectly. There is nothing out there that allows us to monitor our craft. Thanks for developing this!

  21. Angie says:

    Hey there, I just wanted to thank you for your plugin. I’ve modified it for use in a buddypress site I have going. I’m trying to figure out how to do a last bit of ui tweaking on the bp side of things, but I just wanted to say thanks for putting out such a great straight forward bit of code!

  22. Raffi says:

    The “excellent write up” is gone. Do you know a site where this is in action? There is a comment here from Dark Rogue and there is a progress bar in his left sidebar. Is that it? Can it run vertically or only horizontally?
    Thanks

  23. Penrefe says:

    Hello! Absolutely love this little gem. I also noticed there’s no guide for setting it up, so I wrote on, hope it helps!

    • Jason Penney says:

      Very nice! I used to have a similar page on this site, and I’ve been meaning to recreate it as part of the README.

      Glad you figured it out.

  24. [...] into WordPress to show writers the fruits of their labours in the form of a progress meter, called ProgPress. There was just one problem; the tutorial for setting it up wasn’t available [...]

  25. Tudorminator says:

    Thank you for your great work. I like it even more after you have added the shortcode option and the separator parameter. I use it to display reading progress on my blog, so now it’s a breeze to have it display something like ”X pagini din Y” (X pages out of Y).

    I do have a small suggestion which would benefit all of us non-native english speakers: please make the text localizable through gettext, so that I can change the $goal_label tooltip (I use the Codestyling Localization plugin) without modifying it in the plugin code after each update.

    Thank you.

  26. Tudorminator says:

    Sorry about double posting, one more thing: I think that $goal_label tooltip would be more useful if it would display the difference between goal and current values.

    Thank you again for a great plugin.

  27. [...] recently updated ProgPress, my progress meter plugin for WordPress, based on some outstanding requests for functionality and [...]

  28. [...] wordpress, just look up the plugin named ‘progpress’, install it and then check out this site for how to use it. (It’s simple.) [...]

  29. Edwin says:

    How do you set up different classes so that you can track different projects, as you have suggested in the text file. Thanks. I am a newbie, and need a push in the right direction.

    So far I have taken the css style, modified it to suit my website, and ploncked it into my style.css, while disabling your default style in the plugin options.

    Its great for now. But I would like to learn how to create different CLASS styles so I can portray mutiple different Progress bars on 1 website. Big thanks.

    Edwin

    • Jason Penney says:

      Sorry for the delay in response. Let’s say you wanted to make your meters blue for a certain project.

      In your post/sidebar/whatever: [progpress class="project_foo" ... ]

      Then in your style sheet:

      div.project_foo .jcp_pp_meter div {
          background-color: #00f;
      }
  30. [...] 2011-03-22: Moved onto a different progress bar plugin called ProgPress which is more static and so, overcomes the problems/concerns I had [...]

  31. Angel says:

    I really like this plugin, however I was wondering if there was anyway you could modify it to work for those trying to lose weight? Please let me know if this is possible. Thanks!

  32. Isak Krab Koed says:

    Dear Jason

    Thank you so much for this brilliant plugin. There’s just one thing I’m wondering: how can I change the , to a . in the numbers, for example:

    From 10,000 to 10.000?

    If I write 10000 in the shortcode, it shows up as 10,000 – which is not the way it should look in my country. If I write 10.000 in the shortcode, it shows up as just 10, which is not the right number :P

    Can you help?

    Kind regards
    Isak

  33. [...] up your own and your progress bar and you’re using WordPress you can get the plugin I use at http://jasonpenney.net/wordpress-plugins/progpress/.  There are other options which work on all platforms such as [...]

  34. Tudorminator says:

    Hi Jason,

    Thanks again for your great work. I have taken the liberty to add the feature I was requesting a while ago, and I want to share my modifications with everybody. I would really love it if you could integrate this in a future version, no strings attached (I don’t even want you to mention my name or anything, do as you please).

    So, in order to make the “Goal: ” label translatable through gettext() (and the Codestyling Localisation plugin), one needs to edit the wp-progpress.php file (plugin version 1.2.1) in 2 places:

    – on line 113, change this:

    $goal_label = "Goal: " . $goal;

    to this:

    $goal_label = __("Goal: ", 'progpress') . $goal;

    – then add the following lines after line 426, inside the function jcp_progpress_init():

    if ( !defined('WP_PLUGIN_DIR') ) {
    load_plugin_textdomain('progpress', str_replace( ABSPATH, '', dirname(__FILE__)));
    } else {
    load_plugin_textdomain('progpress', false, dirname(plugin_basename(__FILE__)));
    }

    That’s all. After these modifications, ProgPress appears in the Codestyling Localisation’s list of translatable plugins and everything works smoothly. Note that I haven’t touched the strings that appear in the config page of the plugin, but the modifications are fairly similar and should be easy to implement.

    Best regards,
    (T)

  35. [...] much research (and being too lazy to code it myself), the ProgPress plugin by Jason Penney, is the easiest and most flexible to [...]

  36. Trevor says:

    So from what I understand, you can’t change the color of the bar when it’s used in a widget.. correct? I’m wanting to have multiple bars in a widget each with a different colour based on how far along their progress is. Is it possible?

    • Jason Penney says:

      You can have different colored bars. It’s controlled by your style sheet. Use the ‘class’ parameter to differentiate them.

      [progpress class="green_meter" ...]

      Then in your style sheet:

      .green_meter .jcp_pp_meter div {background-color: #0f0;}

  37. [...] up your own and your progress bar and you’re using WordPress you can get the plugin I use at http://jasonpenney.net/wordpress-plugins/progpress/.  There are other options which work on all platforms such as [...]

  38. Jason,
    I’m tracking progress for fundraising for 3 phases of a playground for my kid’s school. I’d like to display 3 meters in three different colors – same background color, different progress color. If I use the info above, I think I would use the following in the widget:

    [progpress class="project_Phase1" title="Phase 1: Playground" prefix="$" goal="80000" current="3000"]
    [progpress class="project_Phase2" title="Phase 2: Field" prefix="$" goal="400000" current="0"]
    [progpress class="project_Phase3" title="Phase 3: Kickball/Softball Field" prefix="$" goal="100000" current="0"]

    And this in the CSS:
    div.project_Phase1 .jcp_pp_meter div {background-color: #00f;}
    div.project_Phase2 .jcp_pp_meter div {background-color: #00f;}
    div.project_Phase3 .jcp_pp_meter div {background-color: #00f;}

    I need to determine colors (where do you find these codes?), but am I on track?

    Thanks!

    • Jason Penney says:

      Hi Dale. You’re on the right track! You need to use RGB color values, and add the entries to your sites style sheet. Let me know if I can help.

      • Dale says:

        Jason,
        Thanks for your help! Ok, I have the colors loaded. Is there a control that lets me change the border of the meter?

        Thanks,
        Dale

        • Jason Penney says:

          Sure, there are a lot of options as to what you can do with the border. The default is controlled by:

          div.jcp_pp_meter { border:1px solid #000; }

          That’s 1 pixel wide, solid, black. You can play with any of the border properties.

          The empty space between the border and the bar is controlled by:

          div.jcp_pp_meter { padding:2px}

          Which is 2 pixels of empty space between the meter and the border. You can set it to ’0′ to get rid of that space.

  39. [...] have recently installed the Progpress plugin to to track my writing progress and demonstrate how lazy I really [...]

  40. […] ProgPress: Progress bars for tracking your progress. I use it for my challenges. […]

Leave a Reply

U Comment/I Follow

XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>