====== Quality Check Plugin ======

---- plugin ----
description: Analyzes the structural quality of an article and gives feedback to the users
author     : Andreas Gohr
email      : dokuwiki@cosmocode.de
type       : render, syntax
lastupdate : 2024-05-02
compatible : Frusterick Manners, Greebo, !Hogfather
depends    : 
conflicts  : 
similar    : 
tags       : quality, gardening, statistics
downloadurl: https://github.com/cosmocode/qc/zipball/master
sourcerepo : https://github.com/cosmocode/qc
bugtracker : https://github.com/cosmocode/qc/issues
----

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

===== Installation =====

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

Several templates (like e.g., [[template:sprintdoc]]) support this plugin right out of the box.

In other cases after installation you need to put the quality check into your template's ''main.php'' (should be somewhere above the page content):
<code php>
<?php
    //Quality Control
    $qc = plugin_load('helper','qc');
    if ($qc) $qc->tpl();
?>
</code>

===== Configuration & Usage =====

==== Configuration ====

The plugin adds an option 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 <nowiki>FIXME</nowiki> count.

===== Development =====

==== Change Log ====

{{rss>https://github.com/cosmocode/qc/commits/master.atom date}}

==== 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:
<code php>list($x,$y) = textbox($img,0,2,$qc->getLang('i_qcscore'),$c_text);</code>

Change:
<code php>list($x,$y) = textbox($img,0,2,html_entity_decode($qc->getLang('i_qcscore')),$c_text);</code>