Extension:Proofread Page

MediaWiki extensions manual - list

Proofread Page Release status: stable
Implementation	Page action, API
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
Last version	continuous updates
Database changes	yes
License	GPL v2 or later
Download	Download snapshot Subversion [Help] Browse source code View code changes log
Example	s:Index:Wind in the Willows (1913).djvu
Hooks used ParserFirstCallInit BeforePageDisplay GetLinkColours ImageOpenShowImageInlineBefore EditPage::attemptSave ArticleSaveComplete ArticleDelete EditFormPreloadText ArticlePurge SpecialMovepageAfterMove LoadExtensionSchemaUpdates EditPage::importFormData OutputPageParserOutput wgQueryPages
Check usage (experimental) Bugs: list open list all report

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.

Installation

Extension

1. Download the files from SVN 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:
   require_once( "$IP/extensions/ProofreadPage/ProofreadPage.php" );
3. Add the required tables to the database; on the command line, enter:
   
   php maintenance/update.php
   (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:

      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&page=$2&width=$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
  

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. (Note: Use underscores instead of spaces.)

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 :

   var proofreadpage_default_layout='horizontal';
  

  This setting can be activated by single users, or for all users if it set in common.js

See also

• Using DjVu with MediaWiki
• PdfHandler — adds PDF support to Proofread Page
• The current full description and instructions (in English) may be found at this link
• Usage statistics can be found here
• ToDo and feature request list from the Community

Language:	English  • Français