====== Top Plugin ======

---- plugin ----
description: Show the top most visited pages
author     : Andreas Gohr
email      : gohr@cosmocode.de
type       : action, syntax
lastupdate : 2017-03-24
compatible : Detritus, Hrun, Hogfather
depends    : sqlite
conflicts  : 
similar    : 
tags       : statistics

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

screenshot_img : 
----
[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

:!: **External requirements:** This plugin requires the following additional components that must be installed separately:
  * [[plugin:sqlite|sqlite plugin]]

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

===== Examples/Usage =====

Show the top ten visted pages of all time:
<code>{{top}}</code>

Show the top ten visted pages of all time in the english namespace (if the translation plugin is installed):
<code>{{top|lang=en}}</code>

Show the top ten visted pages since (and including) January 2014:
<code>{{top|month=201401}}</code>

Show the top ten visted pages since (and including) January 2014 in the english namespace (if the translation plugin is installed):
<code>{{top|month=201401,lang=en}}</code>


===== Syntax =====
Inserting the tag ''<nowiki>{{top}}</nowiki>'' will create a list of the top ten most visited pages.
<code wiki>
{{top[|[lang=$langprefix[,]][month=$startmonth[,]][tag=ol[,]][score=true]}}
</code>

It includes four options.

==== lang ====
If you have the [[plugin:translation|translation plugin]] installed you can filter the pages by language:
<code wiki>
{{top|lang=$langprefix}}
</code>


==== month ====
You can specify the month from which the number of visits is computed with the month option. The Format for the month is ''YYYYMM''.
<code wiki>
{{top|month=$startmonth}}
</code>



==== list items ====
By default the list uses bullet points, which can be changed to a numbered list by adding the ''tag=ol'' option:
<code>{{top|tag=ol}}</code>

==== score ====
You can show the score of each item by adding the ''score=true'' option:
<code>{{top|score=true}}</code> 
or for example as a numbered list 
<code>{{top|tag=ol,score=true}}</code>

===== Troubleshooting =====
==== If top displays nothing ====
=== Restricted to publicly-accessible pages? ===
Check ''plugin»top»show_only_public'' setting; if enabled, but you have no publicly-accessible pages in your wiki, you will see nothing. This is expected behaviour.

===== Development =====


=== Change Log ===

{{rss>https://github.com/cosmocode/dokuwiki-plugin-top/commits/master.atom date}}

=== Known Bugs and Issues ===

Please report bugs and issues at: https://github.com/cosmocode/dokuwiki-plugin-top/issues