Extension:Proofread Page/zh

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:Proofread Page and the translation is 15% complete.
Other languages:
English • ‎español • ‎français • ‎čeština • ‎नेपाली • ‎中文 • ‎日本語
MediaWiki扩展手册
OOjs UI icon advanced.svg
Proofread Page
发布状态: 稳定版
Proofread Page editor.png
实现 页面操作 , ContentHandler , 标签 , API , 資料庫
描述 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.
作者 ThomasV (original author)
Tpt (current maintainer)
最新版本 continuous updates
兼容性方针 发行分支
MediaWiki current master
PHP 7.0+
数据庫更新
许可协议 GNU通用公眾授權條款2.0或更新版本
下载
例子 s:Index:Wind in the Willows (1913).djvu
Page, Index
  • $wgProofreadPageNamespaceIds
  • $wgProofreadPagePageSeparator
  • $wgProofreadPagePageJoiner
  • $wgProofreadPagePageSeparatorPlaceholder
pagequality
翻译Proofread Page扩展如果在translatewiki.net可用
检查使用和版本矩阵。
问题 开放的工作 · 报告错误

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.[1]

Use

The extension is installed on all Wikisource wikis. 有关语法,请参阅s:mul:Wikisource:ProofreadPage。 It is also used on Bibliowiki.

Requirements and recommendations

Installation

Extension

  • 下载文件,并将其放置在您extensions/文件夹中的ProofreadPage目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    wfLoadExtension( 'ProofreadPage' );
    
  • 运行更新脚本,它将自动创建此扩展必须依赖的数据库表。
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

致使用MediaWiki 1.24或更早版本的用户:

上面的说明介绍的是安装此扩展的新方法,它使用wfLoadExtension()。 如果您需要在早期版本(MediaWiki 1.24和更早版本)中安装此扩展,而不是wfLoadExtension( 'ProofreadPage' );,您需要使用:

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
);

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

Configuration

Configuration of index namespace

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 (true is equivalent to being listed in proofreadpage_js_attributes)
    "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", "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 ASCII hyphen character).

Usage

Creating your first page (example with DjVu)

  • Before following these steps ensure you have followed the instructions in Manual:How to use 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

语法

此扩展引入了以下标记: <pages>, <pagelist>

注释

  1. Because the pages are not in the main namespace, they are not included in the statistical count of text units.

参见