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.
Shortcut:
H:Side

Contents

[edit] Synopsis

The ProofreadPage extension allows you to render text along with its corresponding scanned image (DjVu). 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] Beginner's how-to for DjVu uploading

The most common use of the side by side view is for proofreading complete books or texts in DjVu format. To begin a new DjVu proofreading project, you would do the following:

  1. Get or create a DjVu file of the book or other text you want to work on. If you have a PDF, there are various methods for converting PDF to DjVu at Help:DjVu files. If you can include OCR text in the file, this is preferable because it will automatically populate and save an immense amount of time when you and others proofread the text.
  2. Upload the DjVu file to wikimedia commons using the Basic Upload page or the Advanced Upload page. The Advanced Upload page provides less coaching about copyright status, so if you are doing a large number of public domain works it will probably save you time. Choose a useful filename in the Destination filename box... the best option is the full title as you want it to appear in Wikisource. If the full title is very long, a shortened title may be appropriate.
  3. In your browser (perhaps in a new tab or window), type http://en.wikisource.org/wiki/Index:the name of the file you just uploaded.djvu. For example, if the file uploaded to commons was Wind in the Willows (1913).djvu then you would want to type in http://en.wikisource.org/wiki/Index:Wind in the Willows (1913).djvu Using copy/paste for the name of the file is the best choice— it is very easy to type something wrong, mix up upper and lower case letters, etc. Using copy/paste avoids these pitfalls.
  4. A window that says no such file exists will appear. Click create and you will see a window like this sample of Wind in the Willows, with no data populated into it.
  5. Populate each of the tags as follows:
  • Author: [[Author:Author's name|Author's name]]
  • Title: The title as you want it to appear, or the full long title. Use double brackets around the title that you want to be used as the Wikisource page name. Example: [[The Raven]]. If you discover that, like The Raven your title belongs to more than one work, there will need to be a disambiguation page (like the one at The Raven and your work will need a disambiguation name like [[The Raven (Poe)]]. Making this only display The Raven looks like this: [[The Raven (Poe)|The Raven]]
  • Year of Publication: The year the djvu was published; you might include the original year of publication here if the republication is not a new edition (an unchanged reprint of the same book).
  • Publisher: Type in the name of the publisher.
  • Key: Leave blank.
  • Source: If you downloaded it from somewhere, link to the page where it is available... if you scanned it yourself, list your username.
  • Cover image: If the front cover is appropriate, simply use the following format: [[Image:Wind in the Willows (1913).djvu|300px]]. You can change the width of the image by changing 300 to a larger or smaller number.
  • Pages: If you want to format your pagelist, you can follow the instructions at the ProofreadPage documentation.
  • Remarks: Remarks is generally used for the book index. Other comments could be placed here as well. The information placed here will appear in a third column at the right of the page. If this space is blank, there will be two columns on the page.
  1. Click the "Show Preview" button near the bottom of the page. An "Index:" namespace page with an image of the book you just selected should appear. If the image does not appear, make certain that you have the name exactly the same as you had it at Wikimedia Commons. Once you see the page and make any corrections which become apparent in the preview, click "Save page".
  2. Now you can begin filling in the individual pages with the text as they appear in the book. Review the suggestions below before starting—they cover important formatting topics that would be time-consuming to insert into the text later. After the text of the book is typed in, you can use "transclusion", which is described below, to form the individual pages into chapters or other logical sections as you think most appropriate.

[edit] Editing pages

[edit] Index pages

  • 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] Page Namespace

"Namespaces" are used to differentiate page types at Wikisource. For example, the page you are reading now is in the "Help:" namespace. The "Page:" namespace is used to display page text side-by-side with individual page images, and allows reproduction of the original formatting. A sample page can be found at Page:Equitation.djvu/1. You can zoom in on the page image by clicking on the image in the right-hand pane.

Text corresponding to a scanned image belongs 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. Page numbers for DjVu files are indicated by adding a slash followed by the page number to the file name. For example, Page:Sketch of Connecticut, Forty Years Since.djvu/27 displays the 27th page of Sketch of Connecticut, Forty Years Since.

