Help:Proofread/Technical

The ProofreadPage extension makes up both the front- and back-end of the system for side-by-side proofreading. It consists of a set of server-side PHP and client-side Javascript, as well as MediaWiki messages.

PHP/SQL

 * — the API module. This is what defines what you can interface with over the MediaWiki API.
 * — API module to retrieve the namespace IDs and quality categories
 * — Localisation file for special pages
 * — Localisation file for strings and messages
 * — Initialisations and hooks
 * — Initialisation of the SQL database holding Page: data such as proofread status
 * — The core PHP file which does the server-side processing
 * — Code for the "pages without scans" Special: page
 * — Code for the "proofread pages" Special: page

Javascript

 * — Set up the Page: namespace edit view, with the side-by-side images
 * — Client-side JS to run on mainspace pages
 * — Client-side JS to run on Index: pages

Additionally, there is the following locally stored Javascript:


 * oldwikisource:MediaWiki:Base.js — Contains helper functions and utils for the rest of the Javscript, plus the easyLST routine
 * MediaWiki:PageNumbers.js — Used to process, position and style pagenumbers in the margin of mainspace pages and for dynamic layouts and page highlighting on page number mouseover
 * oldwikisource:MediaWiki:IndexForm.js — Constructs the form on Index: pages in edit mode

MediaWiki messages
MediaWiki messages are used to customise user-facing aspects of the extension which may differ between wikis, such as the template format used to render a header and the descriptions of the proofread levels.


 * Core messages
 * MediaWiki:Proofreadpage pagenum template — The format for pagenumbers show in the mainspace margin
 * MediaWiki:Proofreadpage index template — The template that stores index page data
 * MediaWiki:Proofreadpage index attributes — List of index template attributes
 * MediaWiki:Proofreadpage js attributes — List of attributes shown in the edit mode of the Index namspace
 * MediaWiki:Proofreadpage specialpage text — Language interwiki of Special:IndexPages
 * MediaWiki:Proofreadpage header template — The template used when the header=1 tag parameter is set


 * Namespace names
 * MediaWiki:Proofreadpage namespace — The Page: namespace
 * MediaWiki:Proofreadpage image — The Image/File: namespace
 * MediaWiki:Proofreadpage index namespace — The Index: namespace


 * Tooltips and user aid
 * MediaWiki:Proofreadpage toggleheaders — Tooltip for toggling headers
 * MediaWiki:Proofreadpage footer template — Currently blank
 * MediaWiki:Proofreadpage page status — "Page status"


 * Quality messages
 * MediaWiki:Proofreadpage quality0 message — Without text
 * MediaWiki:Proofreadpage quality1 message — Not proofread
 * MediaWiki:Proofreadpage quality2 message — Problematic
 * MediaWiki:Proofreadpage quality3 message — Proofread
 * MediaWiki:Proofreadpage quality4 message — Validated

Gadgets
The following Gadgets are not part of the extension, but interact directly with side-by-side editing:


 * MediaWiki:Gadget-pr headers.js — Show headers and footers by default
 * MediaWiki:Gadget-pr layout.js — Use the horizontal (image on top) edit mode
 * MediaWiki:Gadget-ocr.js — Disable the OCR tool
 * oldwikisource:MediaWiki:OCR.js — The OCR tool script (which is a proxy to a server-side OCR program)


 * MediaWiki:Gadget-old LST.js — Use the old-style LT markup ( "" instead of "## Foobar ##")
 * mul:Wikisource:Google OCR — a Wikisource toolbar gadget, and standalone tool, for OCRing single images with the Google Cloud Vision service.

External resources

 * ProofreadPage MediaWiki extension page