Extension:Proofread Page

Základní informace k tomuto rozšíření MediaWiki

Proofread Page Stav rozšíření: stabilní
Zavádění	Akce stránky , ContentHandler , Tag , API , Databáze
Popis	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.
Napsal(i)	ThomasV (original author) Tpt (current maintainer)
Aktuální verze	continuous updates
Zásady kompatibility	Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki	current master
PHP	7.0+
Změny v databázi	dělá
Tabulky	pr_index
Licence	GNU General Public License 2.0 nebo pozdější
Zdrojový kód	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Příklad	s:Index:Wind in the Willows (1913).djvu
Jmenný prostor Page, Index
Parametry $wgProofreadPagePageJoiner $wgProofreadPagePageSeparator $wgProofreadPageNamespaceIds $wgProofreadPagePageSeparatorPlaceholder
Přidaná práva pagequality pagequality-admin
Použité háčky (hooks) ArticleDelete ArticlePurge ArticleUndelete BeforePageDisplay CanonicalNamespaces ContentHandlerDefaultModelFor EditFormPreloadText GetLinkColours GetPreferences ImageOpenShowImageInlineBefore InfoAction LoadExtensionSchemaUpdates OutputPageParserOutput PageSaveComplete ParserFirstCallInit ParserTestTables SetupAfterCache SkinTemplateNavigation SpecialMovepageAfterMove wgQueryPages
Přeložte rozšíření Proofread Page, jsou-li dostupné jeho lokalizační zprávy na webu translatewiki.net
Podívejte se kdo a v jaké verzi toto rozšíření používá.
Problémy	Otevřené úkoly · Nahlásit chybu

Proofread Page extension

2020 Coolest Tool
Award Winner

in the category
Impact

Rozšíření Proofread Page generuje stránku knihy buď jako:

1. dva sloupce, kdy se na jedné straně zobrazuje textový obsah, pokud bylo aplikováno OCR, a vedle něj obrázek naskenovaného originálu,
2. nebo zalomený do kapitol či lépe bloků, přičemž textový obsah na stránce MediaWiki je zalomen pod obrázkem dokumentu (transkluze).

Rozšíření je navrženo tak, aby umožnilo snadné porovnání textu s digitalizovaným originálem.

Textový obsah umí zobrazit několika různými způsoby, aniž by při tom docházelo k jeho duplikaci.

Použití

Toto rozšíření je nainstalováno na všechny wiki Wikisource. O syntaxi se více dozvíte na s:mul:Wikisource:ProofreadPage. Používá se i na Bibliowiki.

Co potřebujete a co je doporučeno

• Pokud selže aktualizační skript (maintenance/update.php), který se spouští přes webový prohlížeč, potřebujete přístup k příkazové řádce (Viz dokumentace zde a zde).
• Pokud chcete používat dokumenty v DjVu formátu (volitelný a doporučený), stačí v nastavení povolit, aby se používal nativní DjVu handler. Viz též Manual:How to use DjVu with MediaWiki .
• Kromě toho, se vám při použití ProofreadPage budou hodit i následující rozšíření:
  • LabeledSectionTransclusion (silně doporučeno)
  • Cite (výchozí patička stránek obsahuje tag <references />
  • Poem
  • PdfHandler (může vyžadovat doinstalování dalších balíčků, které rozšíří možnosti PHP) — přidává podporu pro PDF
  • PagedTiffHandler
  • ParserFunctions

Instalace

Rozšíření

• Stáhněte soubor/y a vložte do adresáře pojmenovaného ProofreadPage ve vaší složce extensions/.
• Na konec vašeho souboru LocalSettings.php přidejte řádek s následujícím kódem:

  wfLoadExtension( 'ProofreadPage' );
  

• Spusťte aktualizační skript, který automaticky provede všechny nezbytné databázové změny, jaké rozšíření vyžaduje.
•  Hotovo – Přejděte na stránku Special:Version vaší wiki, a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.

Pro ty co používají MediaWiki 1.24 a starší:

Výše uvedené instrukce se týkají instalace přes wfLoadExtension(), což je novější způsob instalace rozšíření. Pokud potřebujete toto rozšíření nainstalovat na starší verzi (MediaWiki 1.24 či starší), musíte místo wfLoadExtension( 'ProofreadPage' ); použít:

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

Generování náhledů

Rozšíření odkazuje přímo na miniatury obrázků, které často neexistují. Musíte zachytit chybu 404 a vygenerovat chybějící miniatury. Můžete to udělat pomocí některého z těchto řešení:

• Nastavte Apache RewriteRule v $htaccess na [[thumb.php |thumb.php]] pro chybějící miniatury:

    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]

• nebo nastavte popisovač Apache 404 na thumb-handler na Wikimedia. Toto je obecný obslužný program 404 s kódem specifickým pro Wikimedia, ne generátor miniatur.

    ErrorDocument 404 /w/extensions/upload-scripts/404.php

• U MediaWiki> = 1,20 můžete jednoduše přesměrovat na 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]

