Extension:Proofread Page

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 24% 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
translatewiki.net で翻訳を利用できる場合は、Proofread Page 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点 未解決のタスク · バグを報告

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]

使用

The extension is installed on all Wikisource wikis. 構文については、s:mul:Wikisource:ProofreadPage を参照してください。 It is also used on Bibliowiki.

要件と推奨

  • 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. Manual:How to use DjVu with MediaWiki も参照してください。
  • In addition, use of ProofreadPage is highly improved by the use of the following extensions:

インストール

拡張機能

  • ダウンロードして、ファイルを extensions/ フォルダー内の ProofreadPage という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    wfLoadExtension( 'ProofreadPage' );
    
  • 更新スクリプトを実行します。このスクリプトは、この拡張機能が必要とするデータベース テーブルを自動的に作成します。
  • Yes 完了 – ウィキの「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.

名前空間

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. 完全な一覧

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 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"

ページ区切り

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

使用法

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

構文

This extension introduces the following tags: <pages>, <pagelist>

注記

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

関連項目