Quality Check Plugin

This plugin automatically analyzes the current page and tries to identify possible problems with the page's structural quality. It doesn't analyze the page content but instead focuses on general good practices in formatting and structuring wiki pages.

The result of the analysis is shown as a quality score. The higher the score, the more problems where found. Additionally the number of FIXMEs is shown next to the quality score.

On clicking the quality info, more detailed information about the identified problems are given along with a few general statistics about the page. Problem descriptions are accompanied by tips on how to fix them.

Quality Scores and FIXME counts are also shown next to each document in the index.

These two (German) screencasts show the plugin in action:

• ICKEwiki ScreenCast: Qualitätssicherungs-Tool

• ICKEwiki ScreenCast: FIXME's

Download and install the plugin using the Plugin Manager using the following URL:

• Unstable development version from the git repository (tgz)

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');
 
    $qc->tpl();
 
?>

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.

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

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

1. Number of FIXMEs

1. No Main Headline

1. Too many Main Headlines

1. Incorrectly Nested Sections

1. Many Horizontal Rules

1. Many Forced Line Breaks

1. Deeply Nested Quotes

1. Single Author Only

1. Very Small Document

1. Very Large Document

1. Many Headlines

1. Few Headlines

1. No Wiki Links

1. Many links to non-existing pages

1. Too much Text Formatting

1. Long Formatted Passages

1. Overly Formatted Text

1. No Backlinks

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.

This plugin is still experimental and we need feedback to improve it. Please send feedback either via the issue tracker linked above, or by email to dokuwiki@cosmocode.de. We are especially interested in the following questions:

• What other problems do you often encounter in your Wiki pages that could be detected automatically?

• Are current checks sensible or are they too strict or too loose?

• Does the plugin help with Wiki Gardening?

• Do you need additional GUIs/tools (e.g. aggregation, filters, …)?

• Did structural quality improve after introducing the plugin?

• Any other suggestions.