Important: Although it is desirable to reproduce the layout of the page in the Page: namespace, formatting instructions which apply to the entire page must be placed above the body text in the header box. This box can be opened by clicking the plus sign in the upper left corner. The header and footer are automatically placed inside <noinclude> tags which prevent transclusion of their contents. For example, see Page:The Journal of Leo Tolstoy.djvu/7.

[edit] Formatting conventions

The following conventions are considered best practices for pages in the Page: namespace (DjVu files and other files which use the ProofreadPage extension). For general article formatting conventions and guidelines see Wikisource:Style guide.

  • When a chapter heading and text appear on a DjVu page, place the heading in the "Header (noinclude)" section which is accessed by clicking the which appears above the edit window while in editing mode. Example Page:Wind in the Willows (1913).djvu/19.
  • Quite frequently, a book's header will include the page number at the left or right of the page and the title in the center of the page. The {{RunningHeader}} template is useful for formatting these headers. The RunningHeader template is used as follows:
{{RunningHeader|left|center|right}}
  • left is the number (or text) which should appear at the left of the page;
  • center is the number or text which should appear centered;
  • right is the number or text which should appear at the right of the page;
  • The left, center, or right paramaters may be left blank as appropriate.
{{Hyphenated word start|FIRST HALF OF WORD|WHOLE WORD}}
{{Hyphenated word end|LAST HALF OF WORD|WHOLE WORD}}

[edit] Transclusion

After the text of the work is populated into each side-by-side image page, "transclusion" is used to display the text from the Page: namespace on pages in the main namespace. Transclusion displays the page of another text without having to copy or manually update it later. The purpose of transcluding the text is to group it into logical, reasonably sized chunks— most frequently chapters or sections.

A completed example is the Wind in the Willows. Once all of the individual pages of Index:Wind_in_the_Willows_(1913).djvu were typed up in the "Page:" namespace (one page can be seen at Page:Wind_in_the_Willows_(1913).djvu/19), this text and the following pages of the first chapter were populated into the various chapters of the book in the main namespace beginning at The Wind in the Willows/Chapter 1. The following explains how to use transclusion to display your finished proofreading project as a final product in the Wikisource main namespace.

[edit] Full-page transclusion

There are two methods which can perform full-page transclusion. The <pages> function which can display a series of pages, and the {{Page}} template which can display individual pages or sections of pages. Most of the time, the <pages> tag will be the best method of transcluding into chapters. The syntax is as follows:

  • <pages index="file_name.djvu" from=20 to=40/>
  • from is the beginning page;
  • to is the ending page.
  • This does not currently work for tables. This method of transclusion is very new. If you experience problems, post a question on the Scriptorium.


The Page template can transclude a single page. The syntax is as follows:

  • {{Page|Wind in the Willows (1913).djvu/19|num=3}}
  • The page number is placed after a slash (/) following the file name.
  • num defines the physical page number, as numbered in the scanned text.

To transclude many pages, use the <pages/> command. The syntax is as follows: <pages index="Foo.djvu" from=a to=b />

[edit] Partial transclusion

If two logical sections (for example the end of one chapter followed by the beginning of another) appear the same page, it's necessary to transclude only the relevant part of the page.

This is accomplished using Labeled Section Transclusion (LST). The relevant parts of the page are marked with section tags and then when transcluding, only the relevant part of the page, rather than the entire page, are called.

To mark sections in the "Page:" namespace, 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=chapter1 />This is Chapter 1.<section end=chapter1 />
  • <section begin=chapter2 />This is Chapter 2.<section end=chapter2 />

To accomplish this, the {{Page}} template is used, as follows, replacing "djvu" with the djvu file name and "#" with the page number where the text appears:

  • {{Page|djvu/#|section=chapter1}}
  • {{Page|djvu/#|section=chapter2}}

Alternatively, the following format can be used, replacing "article" with the article name (excluding namespace):

  • {{#section:Page:article|chapter1}}
  • {{#section:Page:article|chapter2}}

[edit] Page with image transclusion

The preferred means of placing a picture or other image in the main pagespace is to upload the cropped image to Wikimedia Commons as a separate picture, for example as a jpeg file. A temporary means of displaying an image is available for users that are not able to do this. To display an image of a page in the DjVu file like at Page:Personal Recollections of Joan of Arc.djvu/9, use:

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

The page image can be displayed in the book's Wikisource mainspace like at 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] 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
Create a book