WordPress.org
Get WordPress

Plugin Directory

Changeset 1988621


Ignore:
Timestamp:
12/08/2018 02:59:15 AM (7 years ago)
Author:
johnalarcon
Message:

Update readme; remove previous instructions and info.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • plugin-stats/trunk/readme.txt

    r1960303 r1988621  
    77Stable tag: 1.1
    88
    9 *This plugin has been dormant for nearly a decade, but ownership has been transferred and it is being reworked and revived.*
     9*After nearly a decade of inactivity, this plugin has been adopted! It is now being redeveloped for release soon!*
    1010
    11 Plugin Stats provides a shortcode, template function, and dashboard widget which graphs the downloads completed for plugins hosted at WordPress.org.
    12 
    13 == Description ==
    14 
    15 Plugin Stats provides a shortcode, template function, and dashboard widget which display graphs of the number of downloads completed for plugins hosted at WordPress.org.  The green bar on the graph shows the standard deviation of the downloads.  Also, today's downloads are shown using a red link crossing the graph.  The graphic is provided using the [Google Charts API](http://code.google.com/apis/chart/).
    16 
    17 == Installation ==
    18 
    19 1. Upload the `plugin-stats` directory to the `/wp-content/plugins/` directory
    20 1. Activate the plugin through the 'Plugins' menu in WordPress
    21 
    22 == Usage ==
    23 
    24 There's no Options/Settings panel for Plugin Stats.  Instead, configuration is done using the template function, shortcode, or dashboard widget and with filters.
    25 
    26 = Template Function =
    27 
    28 Plugin Stats provides a template function to allow you to display a stats graph in your site template.  Actually, it's an action, but it can be used the same way as a normal template function.  Here's a sample usage:
    29 
    30 `<?php do_action('plugin-stats', 'wp-crontrol') ?>`
    31 
    32 This would display a 360x100 graph of the past 180 days of plugin downloads for the plugin `wp-crontrol`.
    33 
    34 `<?php do_action('plugin-stats', 'wp-crontrol', '360x100', true) ?>`
    35 
    36 This displays a 360x100 graph of the past 180 days linked to the plugin stats page on WordPress.org.
    37 
    38 = Shortcode =
    39 
    40 A shortcode is also available for usage in posts and pages.  It has the same options as the template function.  Here are a few self-explanatory examples:
    41 
    42 `[plugin-stats slugname="wp-crontrol" size="360x100" addlink="1"]
    43 [plugin-stats slugname="wp-crontrol" size="100x100" addlink="0"]
    44 [plugin-stats slugname="wp-crontrol"]`
    45 
    46 = Dashboard Widget =
    47 
    48 The dashboard widget allows you to enter a number of plugin slugs and have the graphs for all of them displayed in a widget on your dashboard.
    49 
    50 = General Configuration =
    51 
    52 There are a number of other configuration parameters that can be set using the WordPress filter system.
    53 
    54 **`plugin-stats_build-link`**: Whether or not a new link will be built.  By default, a new link is built each time new stats are available or a new image size is requested.  This has the consequence that if you have two plugin-stats graphs on one page with different parameters (see below), the second one won't be generated.  To fix this, hook onto the `plugin-stats_build-link` filter and return `true` to force a new link.
    55 
    56 **`plugin-stats_num-days`**: This is the number of days that should be included in the graph.  The default *and* upper limit is 180.
    57 
    58 **`plugin-stats_img-link-args`**: An associative array of parameters that will be sent to the [Google Charts API](http://code.google.com/apis/chart/) to generate the graph.  Use this configuration value to change colors or add additional decoration to the graph.
    59 
    60 **`plugin-stats_img-link`**: The finished `img` tag that is returned.
    61 
    62 **`plugin-stats_cache-time`**: The number of seconds to cache the downloaded statistics.  Defaults to 600 (10 minutes).
    63 
    64 == Screenshots ==
    65 
    66 1. The shortcode in action.
    67 1. The template function in action.
    68 1. The dashboard widget in action.
    69 
    70 == Future Plans ==
    71 
    72 * Dunno, any ideas?
    73 
    74 == Version History ==
    75 
    76 = Version 1.1 =
    77 
    78 * Fixed bug where after a linked graph, all graphs would be linked.
    79 
    80 = Version 1.0 =
    81 
    82 * shortcode
    83 * template function
    84 * dashboard widget
    85 
     11*Many thanks to Edward Dale who graciously granted new ownership to make this possible! *
Note: See TracChangeset for help on using the changeset viewer.