====== readability Plugin ======

---- plugin ----
description: Calculate Flesch-Kincaid and Gunning-Fog readability scores and estimated reading time
author     : Andreas Gohr 
email      : andi@splitbrain.org 
type       : Action
lastupdate : 2014-01-03
compatible : Lemming, Anteater, Rincewind, Angua
depends    : 
conflicts  : 
similar    : 
tags       : readability, time

downloadurl: https://github.com/splitbrain/dokuwiki-plugin-readability/zipball/master
bugtracker : https://github.com/splitbrain/dokuwiki-plugin-readability/issues
sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-readability/
donationurl: http://donate.dokuwiki.org/readability
----

This plugin will calculate the readability of the wiki text using the [[wp>Gunning fog index]] and [[wp>Flesch-Kincaid readability test]] on each preview. It also estimates the time a reader will need to read the whole article.

{{ plugin:readability.png?400}}

All real work is done by functions written by [[http://www.addedbytes.com/tools/readability-score/|Dave Child]] and [[http://briancray.com/2010/04/09/estimated-reading-time-web-design/|Brian Cray]].

Note: This is not an exact calculation. Syllable counting is not always correct, so scores are a guideline - treat them as such.

===== Installation =====

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

=== Change Log ===

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