Post-Processing Verification Guidelines

From DPCanadaWiki

Jump to: navigation, search

Contents

General Procedures

  1. Make all the checks you would make on a project you are post-processing.
  2. Keep track of all errors and inconsistencies remaining in the project as well as any corrections you make.
  3. Send the PPer a feedback note describing the required changes, suggested amendments, the corrections you made, and providing helpful hints for future work.
  4. When the agreed-upon changes have been made, upload the project to PG.
  5. Submit a PPV Summary.

Requests to Revise and Resubmit

Give PPers the option to make corrections and amendments themselves or they may ask you to make the changes for them. If the PPer requests that they be allowed to make any necessary corrections and/or amendments, use the option on the project page to return the project to the PPer's queue, and send them an email or private message noting the items to be corrected, and/or making suggestions that may improve the project (specifying that these are not errors if that is the case). When complete, the PPer should reupload the project for PPV and notify the PPVer that the revised files are now available.

Sometimes a PPVer may decide to ask the PPer to revise and resubmit. This is an optional decision on the PPVer's part; it is not required. If you feel that the PPer would benefit from the experience of revising the project, ask the PPer to revise and resubmit, following these steps:

  1. Use the option on the project page to return the project to the PPer's queue.
  2. Send a private message or email to the PPer letting them know to expect the project to show up in their queue again, explaining the corrections that need to be made before re-uploading for PPV, and stating that if they do not wish/do not have time to revise, they can return the project to the PP queue so that someone else can work on it. Try to be as tactful and helpful as possible. Point them to posted projects to show them what the final product is supposed to look like. Provide links to relevant parts of the PP guidelines which they overlooked.

Specific Checks to Make

Check for the following types of errors, using tools you usually use for PPing:

