Help:Beginner's guide to Index: files

Help:Beginner's guide to Index: files

Beginner's guide to Index: files

Index: files, managed by the Proofread Page extension, are a powerful way to allow side-by-side proofreading of documents in WikiSource. This document describes the fastest way to set them up on WikiSource.

Uploading content into the WikiMedia Commons

1. You no longer need DjVu files - PDF files will work just as well. However, as DjVu files may be smaller than corresponding PDFs, and as DjVu formats are explicitly open, they might be the best possible choice for creating files to upload to WikiSource.
   • If you have an existing PDF that you would like to convert to DjVu before upload, 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 your PDF or DjVu file to the Wikimedia Commons. This is the easiest step of all: the commons has an excellent Upload Wizard. If you have any problems during the upload, get help at the Commons' help desk.
   • Name this file with the full title of the document as you want it to appear in Wikisource. If the full title is very long, a shortened title may be appropriate. It might be a good idea to add the edition and year of publication to make it easier to upload multiple editions of the same document.
   • Use categories to categorize your upload in the Commons.
3. You should now have a PDF or DjVu document on the Wikimedia Commons. Some examples of such documents are commons:File:Wind in the Willows (1913).djvu (DjVu) and commons:File:Field Notes of Junius Henderson, Notebook_1.pdf (PDF).

Creating an Index: page on Wikisource

1. 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. For example, if the document you 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, and so on. Using copy/paste can avoid these pitfalls.
2. Wikisource will indicate that "Wikisource does not have a page with this exact name". Click "Create" (or the "add Index:file name to Wikisource") to create this document.
3. A page with fields to enter information about this document will appear. See the Wind in the Willows for an example.
4. Populate each of the fields as in the table below.
5. 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 the name of the page is identical to the name of the file on the Wikimedia Commons. Once you see the page and make any corrections which become apparent in the preview, click "Save page".
6. Congratulations! You now have an Index: page for the work you'd like to transcribe on WikiSource.

Field name	Description	Example
Author	The name of the author. This should be a link to an Author: page on Wikisource, such as Author:Junius Henderson.	[[Author:Kenneth Grahame|Kenneth Grahame]]
Title	The title of this work. It's a good idea to create a page for this work on WikiSource (such as The Wind in the Willows), and then link to that in this field.	[[The Wind in the Willows]]
Year of Publication	The original year of publication of this edition of this work. This is important to establish what copyright protection might exist for this work.	1913
Publisher	The publisher of this work	[[Portal:Charles Scribner's Sons|Charles Scribner's Sons]]
Key	The sort key. See w:WP:SORT for more details about using this field to affect sorting of this title in categories.	Wind in the Willows
Source	The type of image file: djvu, pdf, jpg, jpeg, gif, and so on.	djvu
Cover image	The page of the document which has the cover image. In most cases, this will be page 1; however, in some scanned material, the actual cover might be on a later page. Note that you can also use [[Image:Wind in the Willows (1913).djvu|150px]] to use a custom image.	3
Pages	The command is a powerful way to let people know how the pages in this work are structured. You can just use <pagelist /> to use the order of pages in the uploaded file. However, you can also use it to indicate pages which shouldn't be numbered; for instance, <pagelist 1to2=- 3=1 /> will cause pages 1 and 2 to be represented as unnumbered pages ('-'), and page numbering will start by setting the third page of this document as page 1. Play around with this feature, and use Preview to check what the pages list looks like. See the Proofread Page documentation for more details.	<pagelist 1to16=- 17=1 25to26=- 27=9 69to70=- 71=51 386to390=- />
Table of Contents	Generally used to link to pages containing page content in WikiSource. For instance, if you are working on Index:Wind in the Willows (1913).djvu, you will probably want to create Wind in the Willows to contain the actual transcribed text from this file. You can use the Remarks field to link to this article.	[[Field Notes of Junius Henderson/Notebook 1|Notebook 1]]