Extension:Proofread Page

MediaWiki extensions manual

Proofread Page Release status: stable
Implementation	Page action, ContentHandler, Tag, API, Database
Description	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.
Author(s)	ThomasV (original author) Tpt (current maintainer)
Latest version	continuous updates
Compatibility policy	release branches
MediaWiki	current master
PHP	7.0+
Database changes	Yes
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history code review
Example	s:Index:Wind in the Willows (1913).djvu
Namespace	Page, Index
Parameters $wgProofreadPageNamespaceIds $wgProofreadPagePageSeparator $wgProofreadPagePageJoiner $wgProofreadPagePageSeparatorPlaceholder
Added rights pagequality
Hooks used SetupAfterCache ParserFirstCallInit BeforePageDisplay GetLinkColours ImageOpenShowImageInlineBefore ArticleSaveComplete ArticleDelete ArticleUndelete ArticlePurge SpecialMovepageAfterMove LoadExtensionSchemaUpdates OutputPageParserOutput wgQueryPages GetPreferences CustomEditor CanonicalNamespaces SkinTemplateNavigation ContentHandlerDefaultModelFor APIEditBeforeSave UnitTestsList InfoAction
Translate the Proofread Page extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

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 Manual:How to use DjVu with MediaWiki.
• In addition, use of ProofreadPage is highly improved by the use of the following extensions:
  • LabeledSectionTransclusion (strongly recommended)
  • Cite (default page footer contains <references/>
  • Poem
  • PdfHandler (may require additional PHP packages) — adds PDF support
  • PagedTiffHandler
  • ParserFunctions

Installation

Extension

• Download and place the file(s) in a directory called ProofreadPage in your extensions/ folder.

• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'ProofreadPage' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'ProofreadPage' );, you need to use:

require_once "$IP/extensions/ProofreadPage/ProofreadPage.php";

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:

      RewriteEngine On
      RewriteCond %{REQUEST_FILENAME} !-f
      RewriteCond %{REQUEST_FILENAME} !-d
      RewriteRule ^/w/images/thumb/[0-9a-f]/[0-9a-f][0-9a-f]/([^/]+)/page([0-9]+)-?([0-9]+)px-.*$ /w/thumb.php?f=$1&p=$2&w=$3 [L,QSA]
  

• 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.

      ErrorDocument 404 /w/extensions/upload-scripts/404.php
  

• For MediaWiki >= 1.20, you can simply redirect to thumb_handler.php:

      RewriteEngine On
      RewriteCond %{REQUEST_FILENAME} !-f
      RewriteCond %{REQUEST_FILENAME} !-d
      RewriteRule ^/w/images/thumb/[0-9a-f]/[0-9a-f][0-9a-f]/([^/]+)/page([0-9]+)-?([0-9]+)px-.*$ /w/thumb_handler.php [L,QSA]
  

• 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.

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. Full list.

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

define( 'NS_PROOFREAD_PAGE', 250);
define( 'NS_PROOFREAD_PAGE_TALK', 251);
define( 'NS_PROOFREAD_INDEX', 252);
define( 'NS_PROOFREAD_INDEX_TALK', 253);
$wgExtraNamespaces[NS_PROOFREAD_PAGE] = 'Page';
$wgExtraNamespaces[NS_PROOFREAD_PAGE_TALK] = 'Page_talk';
$wgExtraNamespaces[NS_PROOFREAD_INDEX] = 'Index';
$wgExtraNamespaces[NS_PROOFREAD_INDEX_TALK] = 'Index_talk';
$wgProofreadPageNamespaceIds = array(
    'index' => NS_PROOFREAD_INDEX,
    'page' => NS_PROOFREAD_PAGE
);

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 Extension:ParserFunctions

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:

{
  "ID": { //id of the metadata (first parameter of proofreadpage_index_attributes)
    "type": "string", //the property type (for compatibility reasons the values have not to be of this type). Possibles values: string, number, page. If set, the newly set values should be valid according to the type (e.g. for a number a valid number, for a page an existing wiki page...)
    "size": 1, //only for the type string : number of lines of the input (third parameter of proofreadpage_index_attributes)
    "values":  {"a":"A", "b":"B","c":"C", "d":"D"}, //an array values : label that list the possible values (for compatibility reasons the stored values have not to be one of these)
    "default": "", //the default value
    "header": false, //add the property to Mediawiki:Proofreadpage_header_template template
    "label": "ID", //the label in the form (second parameter of proofreadpage_index_attributes)
    "help": "", //a short help text
    "delimiter": [], //list of delimiters between two part of values. By example ["; ", " and "] for strings like "J. M. Dent; E. P. Dutton and A. D. Robert"
    "data": "" //proofreadpage's metadata type that the property is equivalent to
  }
}

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

Page separator

The extension puts a separator between every transcluded page and the next, which is defined by wgProofreadPagePageSeparator. The default value is   (a whitespace). Set wgProofreadPagePageSeparator = "" 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 wgProofreadPagePageJoiner and defaults to '-' (the regular hyphen character).

Usage

Creating your first page (example with DjVu)

• Before following these steps ensure you have followed the instructions in Using DjVu with MediaWiki.
• (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 Page:Carroll - Alice's Adventures in Wonderland.djvu
• Create the corresponding file for this page commons:File:Carroll - Alice's Adventures in Wonderland.djvu (or set Manual:$wgUseInstantCommons to true).
• Create the index page Index:Carroll - Alice's Adventures in Wonderland.djvu
  • Insert the tag <pagelist/> 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: <pages> and <pagelist>.

See also

• Using DjVu with MediaWiki
• PdfHandler — adds PDF support to Proofread Page
• Roadmap of the development
• The current full description and instructions (in English) may be found at s:Help:Proofread
• Usage statistics can be found here
• ToDo and feature request list from the Community
• A public-domain user manual is being written at Help:Extension:ProofreadPage
• MediaWiki:OCR.js - the OCR script

Other languages:	English  • français