DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:directions

Directions Plugin

Compatible with DokuWiki

2010-11-07a "Anteater"

plugin Shows where users come and go within the wiki.

Last updated on
2011-02-03
Provides
Syntax, Action
Repository
Source
Requires
graphviz

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to logstats

Tagged with navigation, statistics

This plug-in tracks the navigation between wiki pages and uses such information for two purposes:

  • Shows the whole wiki navigational traffic (optionally with a graph) in table form.
  • Shows “incoming” and “outgoing” pages from a specific page. “Incoming” meaning “where (which wiki page) users came from” and “outgoing” meaning “where (which wiki page) users went to from here”.

This can be useful not only to track user navigation throughout the wiki, but to help users find quicker ways to reach specific data on the wiki. It leverages the “crowd effect” to give users recommendations of the type “users that reached this page went, most often, there…”.

It was based on the logstats plug-in to track user activity.

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

:!: External requirements: This plugin requires the following additional components that must be installed separately:

  • graphviz plugin, if you want to have graph visualization (optional). This plugin should be installed in a directory named graphviz (plugins/graphviz).

Note: After installation, you should do a couple of wiki jumps to force creation of the logging infrastructure (hitslog file).

Examples/Usage

See the plugin in action here FIXME. The sample page shows all the styles available with the plugin.

Showing the local information regarding a specific wiki page

<localdirections>

This shows the “incoming” and “outgoing” wiki pages most users came from or went to, regarding the wiki page where you place this command. You can configure the maximum number of entries shown on this table with the max_directions configuration setting.

Here is an example:

Showing the local information regarding a specific wiki page, with an accompanying graph

<localdirections graph>

Same as before, only this time also with a graph visualization.

Here is an example:

Showing the global wiki navigation jumps

<globaldirections>

This shows all the jumps performed on the wiki by its users, in a table format. (max_directions restriction doesn't apply here).

Here is an example:

Showing the global wiki navigation jumps with an accompanying graph

<globaldirections graph>

(An image here would be too big. Refer to the demo site FIXME).

Syntax

<(local|global)directions graph?>

Configuration and Settings

You have the following configuration options:

  • Relative path to the generated wiki “jumps” log file (hitslog).
  • Maximum number of visible results for a single page in local directions table (max_directions).
  • Visible chars when page title is too big to show (handling visual overflow) (trim_limit).
  • Show only data regarding registered users only (registered_only). It ignores jumps made by unregistered users when processing the log file to compose the directions table.

(inherited from logstats plug-in)

  • Banned ip to ignore (list of ips separated by commas) (banned_ip).
  • Banned users to ignore (list of login separated by commas) (banned_users).
  • Banned agents to ignore (list of strings to detect separated by commas) (banned_agents).

In the style.css file you can tweak the visual style of the tables, for both local and global directions. Feel free to give it your own visual touch.

Development

Change Log

Known Bugs and Issues

Please, go to the bug tracker site

ToDo/Wish List

Give me your feedback here

FAQ

(none, so far)

Discussion

Please, go here

plugin/directions.txt · Last modified: 2016-01-24 19:28 by Aleksandr