====== authorstats Plugin ======

---- plugin ----
description: Plugin that outputs statistics about the wiki's authors
author     : Constantinos (ConX) Xanthopoulos
email      : conx@xanthopoulos.info
type       : syntax
lastupdate : 2022-03-12
compatible : 2010-11-07, Binky, Rincewind, Angua, Adora Belle, Weatherwax, Ponder Stibbons, "Detritus", "Elenor Of Tsort", "Frusterick Manners", Greebo, Hogfather, igor
depends    : pagelist 
conflicts  : 
similar    : stats, statdisplay
tags       : authors, statistics, users, report

downloadurl: https://github.com/ConX/dokuwiki-plugin-authorstats/zipball/master
bugtracker : https://github.com/ConX/dokuwiki-plugin-authorstats/issues
sourcerepo : https://github.com/ConX/dokuwiki-plugin-authorstats
donationurl: 
----

===== Description =====

Plugin that outputs metrics about the wiki's authors. Simply save a page including the code ''<AUTHORSTATS #>'' (read the Syntax section) to generate a table containing the desired statistics.

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
===== Example of Usage =====

** Saving a page including in the code ''<AUTHORSTATS>'' and ''<AUTHORSTATS 16>''.** \\ This will submit two tables. One with metrics since the beginning of the wiki and one with metrics for the last 16 months.

{{http://i.imgur.com/Em9wf.png?nolink&450}}

** The generated tables as expected.**
 
{{http://i.imgur.com/Zz2wq.png?nolink&450|}} 


** Current Year Contributions Graph **

{{https://i.imgur.com/kFd7rlu.png}}

===== Syntax =====

** Simple Description **

<code><AUTHORSTATS #></code>

# is optional and could be any number of months in which you want to output metrics. If it is omitted, the page will output the metrics since the beginning of the wiki.


** Current Year-to-Date Contributions Graph **
<code><AUTHORSTATS YEARGRAPH></code>

** BNF Description **

<code>
[authorstats_syntax] ::= '<AUTHORSTATS>'
                       | '<AUTHORSTATS [num]>'
                       | '<AUTHORSTATS YEARGRAPH>'
                       | '<AUTHORSTATS YEARGRAPH [num]>'
                       | '<AUTHORSTATS YEARGRAPH [num] [sort]>'
[num]  ::= integer
[sort] ::= 'asc'
         | 'ascending'
         | 'desc'
         | 'descending'
         | 'rev'
         | 'reverse'
</code>


===== Acknowledgements =====

  * [[https://github.com/sophron | George Chatzisofroniou (aka. sophron)]] who is the original author!!!
  * Gerrit Uitslag (aka. Klap-in) for his bug reports and feedback.

===== Bugs and Issues =====

To inform us about a bug or even send me a patch please use [[https://github.com/ConX/dokuwiki-plugin-authorstats/issues|GitHub's Issue tracking interface]].



===== Discussion =====

**1. SORTABLE** 
For sorting you need to install [[plugin:sortablejs|sortablejs]] plugin and use it as follows:

<code>
<sortable 1=alpha 2=numeric 3=numeric 4=numeric 5=numeric 6=numeric 7=numeric>
<AUTHORSTATS> 
</sortable>
</code>
        
**2. <AUTHORSTATS YEARGRAPH #y [sort]> to display yeargraph of year #yr**
<code>
<AUTHORSTATS YEARGRAPH>
<AUTHORSTATS YEARGRAPH 2>
<AUTHORSTATS YEARGRAPH 2 desc>
</code>


**3. Admin panel menu**

Question: What does the "Authorstats" menu in the admin panel do?

It says "//To force the generation of the authorstats DB click on the button below//". What does that mean?

When should this be performed?

tx

**4. User Configuration**

If you want that, deleted Users not get anymore shown in the Statistics simply go to the Configuration Manager searh for the Section of the Plugin and uncheck the box where it Says Show deleted Users.