DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:qc

Quality Check Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" unknown

plugin Analyzes the structural quality of an article and gives feedback to the users

Last updated on
2017-04-12
Provides
Syntax, Render
Repository
Source
Conflicts with
definitionlist

Tagged with gardening, quality, statistics

A CosmoCode Plugin

Installation

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

After installation you need to put the quality check into your template's main.php (should be somewhere above the page content):

<?php
    //Quality Control
    $qc = plugin_load('helper','qc');
    if ($qc) $qc->tpl();
?>

Configuration & Usage

Configuration

The plugin adds a options to the config manager where the look of the quality bar can be adjusted.

You can set the color of the generated text to match your template and choose from different icon sets.

Disabling Checks on a Page

You can disable the quality check on a page by putting a ~~NOQC~~ macro somewhere into the page.

Currently Implemented Checks

The following checks are currently used to determine the structural quality:

  • Number of FIXMEs
  • No Main Headline
  • Too many Main Headlines
  • Incorrectly Nested Sections
  • Many Horizontal Rules
  • Many Forced Line Breaks
  • Deeply Nested Quotes
  • Single Author Only
  • Very Small Document
  • Very Large Document
  • Many Headlines
  • Few Headlines
  • No Wiki Links
  • Many links to non-existing pages
  • Too much Text Formatting
  • Long Formatted Passages
  • Overly Formatted Text
  • No Backlinks

Admin page

Moderators and administrators find a quality report on the admin page. This report lists the worst 25 wiki pages known to the quality plugin with their current quality score and FIXME count.

Development

Change Log

Known Bugs and Issues

Please report bugs and issues at: https://github.com/cosmocode/qc/issues

Discussion

The QC helper use a ondemande build'in image with gd.

HTML entities like &eacute;(é) won't be correctly encode.

To solve it, in the icon.php file, you can change the line 91 :

Previous :

  list($x,$y) = textbox($img,0,2,$qc->getLang('i_qcscore'),$c_text);

Change :

  list($x,$y) = textbox($img,0,2,html_entity_decode($qc->getLang('i_qcscore')),$c_text);
plugin/qc.txt · Last modified: 2017-04-12 23:51 by andi