Extension:Proofread Page/en

The Proofread Page extension creates a book either:


 * 1) as a column of OCR text beside a column of scanned images, or
 * 2) broken into chapters or poems. The content of a document appears in the MediaWiki page (transclusion).

The extension is intended to allow easy comparison of text to the original digitization.

This extension shows the text in several ways without actually duplicating the original text.

Use
The extension is installed on all Wikisource wikis. For the syntax, see s:mul:Wikisource:ProofreadPage. It is also used on Bibliowiki.

Requirements and recommendations

 * Access to the command line is required if running the update script (maintenance/update.php) from the web browser fails (documentation here and here).
 * If you want to use DjVu files (optional but recommended), a native DjVu handler needs to be available for configuration. See also.
 * In addition, use of ProofreadPage is highly improved by the use of the following extensions:
 * (strongly recommended)
 * (default page footer contains 
 * (may require additional PHP packages) — adds PDF support
 * (may require additional PHP packages) — adds PDF support

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 in .htaccess 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:
 * For MediaWiki >= 1.20, you can simply redirect to thumb_handler.php:
 * Or in apache2.conf:
 * Or in apache2.conf:

Namespaces
ProofreadPage create by default two custom namespaces named "Page" and "Index" in English with respectively ids 250 and 252.

Their names are translated if your wiki use an other language. .

You can customize their name or their id: Create namespaces by hand and set their ids in using $wgProofreadPageNamespaceIds global. You will do something like:

Namespace id customization is not recommended and might not be supported in the future.

Configuration

 * In order to use the page quality system, it is necessary to create five categories. The names of these categories must be defined in Mediawiki:Proofreadpage_quality0_category to Mediawiki:Proofreadpage_quality4_category.
 * Ensure that you have installed

Configuration of index namespace

 * You need to create MediaWiki:Proofreadpage_index_template in order to display index pages. This page is a template that receive as parameter entries of the edition form.
 * You need to create MediaWiki:Proofreadpage_index_data_config that contain the configuration of the index form. This new configuration page overrides MediaWiki:Proofreadpage_index_attributes and MediaWiki:Proofreadpage_js_attributes.

The configuration is a JSON array of properties. Here is the structure of a property in the array, all the parameters are optional, the default value are set:

The data parameter can have for value: "type", "language", "title", "author", "translator", "illustrator", "editor", "school", "year", "publisher", "place", "progress"

Page separator
The extension puts a separator between every transcluded page and the next, which is defined by. The default value is  (a whitespace). Set  to suppress the separator.

Join hyphenated words across pages
When a word is hyphenated between a page and the next, the extension joins together the two halves of the word. Example: his- and tory becomes history. The "joiner" character is defined by  and defaults to '-' (the regular hyphen character).

Creating your first page (example with DjVu)

 * Before following these steps ensure you have followed the instructions in.
 * (when and in which namespace is the djvu file itself uploaded?)
 * Create a page in the "Page" namespace (or the internationalized name if you use an not-English wiki). For example if your namespace is 'Page' create
 * Create the corresponding file for this page commons:File:Carroll - Alice's Adventures in Wonderland.djvu (or set Manual:$wgUseInstantCommons to ).
 * Create the index page
 * Insert the tag  in the Pages field to visualize the page list
 * To edit page 5 of the book navigate to 'Page:Carroll - Alice's Adventures in Wonderland/5' and click edit

Syntax
This extension introduces the following tags: ,