Differences

This shows you the differences between two versions of the page.

--- blog:articles:software:doku_dlcounter [2019/05/15 17:30] – [DLCounter Plugin] Phil Ide
+++ blog:articles:software:doku_dlcounter [2024/07/30 11:15] (current) – [Installation] Phil Ide
@@ Line 12: / Line 12: @@
 <HTML>
 <table class=infobox>
-<tr><th align=right>Last updated</th><td> 2019-05-15</td></tr>
+<tr><th align=right>Last updated</th><td> 2024-07-27</td></tr>
-<tr><th align=right>Provides</th><td> Syntax, Action</td></tr>
+<tr><th align=right>Provides</th><td> Syntax, Admin, Action</td></tr>
 <tr><th align=right>Author</th><td> Phil Ide</td></tr>
 </table>
 </HTML>
-This download-counter plugin for **DokuWiki** enables you to keep track of the number of downloads of media files such as zip, gzip, tarballs and pdf's (your choice of media formats). This plugin has been developed and tested on **"Greebo"**, it may not work with older versions of DokuWiki.
+This download-counter plugin for **DokuWiki** enables you to keep track of the number of downloads of media files such as zip, gzip, tarballs and pdf's (your choice of media formats). This plugin has been developed and tested on **"Greebo"**, it may not work with older versions of DokuWiki. It has worked on all versions since, up to and including **"Kaos"**.
 This page is the documentation for this plugin, describing configuration, the syntax for displaying the data (or parts of it) and the on-disk format of the data-store and how to access it from your own (possibly inline) code should you need to.
 === ===
-The data is stored in a folder named 'counts' off the data folder, so it gets backed up when you backup your data folder (you do do that, don't you?).
+The data is stored in a folder named 'counts' off the data folder, so it gets backed up when you backup your data folder (you do that, don't you?).
+===== Recent Updates =====
+{{rss>https://github.com/stroggprog/dlcounter/commits/master.atom date 3}}
 ===== Installation =====
 Search and install the plugin using the [[https://www.dokuwiki.org/plugin:extension|Extension Manager]]. Refer to [[https://www.dokuwiki.org/plugin_installation_instructions|Plugins]] on how to install plugins manually.
-For manual installation, the latest version of the package can be [[blog:aardvaark:downloads|downloaded here]].
+For manual installation, the latest version of the package can be [[blog:aardvaark:downloads|downloaded here]] (local copy) or [[https://github.com/stroggprog/dlcounter|downloaded here]] (github repository).
+===== Admin Page =====
+The plugin has an entry on the Admin page. This now works, and displays a list of all the files downloaded from the media library that you have been tracking (see [[#configuration|Configuration]] below). Remember that it can only display items that have been downloaded - files that haven't it doesn't know about. The list is sorted by file name.
 ===== Configuration =====
@@ Line 49: / Line 54: @@
 An example in a more realistic use-case:
-<code>..blah blah blah widget.zip ({{dlcounter>file?software:downloads:widget.zip}} downloads).</code>
+<code>..blah blah blah widget.zip (**{{dlcounter>file?software:downloads:widget.zip}}** downloads).</code>
 which  might output:\\
->..blah blah blah widget.zip (15 downloads).
+>..blah blah blah widget.zip (**15** downloads).
 Note that if you request data for a file that doesn't exist, the plugin returns zero and not an error. It only knows about files that have been downloaded since the plugin was installed, so assumes everything else hasn't been downloaded yet, whether it is a real file or you've typed the name incorrectly or provided the wrong path.
@@ Line 95: / Line 100: @@
 Note that if you use the ''strip'' parameter to remove path information, the filename will still be emboldened unless you use the ''nobold'' option.
-Sorting is performed on the column named in the command, e.g. if you specify ''name?sort'', the filenames will be sorted, and ''count?sort'' will result in the counters being sorted.
+Sorting is performed on the column named in the command, e.g. if you specify ''name?sort'', the filenames will be sorted, and ''count?sort'' will result in the counters being sorted. Sorting on names uses the filename first and the path as a subsort.
 Parameters should be separated from each other by a space.
@@ Line 113: / Line 118: @@
 An example of table output:
-<code>{{dlcounter>count?rsort strip left tleft}}</code>
+<code>{{dlcounter>count?rsort strip left hleft}}</code>
 results in:
 <HTML>