Extension:Proofread Page

MediaWiki extensions manual

Proofread Page Release status: stable
Implementation	Page action
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
MediaWiki	>= 1.47.0
Database changes	Yes
Composer	mediawiki/proofread-page
Parameters $wgProofreadPagePageSeparatorPlaceholder $wgProofreadPagePageSeparator $wgProofreadPageNamespaceIds $wgProofreadPageUseParsoid $wgProofreadPageEnableEditInSequence $wgProofreadPageBookNamespaces $wgProofreadPageUseStatusChangeTags $wgProofreadPagePageJoiner
Added rights pagequality pagequality-admin pagequality-validate
Hooks used BeforePageDisplay CanonicalNamespaces ChangeTagsListActive CodeMirrorGetMode ContentHandlerDefaultModelFor EditFormPreloadText GetBetaFeaturePreferences GetDoubleUnderscoreIDs GetLinkColours GetPreferences ImageOpenShowImageInlineBefore InfoAction ListDefinedTags LoadExtensionSchemaUpdates MediaWikiServices MultiContentSave OutputPageParserOutput ParserFirstCallInit ParserTestGlobals RecentChange_save ResourceLoaderRegisterModules ScribuntoExternalLibraries ScribuntoExternalLibraryPaths SkinTemplateNavigation::Universal wgQueryPages
Licence	GNU GPL
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball
Example	s:Index:Wind in the Willows (1913).djvu
Translate the Proofread Page extension if it is available at translatewiki.net

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.

Installation

The extension is enabled on all Wikisources. If you want to install it on your own wiki, you will need to install a 404 handler for generating thumbnails, such as WebStore.

1. Copy the files folder in the folder extensions/ProofreadPage.
2. Add in LocalSettings.php :

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

3. Execute SQL (see ProofreadPage.sql)
4. Add an extension on the table name if you are using one (for example mw_)

Configuration

• You need to create the 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.

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

• How to use DjVu with MediaWiki
• PdfHandler (could be use with Proofread Page)
• The current full description and instructions (in English) may be found at this link
• Usage statistics can be found here