| 557c3817 |
1 | === danixland-wporg-stats === |
| 2 | Contributors: danixland |
| 3 | Donate link: http://danix.xyz |
| 4 | Tags: widget, sidebar, links, plugins, list |
| 5 | Requires at least: 4.6 |
| 85e69c8e |
6 | Tested up to: 4.9.7 |
| 9893170c |
7 | Stable tag: 0.1 |
| 557c3817 |
8 | |
| 9 | This widget will display a list of plugins by the same author hosted on the WordPress.org plugins directory. |
| 10 | |
| 11 | == Description == |
| 12 | |
| 9893170c |
13 | danixland-wporg.stats is a plugin that adds a new widget to be used on the Sidebar (or wherever you like) and some useful shortcodes. |
| 85e69c8e |
14 | This widget will show a list of plugins by the same author, hosted on the WordPress Plugins directory. It uses the wordpress.org API to fetch all the details and it's able to show links to the plugin page on wordpress.org or to the URI specified by the author inside the plugin itself. Other stats displayed by the plugin are the total number of downloads for all the plugins, average rating per plugin and total average. Soon the plugin will be able to display even more stats. |
| 557c3817 |
15 | If an author has used the assets directory to store the plugin's icons, danixland-wporg-stats is able to fetch and display the icons as well. |
| 9893170c |
16 | The plugin ships with a few shortcodes to embed your stats inside your posts or pages. You can use it on a landing page for your plugins or, like I do, inside a custom post type page to display stats about the plugins I write. |
| 557c3817 |
17 | |
| 18 | |
| 19 | == Installation == |
| 20 | |
| 21 | Installing danixland-wporg.stats is straightforward and requires just a few seconds: |
| 22 | |
| 23 | If you use the **"Add New Plugin"** pane from your dashboard just install it and activate it, then proceed to the last step and configure it. |
| 24 | Otherwise follow these steps: |
| 25 | |
| 26 | 1. Download the latest version of the plugin. |
| 27 | 1. If using the "Install Plugins->Upload" section on the WordPress admin area just upload the zip file, otherwise unpack the zip file and upload the **"danixland-wporg-stats"** directory inside the "wp-content/plugins" directory of your WordPress installation using your favourite ftp client. |
| 28 | 1. Activate the plugin through the 'Plugins' menu in WordPress. |
| 29 | 1. Add the widget to your sidebar from Appearance->Widgets. |
| 30 | 1. Configure the widget options through the panel which can be accessed from the Appearance->Widgets page. |
| 31 | |
| 32 | == Frequently Asked Questions == |
| 33 | |
| 34 | = What can I do to customize even more the appearance of the widget? = |
| 35 | |
| 36 | The code generated by the plugin is wrapped in an HTML element with class `widget_danixland-wporg-stats`, what kind of element is decided by your theme, if unsure ask his creator. Inside this element you'll find the content of the widget wrapped inside a div with class `dnxwporg-container`. |
| 37 | Contained in that element you'll find a div with the description and following there's a list of links for the plugins. |
| 38 | |
| 39 | Here's every single id and class used in this plugin: |
| 40 | |
| 41 | * `.widget_danixland-wporg-stats` |
| 9893170c |
42 | * `.dnxwporg_container` |
| 43 | * `.dnxwporg_description` |
| 44 | * `.dnxwporg-pl-standard-desc` |
| 45 | * `.dnxwporg-pl-custom-desc` |
| 46 | * `.dnxwporg_pl_list_container` |
| 47 | * `.dnxwporg_pl_list` |
| 48 | * `.dnxwporg_pl_item` |
| 49 | * `.dnxwporg-pl-link` |
| 50 | * `.dnxwporg-pl-link-icon` |
| 51 | * `.dnxwporg-pl-link-name` |
| 52 | * `.dnxwporg-pl-stats` |
| 53 | * `.dnxwporg-pl-tot-dloads` |
| 54 | * `.dnxwporg-pl-avg-vote` |
| 55 | |
| 56 | This plugin ships with no styling on pourpose, it's up to you to add the styling needed for it to look at it's best on your pages. |
| 557c3817 |
57 | |
| 58 | = I'm stuck with your plugin and don't seem to be able to customize it/make it work, can you help me? = |
| 59 | |
| 60 | Of course, you can ask for help on [the forums](http://wordpress.org/support/) or write a comment on the main article for this plugin on [my site](https://danix.xyz/?p=3745), I'll reply ASAP ;) |
| 61 | |
| 62 | = I'd like this plugin to be translated in my language, can you do this for me? = |
| 63 | |
| 9893170c |
64 | Soon I'll publish a .POT file that can be used to create a translation of the plugin in your language, so if you're familiar with english you can help by providing a translation and it will be added to future versions of the plugin along with a link to your site on these pages ;) |
| 557c3817 |
65 | |
| 66 | A number of softwares exists to help you with .po files, like [POEdit](http://sourceforge.net/projects/poedit/) or [Lokalize](http://userbase.kde.org/Lokalize "for kde users") |
| 67 | |
| 68 | ####If you have any other questions feel free to ask |
| 69 | |
| 70 | == Screenshots == |
| 71 | |
| 72 | 1. The plugin widget as seen in the admin area. |
| 9893170c |
73 | 2. The widget with standard description as seen in the TwentySeventeen theme without any styling. |
| 74 | 3. The widget In my custom theme with styling added to it. |
| 75 | 3. The widget In my custom theme with a custom description. |
| 557c3817 |
76 | |
| 77 | == Changelog == |
| 78 | |
| 9893170c |
79 | = 0.1 = |
| 557c3817 |
80 | * This is the first version of the plugin. |
| 81 | |
| 82 | == Upgrade Notice == |
| 83 | |
| 9893170c |
84 | = 0.1 = |
| 557c3817 |
85 | No upgrade since this is the first version ;) |
| 86 | |
| 87 | |
| 88 | |
| 89 | == ToDo list == |
| 90 | |
| 9893170c |
91 | * .POT file to allow translators to translate the plugin. |
| 92 | * bugfixing. |
| 93 | * theme directory support. |
| 94 | * custom tags inside the description. |
| 95 | * average downloads and more stats coming soon... |
| 557c3817 |
96 | * I'm open to suggestions, so don't be shy. |
