Help:Side by side image view for proofreading

From Wikisource

Jump to: navigation, search
Side by side image view for proofreading
This help page is about the Proofread Page extension using the Page: namespace.


Contents

[edit] Synopsis

The ProofreadPage extension allows you to render text along with its corresponding scanned image. It is intended to allow easy comparison of text to the original. It has the following advantages :

  • credibility : it makes it possible for Wikisource to guarantee that the text corresponds to its scanned source.
  • improved collaboration : texts can be proofread and typos can be fixed by everyone, not just those who have access to the book. This restores the wiki way of collaborating.
  • security : text is better protected against vandalism (any falsification can be detected immediately; texts are not accessed directly, but through transclusion, which deters unexperienced vandals)
  • no limitations on rendering : a book can be rendered in two different ways, without duplicating data :
  1. as a set of pages. Each page is a column of OCR text beside a column of scanned image. This mode is meant for contributors.
  2. broken into its logical organization (such as chapters or poems) using transclusion. This mode is meant for readers.
  • fairness of comparisons : Since book pages are not in the 'main' namespace, they are not included in the statistical count of text units. A count of pages is available here. This method of comparison uses the same unit of measure for all texts (the page), which puts an end to the temptation of slicing texts into arbitrarily small units in order to increase statistics.

[edit] Usage

[edit] Page Namespace

Place the text corresponding to a scanned image on a new "Page:" namespace page whose name matches the image. For example, the page "Page:The Time Machine (page 1).jpg" will automatically display the image "Image:The_Time_Machine_(page_1).jpg" on the right.

You can zoom in by clicking on the image.

[edit] Transclusion

The text of the page will be rendered in one of two ways:

  • Directly, attempting to reproduce the layout of the scanned page. Formatting instructions must be placed within <noinclude> tags. For example, see Page:The Journal of Leo Tolstoy.djvu/7.
  • indirectly, through transclusion; physical constraints imposed by pages are not relevant, a logical organization is sought. Formatting instructions must be placed inside <includeonly> tags. For example, see The Journal of Leo Tolstoy/Introduction.

The format applied to physical pages must not be the same as the logical pages, so that the user can change the preferences with CSS. For example, the width of the text column must be variable for logical display, without the physical display being changed.

[edit] Partial transclusion

If a logical section ends in the middle of a page, it might be necessary to transclude only the relevant part of the page. This may be accomplished using Labeled Section Transclusion (LST). One labels the two or more parts of the page (e.g. the end of Part I and the beginning of Part II). When transcluding, call up the only the relevant part of the page, rather than the entire page, using LST syntax.

Example: Insert the following syntax into the typed proofreading text to label the end of Part I and the start of Part II (where both are on the same page):

  • <section begin=Part I />This is Part I.<section end=Part I />
  • <section begin=Part II />This is Part II.<section end=Part II />

When calling up the end of Part I or the beginning of Part II within a full, uninterrupted typed version of either Part, use the following syntax:

  • {{#section:article|Part I}}
  • {{#section:article|Part II}}

[edit] Page with image transclusion

The page image can be displayed in the DjVu in place of text as in Page:Personal Recollections of Joan of Arc.djvu/9 using:

{{use page image|caption=JOAN'S VISION}}

The page image can be displayed in the books Wikisource main space as with Personal Recollections of Joan of Arc/Book I/Chapter 2 using:

[[Image:Personal_Recollections_of_Joan_of_Arc.djvu|page=27|right|thumbnail|200px|THE FAIRY TREE]]

[edit] Formatting conventions

The following conventions are considered best practices for ProofreadPage extension (DjVu) for general article formatting conventions and guidelines see Wikisource:Style guide.

{{Hyphenated word start|FIRST HALF OF WORD|WHOLE WORD}}
{{Hyphenated word end|LAST HALF OF WORD|WHOLE WORD}}

[edit] Index page

  • An index page is a chained list of all the Pages of a book. It is used by the extension to build navigation buttons:

previous page , next page and up to index .

Index pages on this wiki are listed in Category:Index.

[edit] Issues

The poem tag does not work well because it adds a carriage return at the end of a block. It's also not possible to use <pre> formatting, since the line breaks are suppressed during transclusion. To solve this issue, add <br /> tags to the beginning of lines.

To ease proofreading images that are rotated, the Rotate Image Firefox extension can be used.

[edit] See also

Retrieved from "http://en.wikisource.org/wiki/Help:Side_by_side_image_view_for_proofreading"
Personal tools
In other languages