Extension:Proofread Page

The Proofread Page extension can render a book either as a column of OCR text beside a column of scanned images, or broken into its logical organization (such as chapters or poems) using transclusion.

The extension is intended to allow easy comparison of text to the original and allow rendering of a text in several ways without duplicating data. Since the pages are not in the main namespace, they are not included in the statistical count of text units.

The extension is installed on all Wikisource wikis.



Extension

 * 1) Download the files from Git or download a snapshot (select your version of MediaWiki) and place the files under $IP/extensions/ProofreadPage
 * 2) Add to the end of LocalSettings.php:
 * 3) Add the required tables to the database; on the command line, enter:  (Note: Your designated database user needs to have CREATE rights on your MediaWiki database.)
 * 4) Installation can now be verified through Special:Version on your wiki

Thumbnailing
The extension links directly to image thumbnails which often don't exist. You must catch 404 errors and generate the missing thumbnails. You can do this with any one of these solutions:  Set an Apache RewriteRule to thumb.php for missing thumbnails:  or set the Apache 404 handler to Wikimedia's thumb-handler. This is a general-purpose 404 handler with Wikimedia-specific code, not simply a thumbnail generator.   For MediaWiki >= 1.20, you can simply redirect to thumb_handler.php:  


 * Or in apache2.conf :

ErrorDocument 404 /w/thumb_handler.php

WARNING: There is an .htaccess file in the images directory that may interfere with any .htaccess rules you install.

Configuration

 * You need to create MediaWiki:Proofreadpage_index_template in order to display index pages
 * In order to use the page quality system, it is necessary to create four categories. The names of these categories must be defined in s:Mediawiki:Proofreadpage_quality1_category to s:Mediawiki:Proofreadpage_quality4_category.
 * In order to display coloured links in index pages, you need to add quality classes to your CSS files. see the section Page namespace at s:MediaWiki:Common.css.
 * In order to appear in the statistics, it is necessary to create custom "Page" and "Index" namespaces.
 * If your wiki has custom "Page" and "Index" namespaces, the names of these namespaces must match the names indicated in Mediawiki:Proofreadpage_namespace and Mediawiki:Proofreadpage_index_namespace.
 * Ensure that you have installed Extension:ParserFunctions

Creating your first page

 * Before following these steps ensure you have followed the instructions in Using DjVu with MediaWiki.
 * Create a page with the prefix specified in Mediawiki:Proofreadpage_namespace. For example if your prefix is 'Page' create 'Page:Alice in Wonderland.djvu'
 * Create the corresponding file for this page File:Alice in Wonderland.djvu
 * Create the index page 'Index:Alice in Wonderland.djvu'
 * To edit page 5 of the book navigate to 'Page:Alice_in_Wonderland.djvu/5' and click edit

Options

 * The default layout for editing pages is the vertical layout. It is possible to change this and use the horizontal layout, by setting the following variable : This setting can be activated by single users, or for all users if it set in common.js

Roadmap
Thibaut Horel aims to improve this extension, fixing bugs and adding features.
 * Go over Mediawiki 1.19 problems:
 * create tickets for unsolved ones and estimate the amount of work needed. Before Saturday March 10th
 * fix the problems
 * Review and integrate already existing patches:
 * Review requested features:  create tickets for importants ones. Get in touch with other big Wikisources (de, it, ...) to see if they have specific pages to track requested features
 * Other projects to look at, get in touch with: Captcha-OCR, PagedTiffHandler