Level 1 (minor errors)

  • Spellcheck errors
  • Scanno check errors
  • Comma/period error
  • Gutcheck-type errors such as, dashes, hyphens, punctuation, short/long lines, brackets, quotation marks, extraneous spaces, special characters (e.g. ~ * / _), non-Latin-1 and/or non-ASCII characters
  • Jeebies errors
  • Extraneous characters, such as ~ ` + = | \ » « < > / £
  • Ellipses not formatted consistently, or not formatted according to guidelines and/or not formatted as specified in project comments
  • Ligature inconsistency (e.g., using [oe] and oe in same project, or ae and æ in same project when page scan uses all æ)
  • Italic markup inconsistently placed relative to punctuation
  • Inconsistently spaced initials
  • TOC not complete, or formatted inconsistently, and/or TOC headings not matching text headings
  • Chapter heading inconsistency (# blank lines before/after; inconsistently centered or left-justified; inconsistently capitalized; period inconsistently missing at end of chapter heading or subheading)
  • Footnotes/footnote markers missing or out of order
  • Improper joining or separating of paragraphs at page break
  • Missing paragraph breaks within a page
  • Hyphenated/non-hyphenated variants not addressed
  • Hyphen/em dash confusion (i.e., hyphen used instead of em dash, or em dash used instead of hyphen)
  • Em dash incorrect length
  • HTML—title tag not filled in correctly
  • HTML—Tidy-reported issues have not been addressed as necessary**

Level 2 (major errors)

  • Text not rewrapped to required line length (usually 72 characters)
  • Rewrapping errors, e.g., rewrapped poetry
  • Poetry indentation not matching the original
  • Markup (e.g., italic markup, blockquote/poetry indentation) removed
  • Missing page(s)
  • Printers' errors not addressed***
  • Improper placement of pagenum markup, if a TOC or index in the project uses page numbers (otherwise, placement of pagenum markup is not important)
  • HTML—invalid HTML (obviously not caused by a last-minute change to code)
  • HTML—invalid CSS
  • HTML—non-working links
  • HTML—filenames and folder names not in lowercase—(for a first project treat this as a Level 1 error)
  • HTML—images not in "images" directory
  • HTML—images not optimized (i.e., inappropriate file size and/or dimensions—see display dimensions and output format in the wiki)

Other errors (not counted toward rating)

  • HTML—Not removing unused css
  • A Thumbs.db file in the images folder
    • When using Tidy, use the report mode, but do not allow Tidy to alter your code; instead, look at the report and make changes to your code as necessary.
      • Printers' errors should be addressed in one, or a combination, of the following ways:
  1. Correct silently
  2. Correct and note corrections in Transcriber's Note
  3. Leave uncorrected, and note errors in Transcriber's Note

Anything that could make a reader think an error has been made in the transcription should be mentioned in the Transcriber's Note.

In the html, changes to the text may be documented by way of HTML comments or similar, and a note to that effect added to the transcriber's note.

"Not addressing printers' errors" means that all, or a large percentage, of printers' errors have been left uncorrected and not noted. If just one or two have been missed, and the rest addressed, then those missed would instead be counted as the relevant type of error (spellcheck, gutcheck, etc.)

Submitting a PPV Summary

Using the link on the project page, submit a PPV Summary for the project, using the following criteria for determining project difficulty and rating of PPer's work:

Determining whether a project is Easy, Average, or Difficult

Easy Project:

  • Straight fiction with little or no poetry
  • Straight poetry
  • Other straight text, e.g., essay
  • Can include some illustration markup
  • Can include a few simple footnotes, blockquotes, etc.
  • No index
  • 100 or fewer gutcheck flags
  • 100 or fewer spellcheck flags

Average Project:

Can include up to 3 of the following kinds of content:

  • poetry other than straight poetry covered under "Easy Project"
  • blockquotes
  • footnotes
  • sidenotes
  • index
  • advertisements
  • tables
  • significant number of illustrations

AND:

  • 100-500 gutcheck flags, AND/OR
  • 100-500 distinct spellcheck flags—i.e. not including frequently repeated words

Difficult Project:

Includes significant amounts of more than 3 of the following kinds of content:

  • poetry other than straight poetry covered under "Easy Project"
  • blockquotes
  • footnotes
  • sidenotes
  • index
  • advertisements
  • tables
  • illustrations requiring advanced preparation and/or difficult placement

AND:

  • 500+ gutcheck flags, AND/OR
  • 500+ distinct spellcheck flags—i.e. not including frequently repeated words

and/or includes any of the following kinds of content:

  • multiple languages*
  • Englifh
  • musical notation/lilypond/midi files
  • extensive mathematical or chemical notation
  • LaTeX
  • How to define multiple languages:
  • If the book is English on one page and Latin on the facing page, it counts as multiple languages.
  • If the author is travelling and repeatedly reports conversations in the foreign language of the country, it counts as multiple languages.
  • If extensive (paragraph or more) quotations in a language other than the base language are present, it counts as multiple languages.
  • If the Frenchman in the novel says "Zut!" a lot, it does NOT count as multiple languages.

Determining Allowable Errors for Various Ratings

File size referred to below is based on the plain text version.

Errors such as failure to grasp the italics guidelines is counted as one error, not one error each time punctuation is wrongly placed. Errors such as he/be errors are each counted as individual errors (i.e. three he for be counts as three errors).

Excellent

  • No Level 2 errors
  • If project is:
    • Easy
      • Maximum of one Level 1 error per 300kb, (or 1 error if file size < 300kb)
    • Average
      • Maximum of one Level 1 error per 200kb, (or 1 error if file size < 200kb)
    • Difficult
      • Maximum of one Level 1 error per 100kb, (or 1 error if file size < 100kb)

Very Good

  • No Level 2 errors
  • If project is:
    • Easy
      • Maximum of one Level 1 error per 165kb, (or 1 error if file size < 165kb)
    • Average
      • Maximum of one Level 1 error per 100kb, (or 1 error if file size < 100kb)
    • Difficult
      • Maximum of one Level 1 error per 50kb, (or 1 error if file size < 50kb)

Good

  • May contain Level 2 errors
  • If project is:
    • Easy
      • More than one Level 1 error per 165kb, (or more than 1 error if file size < 165kb)
    • Average
      • More than one Level 1 error per 100kb, (or more than 1 error if file size < 100kb)
    • Difficult
      • More than one Level 1 error per 50kb, (or more than 1 error if file size < 50kb)

Fair

Fair rating should be assigned if it is felt that the project contains too many errors to be assigned a rating of Good.

Poor

Poor rating should be assigned at the PPVer's discretion if the project does not fit into one of the above categories.

Retrieved from "http://www.pgdpcanada.net/wiki/index.php/Post-Processing_Verification_Guidelines"
Personal tools