• Nebo na apache2.conf:

    ErrorDocument 404 /w/thumb_handler.php

Varování:

V adresáři images je soubor .htaccess, který může narušovat jakákoli pravidla .htaccess, která instalujete.

Jmenné prostory

ProofreadPage si zakládá při instalaci dva uživatelsky definované jmenné prostory, v angličtině pojmenované "Page" a "Index", které mají id 250 a 252.

Pokud vaše wiki používá jako výchozí jiný jazyk než angličtinu, budou jejich názvy lokalizované. Úplný seznam.

Názvy těchto jmenných prostorů i jejich id můžete změnit: Vytvořte si vlastní jmenné prostory v konfiguračním souboru LocalSettings.php , a nastavte jim id, jaké vám vyhovuje přes globání proměnnou $wgProofreadPageNamespaceIds. Váš kód v konfiguraci pak bude vypadat asi takto:

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

Vezměte ale na vědomí fakt, že si tím můžete do budoucna komplikovat situaci, protože nelze vyloučit, že se metoda pro zakládání vlastních jmenných prostorů změní.

Konfigurace

• Aby bylo možné použít systém kvality stránky, je nutné vytvořit pět kategorií. Názvy těchto kategorií musí být definovány v MediaWiki:Proofreadpage_quality0_category až MediaWiki:Proofreadpage_quality4_category.
• Ujistěte se, že máte nainstalován Extension:ParserFunctions

Nastavení jmenného prostoru index

• Aby se vám vygenerovala indexová stránka, musíte nejprve vytvořit stránku MediaWiki:Proofreadpage_index_template. Tato stránka je ve své podstatě šablona, jejíž parametry vyplňujete prostřednictvím editačního formuláře.
• Nastavení jednotlivých položek formuláře se dělá přes stránku MediaWiki:Proofreadpage_index_data_config, kterou musíte vytvořit. Nastavení této stránky přebíjí obsah stránek MediaWiki:Proofreadpage_index_attributes a MediaWiki:Proofreadpage_js_attributes, přes které se to dělalo dříve.

Konfigurace je ve formátu JSON. Takto vypadá struktura pro jedno formulářové pole, a jeho výchozí parametry. Pokud některý vynecháte, použije se výchozí hodnota:

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

Parametr data může obsahovat některou z následujících hodnot: "type", "language", "title", "author", "translator", "illustrator", "editor", "school", "year", "publisher", "place", "progress"

Oddělovač stránek

Rozšíření vkládá mezi transkludované stránky oddělovač, který je uložen v proměnné wgProofreadPagePageSeparator. Ve výchozím stavu obsahuje   (mezera). Chcete-li ho zcela potlačit, nastavte wgProofreadPagePageSeparator = "".

Spojení slov rozdělených mezi stránky

Přechází-li slovo rozdělené pomlčkou na další stránku, budou obě části spojeny do jednoho slova. Konkrétně: z "hi-" a "storie" bude "historie". Jako "spojovník" je interpretován znak uložený v proměnné wgProofreadPagePageJoiner, ve výchozím stavu je to '-' (pomlčka -).

Použití

Vytvoření první stránky (pro DjVu soubor)

• Předtím, než budete pokračovat zkontrolujte, jestli máte vaši konfiguraci nastavenou podle toho jak píše Manual:How to use DjVu with MediaWiki .
• (kdy a v jakém jmenném prostoru je samotný soubor djvu nahrán?)
• Pokračujte založením stránky ve jmenném prostoru "Page" (jeho název se může pochopitelně lišit, pokud používáte wiki co není v angličtině, a máte intenacionalizované názvy jmenných prostorů). Pokud se váš jmenný prostor jmenuje 'Page', tak založte stránku Page:Carroll - Alice's Adventures in Wonderland.djvu.
• Pak si do wiki nahrejte soubor odpovídající této stránce commons:File:Carroll - Alice's Adventures in Wonderland.djvu (nebo si nastavte proměnnou Příručka:$wgUseInstantCommons na true).
• Pro vložený soubor vytvořte indexovou stránku Index:Carroll - Alice's Adventures in Wonderland.djvu
  • Do vstupního pole Stránky vložte tag <pagelist />, aby se vám vygeneroval seznam odkazů na stránky
• Kliknete-li na číslo 5, které vede na stranu 'Page:Carroll - Alice's Adventures in Wonderland/5' můžete začít stránku editovat.

Syntaxe

Toto rozšíření zavádí následující tagy: <pages>, <pagelist>

Související odkazy

• Manual:How to use DjVu with MediaWiki
• PdfHandler — umožňuje použít Proofread Page i na soubory v PDF formátu
• Roadmap of the development
• Kompletní popis a popis (v angličtině) můžete najít na: s:Help:Proofread
• Statistiky pro Wikisource najdete zde: https://phetools.toolforge.org/statistics.php
• Seznam úkolů a požadavků na funkce ze Společenství
• Uživatelská příručka ve veřejné doméně je psána na: Help:Extension:ProofreadPage
• MediaWiki:OCR.js - skript OCR