Wikisource:ProofreadPage

From Wikisource

Jump to: navigation, search

This page provides information about the Proofreadpage extension, and how it is used at Wikisource. It is suited mostly to admins configuring their wiki, and to users who already know how to use the extension. If you are a beginner looking for a general introduction, see s:en:Help:Side by side image view for proofreading

Use the discussion page to report bugs here, request features you would like to see, and participate in the discussions.

Contents

[edit] MediaWiki update 24/09/2009 - summary of changes

The code was updated today. The following new features are available:

  • A coloured proofreading status indicator is displayed in the main namespace, under the title of pages that use transclusion. It shows the proofreading status of transcluded pages from the "Page" namespace. It also contains a (hidden) backlink to the index page, that can be captured by local javascript.
  • A new special page is available at Special:IndexPages. It displays a similar proofreading indicator for index pages. Indexes are sorted using the number of pages proofread and validated. Most advanced projects are displayed first. Index pages will need to be purged in order to appear in the special page.
  • The <pages> command can display a header, with up-to-date citation information about the transcluded book. This information is extracted from the fields of the index page. The header itself is a template in the MediaWiki namespace, that needs to be setup by sysops. It is possible to pass a local parameter to this template, so that users can define several headers with different styles.
  • Headers generated by the <pages> command can also display navigation links (that is, 'next chapter', 'previous chapter'). The navigation links are found using the list of links to ns-main that are on the index page. The pages may be renamed without updating the navigation links.
  • The <pages> command can perform section transclusion, for the first and last page of the displayed interval. It uses parameters "fromsection" and "tosection".
  • The "Related changes" links now work correctly with index pages that use <pagelist/>
  • The edit window of the "page" namespace sends a formular with three textboxes (header, text, footer) to the server, instead of relying on javascript to concatenate them. This should fix some browser compatibility issues. The PageQuality template was replaced with a parser hook.

The following features were postponed :

  • Text layer extraction from pdf files.
  • Configurable page headers and footers are further delayed.


[edit] MediaWiki update 15/06/2009 - summary of changes

The code was successfully updated. To update your browser, type Ctrl-Shift-R.

The following new features are active :

  • New page status for pages where that do not require double proofreading. (see below)
  • Text layer extraction from djvu file (see below)
  • The old zoom was restored for view mode
  • New zoom for the edit window : use mouse wheel to zoom, and mouse drag to move the image.
  • Configurable Headers and Footers
  • The "pagelist" command now accepts "from ... to" parameters. (see below)
  • New pages command for easy transclusion of a series of page (see below)
  • Edit options can be set as gadgets


[edit] Text layer extraction from djvu file

DjVu files may contain a text layer, typically for the OCR text. This text is extracted when a page is edited for the first time, and added to the edit window.

Examples
Configuration

The file description page might need to be purged if the djvu file was uploaded before the feature was added.

[edit] Configurable Headers and Footers

The default content of page headers and footers can be configured in Mediawiki:Proofreadpage_default_header and Mediawiki:Proofreadpage_default_footer.

In addition, this default value can be adapted to each book. For this, admins need to add 'header' and 'footer' fields to the index pages.

[edit] Proofreading path

ProofreadPage has five quality levels :

↗ Without text
empty page → Not proofread → Proofread → Validated
↘ Problematic ↗

The page status is stored in the s:en:Template:PageQuality template. This template is displayed on pages. The colours are defined in css.

[edit] The <pagelist/> command

Used on index pages, to display links to pages. The name of the index page must match the name of the djvu file.

Syntax
<pagelist from=X to=Y Z=foo AtoB=bar />

where X, Y, Z, A, B are page numbers

The "from...to" parameters define an interval of pages. Example :

<pagelist from=10 to=100 />

The "AtoB" parameter applies a style to an interval of pages. Style parameters may also be applied to a single page. Available styles are : "roman", "highroman", "empty". Other strings are passed to the link. Example :

