====== dokugource Plugin ======

---- plugin ----
description: Extract gource log from the wiki
author     : Etienne Meleard
email      : etienne.meleard@free.fr
type       : syntax, admin, action
lastupdate : 2010-05-19
compatible : 
depends    : 
conflicts  : 
similar    : 
tags       : log

downloadurl: https://trello.com/1/cards/5d4ee70f7492f024a1cffcdf/attachments/5d4ee7293b332d8f79e581d0/download/dokugource.zip
bugtracker : 
sourcerepo : 
donationurl: 

screenshot_img: 
----

Inspired from [[tips:gource_analysis]]

===== Download and Installation =====

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

===== Syntax and Usage =====

Use "Gource Log" in the admin panel to get a [[https://gource.io/|Gource]] compatible log file to generate an animated view of your wiki changes! From field is the log starting date (strtotime compatible). Use Namespace field if you want log for a specific namespace only (absolute path).

Put:
  ~~gourcecolor:hex_color_code~~
or
  ~~gourcecolor>hex_color_code~~

in pages to force their colors.

If you use:
  ~~gourcecolor<hex_color_code~~

it sets the color for the namespace.

Examples:
  ~~gourcecolor:FF0000~~ in foo:bar sets the color to red for the file foo/bar.txt
  ~~gourcecolor<0F0~~ in foo:bar sets the color to green for all pages and media under foo/


Then you can use Gource to watch logs:
  gource --log-format custom gource_log_file.log --stop-position 1.0 --stop-on-idle --file-idle-time 630720000

You can turn it into a video using ffmpeg for example:
  gource --log-format custom gource_log_file.log --disable-progress --file-idle-time 630720000 --stop-at-end --output-ppm-stream - | ffmpeg -y -b 3000k -r 60 -f image2pipe -vcodec ppm -i - -vcodec flv -s 800x600 video.flv

You can also call upon urls like
  my.domain.tld/path/to/page?dokugource_key=key
  my.domain.tld/path/to/page?dokugource_key=key&dokugource_from=unix_timestamp

To get the log for the namespace the page is under. Key is defined in the gource log admin pannel using the following format:
  key accessible_namespace

Where key length must be between 8 and 64 chars using letters and digits (case sensitive). Use namespace parameter to restrict access to a specific namespace for the users of this key.