Formatting Guidelines
Check out the Formatting Quiz!
Contents
- 1 The Primary Rule
- 2 Summary Guidelines
- 3 About This Document
- 4 Each Page is a Separate Unit
- 5 Project Comments
- 6 Forum/Discuss This Project
- 7 Fixing Errors on Previous Pages
- 8 Formatting at the Character Level:
- 8.1 Placement of Inline Formatting Markup
- 8.2 Italics
- 8.3 Bold Text
- 8.4 Underlined Text
- 8.5 Spaced Out Text (gesperrt)
- 8.6 Font Changes
- 8.7 Words in Small Capitals
- 8.8 Words in All Capitals
- 8.9 Font Size Changes
- 8.10 Extra Spaces or Tabs Between Words
- 8.11 Superscripts
- 8.12 Subscripts
- 8.13 Page References "See p. 123"
- 9 Formatting at the Paragraph Level:
- 9.1 Chapter Headings
- 9.2 Section Headings
- 9.3 Other Major Divisions in Texts
- 9.4 Paragraph Spacing/Indenting
- 9.5 Thought Breaks (Extra Spacing/Decoration Between Paragraphs)
- 9.6 Illustrations
- 9.7 Footnotes/Endnotes
- 9.8 Paragraph Side-Descriptions (Sidenotes)
- 9.9 Placement of Out-of-Line Formatting Markup
- 9.10 Block Quotations
- 9.11 Lists of Items
- 9.12 Tables
- 9.13 Poetry/Epigrams
- 9.14 Line Numbers
- 9.15 Letters/Correspondence
- 9.16 Right-aligned Text
- 10 Formatting at the Page Level:
- 11 Common Problems:
- 12 Alphabetical Index to the Guidelines
The Primary Rule
"Don't change what the author wrote!"
The final electronic book seen by a reader, possibly many years in the future, should accurately convey the intent of the author. If the author spelled words oddly, we leave them spelled that way. If the author wrote outrageous racist or biased statements, we leave them that way. If the author put italics, bold text, or a footnote every third word, we mark them italicized, bold, or footnoted. If something in the text does not match the original page image, you should change the text so that it does match. (See Printer's Errors for proper handling of obvious misprints.)
We do change minor typographical conventions that don't affect the sense of what the author wrote. For example, we move illustration captions if necessary so that they only appear between paragraphs (Illustrations). Changes such as these help us produce a consistently formatted version of the book. The rules we follow are designed to achieve this result. Please carefully read the rest of these Guidelines with this concept in mind. These guidelines are intended for formatting only. The proofreaders matched the image's content, and now as a formatter you match the image's look.
To assist the next formatter and the post-processor, we also preserve line breaks. This allows them to easily compare the lines in the text to the lines in the image.
Summary Guidelines
The Formatting Summary is a short, 2-page printer-friendly (.pdf) document that summarizes the main points of these Guidelines and gives examples of how to format. Beginning formatters are encouraged to print out this document and keep it handy while formatting.
You may need to download and install a .pdf reader. You can get one free from Adobe® here.
About This Document
This document is written to explain the formatting rules we use to maintain consistency when formatting a single book that is distributed among many formatters, each of whom is working on different pages. This helps us all do formatting the same way, which in turn makes it easier for the post-processor to eventually combine all these pages into one e-book.
It is not intended as any kind of a general editorial or typesetting rulebook.
We've included in this document all the items that new users have asked about formatting. There is a separate set of Proofreading Guidelines. If you come across a situation and you do not find a reference in these guidelines, it is likely that it was handled in the proofreading rounds and so is not mentioned here. If you aren't sure, please ask about it in the Project Discussion.
If there are any items missing, or items that you consider should be done differently, or if something is vague, please let us know. If you come across an unfamiliar term in these guidelines, see the wiki jargon guide. This document is a work in progress. Help us to improve it by posting your suggested changes in the Documentation Forum in this thread.
Each Page is a Separate Unit
Since each project is distributed among many formatters, each of whom is working on different pages, there is no guarantee that you will see the next page of the project. With this in mind, be sure to open and close all markup tags on each page. This will make it easier for the post-processor to eventually combine all these pages into one e-book.
Project Comments
When you select a project for formatting, the Project Page is loaded. On this page there is a section called "Project Comments" containing information specific to that project (book). Read these before you start formatting pages! If the Project Manager wants you to format something in this book differently from the way specified in these Guidelines, that will be noted here. Instructions in the Project Comments override the rules in these Guidelines, so follow them. (This is also where the Project Manager may give you interesting tidbits of information about the author or the project.)
Please also read the Project Thread (discussion): The Project Manager may clarify project-specific guidelines here, and it is often used by volunteers to alert other volunteers to recurring issues within the project and how they can best be addressed. (See below.)
On the Project Page, the link 'Images, Pages Proofread, & Differences' allows you to see how other volunteers have made changes. This forum thread discusses different ways to use this information.
Forum/Discuss This Project
On the Project Page where you start formatting pages, on the line "Forum", there is a link titled "Discuss this Project" (if the discussion has already started), or "Start a discussion on this Project" (if it hasn't). Clicking on that link will take you to a thread in the projects forum dedicated to this specific project. That is the place to ask questions about this book, inform the Project Manager about problems, etc. Using this project forum thread is the recommended way to communicate with the Project Manager and other volunteers who are working on this book.
Fixing Errors on Previous Pages
The Project Page contains links to pages from this project that you have recently worked on. (If you haven't formatted any pages yet, no links will be shown.)
Pages listed under either "DONE" or "IN PROGRESS" are available to make corrections or to finish formatting. Just click on the link to the page. Thus, if you discover that you made a mistake on a page or marked something incorrectly, you can click on that page here and reopen it to fix the error.
You may also use the "Images, Pages Proofread, & Differences" or "Just My Pages" links on the Project Page. These pages will display an "Edit" link next to the pages you have worked on in the current round that can still be corrected.
For more detailed information, refer to either the Standard Proofreading Interface Help or the Enhanced Proofreading Interface Help, depending on which interface you are using.
Formatting at the Character Level:
Placement of Inline Formatting Markup
Inline formatting refers to markup such as <i> </i>, <b> </b>, <sc> </sc>, <f> </f>, or <g> </g>. Place punctuation outside the tags unless the markup is around an entire sentence or paragraph, or the punctuation is itself part of the phrase, title, or abbreviation that you are marking. If the formatting goes on for multiple paragraphs, put the markup around each paragraph.
The periods that mark an abbreviated word in the title of a journal such as Phil. Trans. are part of the title, so they are included within the tags, thus: <i>Phil. Trans.</i>.
Many typefaces found in older books used the same design for numbers in both regular text and italics or bold. For dates and similar phrases, format the entire phrase with one set of markup, rather than marking the words as italics (or bold) and not the numbers.
If there is a series/list of words or phrases (such as names, titles, etc.), mark each item of the list individually.
See the Tables section for handling markup in tables.
Examples:
| Original Image: | Correctly Formatted Text: |
|---|---|
| Enacted 4 July, 1776 | <i>Enacted 4 July, 1776</i> |
| It cost 9l. 4s. 1d. | It cost 9<i>l.</i> 4<i>s.</i> 1<i>d.</i> |
| God knows what she saw in me! I spoke in such an affected manner. |
<b>God knows what she saw in me!</b> I spoke in such an affected manner. |
| As in many other of these Studies, and | As in many other of these <i>Studies</i>, and |
| (Psychological Review, 1898, p. 160) | (<i>Psychological Review</i>, 1898, p. 160) |
| L. Robinson, art. "Ticklishness," | L. Robinson, art. "<sc>Ticklishness</sc>," |
| December 3, morning. 1323 Picadilly Circus |
/* <i>December 3, morning.</i> |
|
Volunteers may be tickled pink to read |
Volunteers may be tickled pink to read |
| “That's the idea!” exclaimed Tacks. | "<i>That's the idea!</i>" exclaimed Tacks. |
| The professor set the reading assignment for Erlebnis Geschichte Deutschland seit 1845. |
The professor set the reading assignment for <g>Erlebnis Geschichte Deutschland seit 1845</g>. |
Italics
Format italicized text with <i> inserted at the start and </i> inserted at the end of the italics. (Note the "/" in the closing tag.)
See also Placement of Inline Formatting Markup.
Bold Text
Format bold text (text printed in a heavier typeface) with <b> inserted before the bold text and </b> after it. (Note the "/" in the closing tag.)
See also Placement of Inline Formatting Markup and Chapter Headings.
Underlined Text
Format underlined text as Italics, with <i> and </i>. (Note the "/" in the closing tag.) Underlining was often used to indicate emphasis when the typesetter was unable to actually italicize the text, for example in a typewritten document.
See also Placement of Inline Formatting Markup.
Some Project Managers may specify in the Project Comments that underlined text be marked up with the <u> and </u> tags.
Spaced Out Text (gesperrt)
Format spaced out text with <g> inserted before the text and </g> after it. (Note the "/" in the closing tag.) Remove the extra spaces between letters in each word. This was a typesetting technique used for emphasis in some older books, especially in German.
See also Placement of Inline Formatting Markup and Chapter Headings.
Font Changes
Some Project Managers may request that you mark a change of font within a paragraph or line of normal text by inserting <f> before the change in font and </f> after it. (Note the "/" in the closing tag.) This markup may be used to identify a special font or other formatting that does not already have its own markup (such as italics and bold).
Possible uses of this markup include:
- antiqua (a variant of roman font) inside fraktur
- blackletter ("gothic" or "Old English" font) within a section of regular font
- smaller or larger font only if it is within a paragraph in regular font (for a whole paragraph in a different font or size, see the block quotation section)
- upright font inside of a paragraph of italicized text
The particular use or uses of this markup in a project will usually be spelled out in the Project Comments. Formatters should post in the Project Discussion if the markup appears to be needed and has not yet been requested.
See also Placement of Inline Formatting Markup.
Words in Small Capitals
The formatting is different for Mixed Case Small Caps and all small caps:
Format words that are printed in Mixed Small Caps as Mixed Upper and Lowercase. Format words that are printed in all small caps as ALL-CAPS. For both mixed case and all small caps, surround the text with <sc> and </sc> markup.
Headings (Chapter Headings, Section Headings, Captions, etc.) may appear to be in all small caps, but this is usually the result of a change in font size and should not be marked as small caps. The first word of a chapter that is in small caps should be changed to mixed case without the tags.
See also Placement of Inline Formatting Markup.
| Original Image: | Correctly Formatted Text: |
|---|---|
| This is Small Caps | <sc>This is Small Caps</sc> |
| You cannot be serious about aardvarks! | You cannot be serious about <sc>AARDVARKS</sc>! |
Words in All Capitals
Format words that are printed in all capital letters as all capital letters.
The exception to this is the first word of a chapter: many old books typeset the first word of these in all caps; this should be changed to upper and lower case, so "ONCE upon a time," becomes "Once upon a time,".
Font Size Changes
Normally we do not do anything to mark changes in font size. The exceptions to this are when it indicates a block quotation or when the font size changes within a single paragraph or line of text (see Font Changes).
Extra Spaces or Tabs Between Words
Extra spaces between words are common in OCR output. You generally don't need to bother removing these—that can be done automatically during post-processing. However, extra spaces around punctuation, em-dashes, quote marks, etc. do need to be removed when they separate the symbol from the word. In addition, within the /* */ markup that preserves spacing, be sure to remove any extra spaces since they will not be automatically removed later on.
Finally, if you find any tab characters in the text you should remove them.
Superscripts
Older books often abbreviated words as contractions, and printed them as superscripts. Format these by inserting a single caret (^) followed by the superscripted text. If the superscript continues for more than one character, then surround the text with curly braces { and } as well. For example:
| Original Image: |
|---|
| Genrl Washington defeated Ld Cornwall's army. |
| Correctly Formatted Text: |
| Gen^{rl} Washington defeated L^d Cornwall's army. |
If the superscript represents a footnote marker, then see the Footnotes section instead.
The Project Manager may specify in the Project Comments that superscripted text be marked differently.
Subscripts
Subscripted text is often found in scientific works, but is not common in other material. Format subscripted text by inserting an underline character _ and surrounding the text with curly braces { and }. For example:
| Original Image: |
|---|
| H2O. |
| Correctly Formatted Text: |
| H_{2}O. |
Page References "See p. 123"
Format page number references within the text such as (see p. 123) as they appear in the image.
Check the Project Comments to see if the Project Manager has special requirements for page references.
Formatting at the Paragraph Level:
Chapter Headings
Format chapter headings as they appear in the image. A chapter heading may start a bit farther down the page than the page header and won't have a page number on the same line. Chapter Headings are often printed all caps; if so, keep them as all caps. Mark any italics or mixed case small caps that appear in the image.
Put 4 blank lines before the "CHAPTER XXX". Include these blank lines even if the chapter starts on a new page; there are no 'pages' in an e-book, so the blank lines are needed. Then separate with a blank line each additional part of the chapter heading, such as a chapter description, opening quote, etc., and finally leave two blank lines before the start of the text of the chapter.
Old books often printed the first word or two of every chapter in all caps or small caps; change these to upper and lower case (first letter only capitalized).
While chapter headings may appear to be bold or spaced out, these are usually the result of font or font size changes and should not be marked. The extra blank lines separate the heading, so do not mark the font change as well. See the first example below.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
|
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
/# |
Section Headings
Some books have sections within chapters. Format these headings as they appear in the image. Leave 2 blanks lines before the heading and one after, unless the Project Manager has requested otherwise. If you are not sure if a heading indicates a chapter or a section, post a question in the Project Discussion, noting the page number.
Mark any italics or mixed case small caps that appear in the image. While section headings may appear to be bold or spaced out, these are usually the result of font or font size changes and should not be marked. The extra blank lines separate the heading, so do not mark the font change as well.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
and numerous, found in collections of well-authenticated |
Other Major Divisions in Texts
Major Divisions in the text such as Preface, Foreword, Table of Contents, Introduction, Prologue, Epilogue, Appendix, References, Conclusion, Glossary, Summary, Acknowledgements, Bibliography, etc., should be formatted in the same way as Chapter Headings, i.e. 4 blank lines before the heading and 2 blank lines before the start of the text.
Paragraph Spacing/Indenting
Put a blank line before the start of a paragraph, even if it starts at the top of a page. You should not indent the start of the paragraph, but if it is already indented don't bother removing those spaces—that can be done automatically during post-processing.
See the Chapter Headings image/text for an example.
Thought Breaks (Extra Spacing/Decoration Between Paragraphs)
In the image, most paragraphs start on the line immediately after the end of the previous one. Sometimes two paragraphs are separated to indicate a "thought break." A thought break may take the form of a line of stars, hyphens, or some other character, a plain or floridly decorated horizontal line, a simple decoration, or even just an extra blank line or two.
A thought break may represent a change of scene or subject, a lapse in time, or a bit of suspense. This is intended by the author, so we preserve it by putting a blank line, <tb>, and then another blank line.
Sometimes printers used decorative lines to mark the ends of chapters or sections. These are not thought breaks so they should not be marked with <tb>.
Please check the Project Comments as the Project Manager may request that additional information be retained in the thought break markup, such as <tb stars> for a row of stars.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
last week, but my dressmaker put me off, because she |
Illustrations
Text for an illustration should be surrounded by an illustration tag [Illustration: and ], with the caption text placed in between. Format the caption text as it is printed, preserving the line breaks, italics, etc. Text that could be (part of) a caption should be included, such as "See page 66" or a title within the bounds of the illustration.
If an illustration has no caption, add a tag [Illustration]. (Be sure to remove the colon and space before the ] in this case.)
If the illustration is in the middle of or at the side of a paragraph, move the illustration tag to before or after the paragraph and leave a blank line to separate them. Rejoin the paragraph by removing any blank lines left by doing so.
If there is no paragraph break on the page, mark the illustration tag with an * like so *[Illustration: (text of caption)], move it to the top of the page, and leave a blank line after it.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
[Illustration: Martha told him that he had always been her ideal and |
| Original Image: (Illustration in middle of paragraph) |
|---|
 |
| Correctly Formatted Text: |
|
such study are due to Italians. Several of these instruments |
Footnotes/Endnotes
Format footnotes by leaving the text of the footnote at the bottom of the page and placing a tag where it is referenced in the text. This means:
1. In the main text, the character that marks a footnote location should be surrounded with square brackets ([ and ]) and placed right next to the word being footnoted[1] or its punctuation mark,[2] as shown in the image and the two examples in this sentence. Footnote markers may be numbers, letters, or symbols. When footnotes are marked with a symbol or a series of symbols (*, †, ‡, §, etc.) we replace these with Capital letters in order (A, B, C, etc.).
2. At the bottom of the page, a footnote should be surrounded by a footnote tag [Footnote #: and ], with the footnote text placed in between and the footnote number or letter placed where the # is shown in the tag. Format the footnote text as it is printed, preserving the line breaks, italics, etc. Be sure to use the same tag in the footnote as you used in the text where the footnote was referenced. Place each footnote on a separate line in order of appearance, with a blank line before each one.
If a footnote is incomplete at the end of the page, leave it at the bottom of the page and just put an asterisk * where the footnote ends, like this: [Footnote 1: (text of footnote)]*. The * will bring it to the attention of the post-processor, who will eventually join the parts of the footnote together.
If a footnote started on a previous page, leave it at the bottom of the page and surround it with *[Footnote: (text of footnote)] (without any footnote number or marker). The * will bring it to the attention of the post-processor, who will eventually join the parts of the footnote together.
If a continued footnote ends or starts on a hyphenated word, mark both the footnote
and the word with *, thus:
[Footnote 1: This footnote is continued and the last word in it is also con-*]*
for the leading fragment, and
*[Footnote: *tinued onto the next page.].
Do not include any horizontal lines separating the footnotes from the main text.
Endnotes are just footnotes that have been located together at the end of a chapter or at the end of the book, instead of on the bottom of each page. These are formatted in the same manner as footnotes. Where you find an endnote reference in the text, just surround it with [ and ]. If you are formatting one of the pages with endnotes, surround the text of each note with [Footnote #: (text of endnote)], with the endnote text placed in between, and the endnote number or letter placed where the # is. Put a blank line before each endnote so that they remain separate paragraphs when the text is rewrapped during post-processing.
Footnotes in Tables should remain where they are in the original image.
| Original Image: |
|---|
|
The principal persons involved in this argument were Caesar*, former military * Gaius Julius Caesar. |
| Correctly Formatted Text: |
|
The principal persons involved in this argument were Caesar[A], former military |
| Original Footnoted Poetry: |
|---|
|
Mary had a little lamb1 1 This lamb was obviously of the Hampshire breed,
well known for the pure whiteness of their wool. |
| Correctly Formatted Text: |
|
/* |
Paragraph Side-Descriptions (Sidenotes)
Some books will have short descriptions of the paragraph along the side of the text. These are called sidenotes. Move sidenotes to just above the paragraph that they belong to. A sidenote should be surrounded by a sidenote tag [Sidenote: and ], with the text of the sidenote placed in between. Format the sidenote text as it is printed, preserving the line breaks, italics, etc. (while handling end-of-line hyphenation and dashes normally). Leave a blank line before and after the sidenote to separate it from the normal text.
If there are multiple sidenotes for a single paragraph, put them one after another at the start of the paragraph. Leave a blank line separating each of them.
If the paragraph began on a previous page, put the sidenote at the top of the page and mark it with * so that the post-processor can see that it belongs on the previous page, like this: *[Sidenote: (text of sidenote)]. The post-processor will move it to the appropriate place.
Sometimes a Project Manager will request that you put sidenotes next to the sentence they apply to, rather than at the top or bottom of the paragraph. In this case, don't separate them out with blank lines.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
*[Sidenote: Burning |
Placement of Out-of-Line Formatting Markup
Out-of-line formatting refers to the /# #/ and /* */ markup tags. The /# #/ "rewrap" markup indicates text that is printed differently, but can still be rewrapped during post-processing. The /* */ "no-wrap" markup indicates text that should not be rewrapped later on during post-processing—where the line breaks, indentation, and spacing need to be preserved.
On any page where you use an opening marker, be sure to include the closing markup tag as well. After the text is rewrapped during post-processing, each marker will be removed along with the entire line that it is on. Because of this, leave a blank line between the regular text and the opening marker, and similarly leave a blank line between the closing marker and the regular text.
Block Quotations
Block quotations are blocks of text (typically several lines and sometimes several pages) that are distinguished from the surrounding text by wider margins, a smaller font size, different indentation, or other means. Surround block quotations with /# and #/ markers. See Placement of Out-of-Line Formatting Markup for details on this markup.
Apart from adding the markers, block quotations should be formatted as any other text.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
later day was welcomed in their home on the Hudson. |
Lists of Items
Surround lists with /* and */ markers. See Placement of Out-of-Line Formatting Markup for details on this markup.
| Original Image: |
|---|
Andersen, Hans Christian Daguerre, Louis J. M. Melville, Herman Bach, Johann Sebastian Darwin, Charles Newton, Isaac Balboa, Vasco Nunez de Descartes, René Pasteur, Louis Bierce, Ambrose Earhart, Amelia Poe, Edgar Allan Carroll, Lewis Einstein, Albert Ponce de Leon, Juan Churchill, Winston Freud, Sigmund Pulitzer, Joseph Columbus, Christopher Lewis, Sinclair Shakespeare, William Curie, Marie Magellan, Ferdinand Tesla, Nikola |
| Correctly Formatted Text: |
|
/* |
Tables
Surround tables with /* and */ markers. See Placement of Out-of-Line Formatting Markup for details on this markup. Format the table with spaces (not tabs) to look approximately like the original table. Try to avoid overly wide tables where possible; generally under 75 characters wide is best.
Do not use tabs for formatting—use space characters only. Tab characters will line up differently between computers, and your careful formatting will not always display the same way. Remove any periods or other punctuation (leaders) used to align the items.
If inline formatting (italics, bold, etc.) is needed in the table, mark up each table cell separately. When aligning the text, keep in mind that inline markup will appear differently in the final text version. For example, <i>italics markup</i> normally becomes _underscores_, and most other inline markup will be treated similarly. On the other hand, <sc>Small Caps Markup</sc> is removed completely.
It's often hard to format tables in plain text; just do your best. Be sure to use a mono-spaced font, such as DP Sans Mono or Courier. Remember that the goal is to preserve the Author's meaning, while producing a readable table in an e-book. Sometimes this requires sacrificing the original format of the table on the printed page. Check the Project Comments and discussion thread because other volunteers may have settled on a specific format. If there is nothing there, you might find something useful in the Gallery of Table Layouts forum thread.
Footnotes in tables should remain where they are in the image. See footnotes for details.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
TABLE II.
/*
-----------------------+----+-----++-------------------------+----+------
| C | || | C |
Flat strips compared | o | || | o |
with round wire 30 cm. | p |Iron.|| Parallel wires 30 cm. | p | Iron.
in length. | p | || in length. | p |
| e | || | e |
| r | || | r |
| . | || | . |
-----------------------+----+-----++-------------------------+----+------
Wire 1 mm. diameter | 20 | 100 || Wire 1 mm. diameter | 20 | 100
-----------------------+----+-----++-------------------------+----+------
STRIPS. | | || SINGLE WIRE. | |
0.25 mm. thick, 2 mm. | | || | |
wide | 15 | 35 || 0.25 mm. diameter | 16 | 48
Same, 5 mm. wide | 13 | 20 || Two similar wires | 12 | 30
" 10 " " | 11 | 15 || Four " " | 9 | 18
" 20 " " | 10 | 14 || Eight " " | 8 | 10
" 40 " " | 9 | 13 || Sixteen " " | 7 | 6
Same strip rolled up in| | || Same, 16 wires bound | |
the form of wire | 17 | 15 || close together | 18 | 12
-----------------------+----+-----++-------------------------+----+------
*/
|
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
/*
<i>Agents.</i> <i>Objects.</i>
{ 1st person, I, me,
{ 2d " thou, thee,
<i>Singular</i> { 3d " mas. { he, him,
{ " fem. { she, her,
{ it, it.
{ 1st person, we, us,
<i>Plural</i> { 2d " ye, or you, you,
{ 3d " they, them,
who, whom.
*/
|
Poetry/Epigrams
Mark poetry or epigrams with /* and */ so that the line breaks and spacing will be preserved. See Placement of Out-of-Line Formatting Markup for details on this markup.
Preserve the relative indentation of the individual lines of the poem or epigram by adding 2, 4, 6 (or more) spaces in front of the indented lines to make them resemble the image. If the entire poem is centered on the printed page, don't try to center the lines of poetry during formatting. Move the lines to the left margin, and preserve the relative indentation of the lines.
When a line of verse is too long for the printed page, many books wrap the continuation onto the next printed line and place a wide indentation in front of it. These continuation lines should be rejoined with the line above. Continuation lines usually start with a lower case letter. They will appear randomly unlike normal indentation, which occurs at regular intervals in the meter of the poem.
If a row of dots appears in a poem, treat this as a thought break.
Line Numbers in poetry should be kept.
Check the Project Comments for the specific project you are formatting. Books of poetry often have special instructions from the Project Manager. Many times, you won't have to follow all these formatting guidelines for a book that is mostly or entirely poetry.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
to the scenery of his own country: |
Line Numbers
Line numbers are common in books of poetry, and usually appear near the margin every fifth or tenth line. Keep line numbers, placing them at least six spaces past the right hand end of the line, even if they are on the left side of the poetry/text in the original image. Since poetry will not be rewrapped in the e-book version, the line numbers will be useful to readers.
Letters/Correspondence
Format letters and correspondence as you would paragraphs. Put a blank line before the start of the letter; do not duplicate any indenting.
Surround consecutive heading or footer lines (such as addresses, date blocks, salutations, or signatures) with /* and */ markers. See Placement of Out-of-Line Formatting Markup for details on this markup.
Don't indent the heading or footer lines, even if they are indented or right justified in the image—just put them at the left margin. The post-processor will format them as needed.
If the correspondence is printed differently than the main text, see Block Quotations.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
<i>John James Audubon to Claude François Rozier</i> |
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
/# |
Right-aligned Text
Surround lines of right-justified text with /* and */ markers. See Placement of Out-of-Line Formatting Markup for details on this markup, and the Letters/Correspondence section for examples.
Formatting at the Page Level:
Blank Page
Format as [Blank Page] if both the text and the image are blank.
If there is text in the formatting text area and a blank image, or if there is text in the image but none in the text box, follow the directions for a Bad Image or Bad Text.
Front/Back Title Page
Format all the text just as it was printed on the page, whether all capitals, upper and lower case, etc., including the years of publication or copyright.
Older books often show the first letter as a large ornate graphic—format this as just the letter.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
/* |
Table of Contents
Format the Table of Contents just as it is printed in the book, whether all capitals, upper and lower case, etc. and surround it with /* and */. See Placement of Out-of-Line Formatting Markup for details on this markup.
Page number references should be placed at least six spaces past the end of the text. Remove any periods or other punctuation (leaders) used to align the page numbers.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
|
Indexes
Surround the index with /* and */ tags. See Placement of Out-of-Line Formatting Markup for details on this markup. You don't need to align the numbers as they appear in the image; just put a comma followed by the page numbers.
Indexes are often printed in 2 columns; this narrower space can cause entries to split onto the next line. Rejoin these back onto a single line. This may create long lines, but they will be rewrapped to the proper width and indentation during post-processing.
Place one blank line before each entry in the index. For sub-topic listings (often separated by a semicolon ;), start each one on a new line, indented 2 spaces.
Treat each new section in an index (A, B, C...) the same as a section heading by placing 2 blank lines before it.
Old books sometimes printed the first word of each section in the index in all caps or small caps; change this to match the style used for the rest of the index entries.
Please check the Project Comments as the Project Manager may request different formatting, such as treating the index like a Table of Contents instead.
| Original Image: |
|---|
|
Elizabeth I, her royal Majesty the |
| Correctly Formatted Text: |
|
|
| Original Image: |
|---|
|
Hooker, Jos., maj. gen. U. S. V., 345; assigned |
| Correctly Formatted Text: |
|
|
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
|
Plays: Actor Names/Stage Directions
For all plays:
- Format cast listings (Dramatis Personæ) as lists.
- Treat each new Act the same as a chapter heading by placing 4 blank lines before it and 2 after.
- Treat each new Scene the same as a section heading by placing 2 blank lines before it.
- In dialog, treat a change in speaker as a new paragraph, with one blank line before it. If the speaker's name is on its own line, treat that as a separate paragraph as well.
- Format actor names as they are in the original image, whether they are italics, bold, or all capital letters.
- Stage directions are formatted as they are in the original image,
so if the stage direction is on a line by itself, format it that way; if it is at the end of a line of dialog, leave it there;
if it is right-justified at the end of a line of dialog, leave at least six spaces between the dialog and the stage directions.
Stage directions often begin with an opening bracket and omit the closing bracket. This convention is retained; do not close the brackets. Italics markup is generally placed inside the brackets.
For metrical plays (plays written as poetry):
- Many plays are metrical, and like poetry should not be rewrapped. Surround metered text with /* and */ as for poetry. If stage directions are on their own line, do not surround these with /* and */. (Since stage directions are not metrical, and can be safely rewrapped in the PP stage, they should not be contained within the /* */ tags that protect the metrical dialog.)
- Preserve relative indention of dialog as with poetry.
- Rejoin metrical lines that were split due to width restrictions of the paper, just as in poetry. If the continuation is only a word or so, it is often shown on the line above or below following a (, rather than having a line of its own. See the example.
Please check the Project Comments, as the Project Manager may specify different formatting.
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
/* |
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
/* |
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
[<i>Hernda has come from the grove and moves up to his side</i>] |
| Original Image: |
|---|
 |
| Correctly Formatted Text: |
|
/* |
Anything else that needs special handling or that you're unsure of
While formatting, if you encounter something that isn't covered in these guidelines that you think needs special handling or that you are not sure how to handle, post your question, noting the png (page) number, in the Project Discussion.
You should also put a note in the formatted text to explain to the next volunteer or post-processor what the problem or question is. Start your note with a square bracket and two asterisks [** and end it with another square bracket ]. This clearly separates it from the author's text and signals the post-processor to stop and carefully examine this part of the text and the matching image to address any issues. You may also want to identify which round you are working in just before the ] so that later volunteers know who left the note. Any comments put in by a previous volunteer must be left in place. See the next section for details.
Previous Volunteers' Notes/Comments
Any notes or comments put in by a previous volunteer must be left in place. You may add agreement or disagreement to the existing note but even if you know the answer, you absolutely must not remove the comment. If you have found a source which clarifies the problem, please cite it so the post-processor can also refer to it.
If you come across a note from a previous volunteer that you know the answer to, please take a moment and provide feedback to them by clicking on their name in the formatting interface and posting a private message to them explaining how to handle the situation in the future. Please, as already stated, do not remove the note.
Common Problems:
Bad Image
If an image is bad (not loading, mostly illegible, etc.), please post about this bad image in the project discussion.
Note that some page images are quite large, and it is common for your browser to have difficulty displaying them, especially if you have several windows open or are using an older computer. Try closing some of your windows and programs to see if that helps, or post in the project discussion to see if anyone else has the same problem.
Wrong Image for Text
If there is a wrong image for the text given, please post about this bad page in the project discussion.
Previous Proofreading or Formatting Mistakes
If a previous volunteer made a lot of mistakes or missed a lot of things, please take a moment and provide feedback to them by clicking on their name in the proofreading interface and posting a private message to them explaining how to handle the situation so that they will know how in the future.
Please be nice! Everyone here is a volunteer and presumably trying their best. The point of your feedback message should be to inform them of the correct way to format, rather than to criticize them. Give a specific example from their work showing what they did, and what they should have done.
If the previous volunteer did an outstanding job, you can also send them a message about that—especially if they were working on a particularly difficult page.
Printer Errors/Misspellings
Correct all of the words that the OCR has misread (scannos), but do not correct what may appear to you to be misspellings or printer errors that occur on the page image. Many of the older texts have words spelled differently from modern usage and we retain these older spellings, including any accented characters.
Place a note in the text next to a printer's erorr[**typo for error?]. If you are unsure whether it is actually an error, please also ask in the project discussion. If you do make a change, include a note describing what you changed: [**typo "erorr" fixed]. Include the two asterisks ** so the post-processor will notice it.
Factual Errors in Texts
Do not correct factual errors in the author's book. Many of the books we are preparing have statements of fact in them that we no longer accept as accurate. Leave them as the author wrote them. See Printer Errors/Misspellings for how to leave a note if you think the printed text is not what the author intended.
Alphabetical Index to the Guidelines
| Return to: Distributed Proofreaders home page, DP FAQ Central page, Project Gutenberg home page. |