<pagelist 1to10="roman" 11="Foreword"/>

In this example, '1to10' is an interval, and 11 is a single page.

It is possible to define overlapping intervals, or to modify a s ingle page within an interval. Example :

<pagelist 1to5="empty" 3to10="roman"  />

Counters : if a numeric parameter is applied to a page number, it resets the page counter. Example :

<pagelist 1to10="roman" 11=1 />
Examples 

see here for an example

[edit] The <pages/> command

This command transcludes a series of pages from an index. It also inserts links between pages, with the page numbers taken from the index page.

Syntax

With djvu indexes, parameters should be integers :

<pages index="foo.djvu" from=100 to=200 />.

With other indexes, parameters should be page names:

<pages index=foo from=foo_page1.jpg to=foo_page15.jpg />.

Section transclusion is possible for the first and last page:

<pages index="foo.djvu" from=100 to=200 fromsection=section2 tosection=section1 />.
Configuration

The template Mediawiki:Proofreadpage_pagenum_template is inserted before each transclude page. It is used to display page numbers, in the text or in the margin. It accepts two parameters : 'page' for the page, 'num' for the page number. example

Note

This transclusion method does insert a space between all pages. Thus, it is not possible to cut a word on two pages, and have it displayed correctly. The recommendation is to not cut words.

[edit] User options

The following options can be made available in the user's preferences, as gadgets:

[edit] Configuring index pages

Index pages can be configured by modifying two templates :

In addition, some fields of the index page can be passed to the headers/footers. They must be indicated in

[edit] About journal issues and partial publication

It is not a good idea to create an index page for a few pages of a book, or for a few pages of a journal issue. Another person might create another index with other pages from the same journal issue, and might not know that another index already exists for the same book.

If you want to publish pages from a journal issue, please name the index after the journal, not after the author of the artcle you are publishing.

If you create a djvu file, try to create a djvu of the whole book/issue, even if you are planning to publish only a few pages from that issue. You should not worry that the index pages will look unfinished. Centralizing all the pages of a given book/journal issue will help users who publish excerpts from the same book/issue.


[edit] Headers and Navigation

The 'pages' command can generate headers automatically. For this the command must include a "header" parameter.

Example 

s:fr:La Petite Dorrit - Tome 2 - Chapitre 5

The header is defined in MediaWiki:Proofreadpage_header_template. It is a template that reads parameters extracted from the index page. In addition, it can provide, navigation links, with the following parameters:

{{{prev}}}, {{{current}}}, {{{next}}}

In order to find the previous and next chapters, the index page is used as a Table of Contents. All links from the index page to the to the main namespace are interpreted as 'chapters', except the first one, which is expected to belong to the "title" field. (note: if your wiki does not have an author namespace, this will not work, because the links to author/translator pages will this wrongly interpreted as chapters.)


Page numbers are also available:

{{{from}}}, {{{to}}}

Finally, the value assigned to the "header" parameter is available as :

{{{value}}}

This can be combined with parser functions, in order to define several styles of headers.

[edit] Proofreading status indicator

A coloured proofreading status indicator is displayed in the main namespace, under the title of pages that use transclusion. It shows the proofreading status of transcluded pages from the "Page" namespace. Here is how it looks like :

In this example the text is 40% validated, 30% proofread, 25% raw, and 5% of the transcluded pages are problematic. It also contains a (hidden) backlink to the index page, that can be captured by local javascript.

This indicator is defined by a system message, and it can be configured by admins. Mediawiki:Proofreadpage_quality_template

[edit] Special:IndexPages

This special page lists index pages and their proofreading status. Index pages that were created before the introduction of this feature need to be purged in order to be displayed in the list.

Pages are ordered using the following criterion : 2*(#validated) + (#proofread). This is intended to reflect the number of proofreading actions. In the future more options will be available.

Retrieved from "http://wikisource.org/wiki/Wikisource:ProofreadPage"