Guiguts 0.2 PP Process Checklist

From DPWiki
Jump to navigation Jump to search


This checklist is made for use with Guiguts and refers to Guiguts commands and menu items. For versions 0.3 or later, see Guiguts PP Process Checklist

It contains steps for all types of books including those with illustrations, poetry, footnotes, sidenotes and indexes; and it assumes you will create an HTML version. Not all projects need all steps. As you gain experience you may decide to do things in a different sequence.

(When editing this page, please use links to other wiki topics rather than repeating things covered elsewhere.)

1. Initial Setup (1 hr.)

  • Go to Project page
    • Read details and requirements.
    • bookmark the project URL and note project ID number.
    • read the project forum page, note any issues proofers raised.
  • Make a project folder, e.g. (Win) C:\dp\pp\bookname or (Mac/Linux) /dp/pp/bookname
  • Download the text and images files and unpack in new folder:
    • Text to bookname.txt.
    • page images (nnn.png) in subfolder pngs
    • hi-res illustration scans (imagenn.png) in subfolder originals
    • empty subfolder images.

2. Sequential Inspection of Text (4-20 hr.)

This is the only step in which you will examine the whole ASCII text in sequence; hereafter you navigate with searches. Some post-proofers still read the book carefully, although this is not as crucial as it used to be under the old two-round system. Others skim the text comparing it to the page images and double-checking format.

Either way, be sure to turn on automatic scanno highlighting before starting during this pass.

Check for:

  • Proper markup of <i>italic</i> and <b>bold</b>.
Watch for punctuation wrongly contained in markups, such as <i>(ibid.</i> or <b>Subtopic.</b>.
  • Proper markup of Greek and other transliterations (content check later)
  • Block material all marked in some fashion:
    • poetry, misc. tabular in /* */
    • block quotes in /# #/
    • Fix block markups that cross page boundaries now or in the next step
  • Figures properly in [Illustration: caption]
    • check: caption text agrees with List of Illustrations (if any)
    • consistent spelling, abbreviation, capitalization in captions
  • Fix Footnotes, Illustrations still inside a paragraph.
    • move outside paragraph to next or prior page as appropriate
    • don't worry about duplicate footnote number/symbol now
    • sidenotes handled later
  • Make notes of things that will need attention in the HTML:
    • Author cross-references like "(p. 150)" and "see page 222" that should become links.
    • How the editor laid out special sections such as tables and sidebars.

3. Fix Block Markups and Proofer Notes (15-60 min.)

  • Use the Search menu to step through all /* */ blocks.
    • check for a blank line before and after markup
    • make sure correct type of markup used
    • close-up where broken at page boundaries
    • apply specific indent value if desired
    • convert poetry from /*..*/ to /P..P/
    • make sure poetry line numbers are at least two spaces to the right of the line.
  • Use the Search menu to step through all /#..#/ blocks
    • check for a blank line before and after markup
    • make sure correct type of markup used
    • close-up where broken at page boundaries
    • check consistent indentation of block text
    • apply specific margin values if desired
  • Use Orphaned Markup dialog to check and correct orphans of each type in turn. Do not omit the lowly parenthesis, often mis-scanned as curly-brace.
  • Search&Replace: text: (?<!/)\*(?!/) (a literal asterisk, but one neither preceded nor followed by a slash), regex; keep clicking "Search" to check all asterisks in document.
    • look for malformed thought-breaks (5 stars)
    • resolve proofer's notes, which are indicated by asterisk

4. Basic Fixup (10 min.)

5. Format Front Matter (15 min.)

  • Format the title page, preserving as much of the original material as possible. Protect in /X...X/ (no rewrap, no indent) or /F...F/ (the same, except that it will be centered in the html version).
  • Edit the TOC. Find each matching chapter head; make sure heads are 1:1 with TOC. Protect TOC with /X...X/.
  • If book has illustrations, edit or create List of Illustrations (Note: this is not a requirement). Make sure it is 1:1 with [Illustration] captions. Protect with /X...X/.

6. Edit Transliterations (0-? hr.)

  • Search&Replace: text: \[[^FIS] (left-bracket followed by anything other than F, I or S), regex. Check content of each transliteration. For Greek, use the Greek Transliteration Tool.

7. Remove Visible Page Breaks (10-30 min.)

8. Apply Word-Frequency Checks (10-60 min.)

Open the Word Frequency report.

  • Set the Frq switch; click All Words. List is now sorted by word frequency; scroll to the end and skim up the list of words that only appear 1 time looking for oddities and obvious misspellings.
  • Click Character Cnts.
    • Note characters that appear only once, check usage.
    • Check for equal counts of left & right parens and brackets.
  • Set the Alph switch; click All Words. Scroll to the word Footnote and write down count for later use. (If the count is large, click once on Footnote and click 1st Harm. The harmonic window shows you any of the common misspellings of "Footnote" that occur.)
  • Click Emdashes. This shows words with emdashes in them as well as similar words without emdashes (aka: suspects) marked with ****. Check suspects against the text and page images. Preserve author's intent even when inconsistent. Hint: Enable the Suspects flag and click Emdashes again to see only suspects words.
  • Click Hyphens. Same as Emdashes above but for Hyphens.
  • Click Alpha/num. Scan list for one/ell and oh/zero errors.
  • Click ALL CAPS. Scan list looking for oddities.
  • Click MiXeD CasE. Scan list looking for letters such as o that sometimes OCR wrongly as uppercase. Oh/zero errors can show up here, too.
  • Click Check Accents. Scan list looking for mistakes, inconsistent usages.
  • Click Check , Upper. Scan list for comma-for-period errors.
  • Click Check . Lower. Scan list for period-for-comma errors.

9. Apply Scanno Checks (1-3 hr.)

See this topic for usage of the scanno checks.

  • If you have installed Jeebies, use Fixup> Run Jeebies and examine its report of possible he/be errors.
  • Start scanno searching based on eng-common.rc. Work through the list.
  • Apply scanno searching based on misspelled.rc. Work through the list.
  • Apply scanno searching based on regex.rc. Work through the list.

10. Apply Gutcheck (10-45 min.)

Start the Gutcheck Process.

  • Work through the list, correcting as appropriate.

11. Apply Spellcheck (30-90 min.)

Start the spellcheck process.

  • Proceed through the document, correcting words or adding them to the project dictionary as appropriate.

12. Fix Sidenotes (0-? hr.)

Read the discussion. Step through sidenotes with: Search&Replace of [S, not regex, not whole word, ignore case. Click Search to find each Sidenote.

  • Compare to page image. Move note above paragraph if feasible.
  • Otherwise, position it above the sentence to which it applies, with blank lines to prevent rewrapping if you decide that is best.

13. Fix Footnotes (0-? hr.)

Read the discussion and follow the steps on this page.

14. Fix Poetry Line Numbers (0-20 min.)

If the book has poetry that uses line numbers, read this page and align the line numbers consistently.

15. Check balanced markup

Search&Replace for \<(\w+)>\n?[^<]+<(?!/\1>) (any starting markup in <..> that doesn't end in an identical closing markup). (Note: this regular expression sees <tb> as unbalanced, and shows the text from the <tb> to the next markup as an error. If you can devise a better regex please do!) Because it includes a newline, the search may take several seconds to return the first result.

  • Correct the error and click search until no more are found.

16. Save Edited Markup (2 min.)

  • Save any unsaved changes in bookname.txt.
  • Use File>Save As to make bookname.html
This will be the starting file for the HTML version. You can also use it as fallback in case you mess up and need to start the following steps over.
  • Re-open bookname.txt.


17. Convert <tb>, Italic, Bold, and Smallcap (10 min.)

These steps are for the text document; HTML treated below.

  • Fix <tb> markup for the text version: In the Text Processing menu, select "Convert <tb> to asterisk break" which converts all in one step. (Note: you may not see the Text Processing menu if you do not have the latest version.)
    • Interactive replace: menu/Search -> Search & Replace to replace interactively: Search field, <tb>; Replace field,
             *       *       *       *       *
      . Use Search and Replace buttons to step through mark up; Rpl All if happy with the operation.
  • Fix italics: In the Text Processing menu, select "Convert Italics." Italic markup is replaced with underscores.
    • Interactive: Same as <tb>: Search field, </?i>; Replace, _. Set Regex checkbox.
  • Fix bold. Decide if you want to mark bold with =, or $, or by all uppercase.
    • For = or $, in the Text Processing menu select Options and set the appropriate character; then select Text Processing > Convert Bold.
    • Interactive: As for italics: Search, </?b>, Replace, =, $ or preferred character.
    • For uppercase, use a regex search for <b>(\n?[^<]+)</b> (<b> then anything including newline up to the first </b>). Replacement: \U$1\E.
Click Search, then Replace until you are confident it works; then Replace All. Afterward, search for b> and hand-edit any remaining bold.
  • Uppercase selected small-cap, which proofers have changed to <sc>Title-Cased-Text</sc>.

PG guidelines say that where only an opening word or phrase of a section is small-capped, it should be left as title case. Some works have whole headings small-cap; some have used small-cap as a means of emphasis. These should be uppercased in the text. To handle either case: regex find <sc>(\n?[^<]+)</sc> (<sc> then anything including newlines up to </sc>; note this will not find small-cap that spans other markup such as italic.) Replacement 1: \U$1\E Replacement 2: $1 alone. Click Search and evaluate the usage: click R&S opposite replacement 1 to uppercase; click opposite replacement 2 to just remove the markup. After, search for sc> and hand-edit any remaining markup. More information can be found at Guide to smallcaps.

  • Save the document.

18. Fix ASCII Tables (0-? hr.)

  • Use Search>Find Next /**/ Block to step through all tabular material.
    • Compare to page image; reformat to best convey author intent.
    • For complex tables, use Table Special Effects to reformat.

19. Rewrap and Clear Rewrap Markers (10-30 min.)

  • Save the file if any unsaved changes.
  • Use Edit>Select All then Selection>Rewrap Selection. Wait while rewrap completes.
  • Page through entire text, looking for improper indentation. If found, re-open, clicking NO when asked if you want to save the edits. Find and fix broken rewrap markups. Repeat this step.
  • Open Fixup>Footnote Fixup; tidy up footnotes. See this discussion.
  • Remove all rewrap markers: see this page.
  • Use Fixup>Remove End-of-line Spaces.
  • Use Fixup>Run Gutcheck and resolve any new issues.
  • Save the document.

20. Determine Character Coding (5-60 min.)

Character codes are described here. You need to understand the coding your etext uses.

First, apply Fixup > Convert Windows CP 1252 characters to Unicode. This gets rid of any Windows-unique characters but may insert Unicode characters in their place.

Search with the regex \P{IsASCII} (note uppercase P). If nothing is found, the book now contains only characters from the 7-bit ASCII set and you are done.

If 8-bit characters are found, you must take action. First apply Fixup> Run Word Frequency Routine. In the report window, click the Unicode>FF button. Words containing a multi-byte (Unicode) character are listed. If none are shown, the text is probably, but not certainly, Latin-1; at any rate Unicode characters are confined to non-word punctuation.

If your text has symbols from Latin-1 or Unicode, read or re-read this item of the Gutenberg FAQ. This section and this one in DP's post-processing FAQ have additional information about characters sets and when to make more than one text version. Decide if you will upload a single version or if you should do the division into ASCII and high-bit versions. If you will do it, then:

  • Use File>Save As to "fork" your single document into versions:
bookname-asc for a pure-ASCII version;
bookname-lt1 for a version with Latin-1 accented characters;
and/or bookname-utf8 for a version that has Unicode characters.

Note that the "-asc" and so forth should not replace the normal .txt at the end of the file name. You will end up with files named bookname-utf8.txt, etc., under this naming scheme.

  • Open bookname-asc.
  • Search with the regex \P{IsASCII} (note uppercase P) to step through each character not 7-bit ASCII
  • Replace each, using some consistent substitution scheme (for example, ['e] for é, etc.).
  • Add a "Transcriber's Note" to the head of the text to document your substitution scheme.
  • In a similar manner, search bookname-lt1 for Unicode characters and replace them with Latin-1 equivalents. Add a "Transcriber's Note" to document the substitutions.

Pure-ASCII etext bookname-asc and optional Latin-1 bookname-lt1 and bookname-utf8 are ready to upload!

21. Prepare HTML Edition (4-? hr.)

  • Open bookname.html that was saved in step 16.
  • If you will insert visible page numbers or anchors at page boundaries, then configure the page labels before proceeding
  • Check the footnotes and move them to the Landing Zones you have decided on, as described in the PPTools/Guiguts/Footnotes.
  • It is preferable for the source line-breaks to match the book; however HTML poetry markup won't work unless /P..P/ sections have been rewrapped. If the book has much poetry, rewrap it all; else select and rewrap poetry sections individually.
  • Don't remove the rewrap markers. These are needed for generation of proper HTML.
  • Open the HTML Palette and set optional switches as desired.
  • Apply Automatic HTML conversion and wait while it completes.
  • Save the file and open it in a browser.
  • Scroll through looking for systematic errors. (Title pages, tables, etc. will look terrible; no matter). If automatic conversion messed up, delete the file and start this step over with the backup file.
  • Page through the book looking for text that was not handled well by automatic HTML generation, in particular:
    • Title pages.
    • Tables.
    • Tables of Contents and Indexes, which are best formatted using unsigned lists, rather than the markup Guiguts generates for /$..$/.
    • Illustrations.
  • Use the element-markup buttons in the HTML Palette to mark up these areas. Use regex replacements to make systematic changes.
  • Open the file in one or more web browsers (Internet Explorer and at least one other such as Firefox or Netscape). Page through the entire book.
    • Where you see a problem, make a correction in Guiguts, save the file, and click the "reload" button in each browser.
  • Hyperlink page references in text, TOC, and index (discussed here).
  • Decide what (if anything) you plan to do about non-Latin-1 characters in the document. You can use HTML escapes to insert any Unicode character. One high-runner is the oe-ligature, which is &oelig;. Greek works, too, but be aware that not everyone will have an extensive set of fonts loaded.
  • Use the "Find orphaned markup" button on the HTML Palette to find any mismatched html markup in the file.
    • Note: The search will stop on any nested spans, even though this is valid html. If this happens, you may want to make an extra copy of your file, remove any nested spans in it, and then check for orphaned html markup in that file in order to do a complete check. If you do find orphaned markup, be sure to go back and apply the changes to your original file!
  • Apply the Link Checker and correct all issues found.
  • Optionally, apply Tidy.
  • Open the WC3 Validator, upload the file, and correct the nits it picks. Be sure to use both the HTML and CSS validators.
  • Remove unused CSS, manually or using a tool such as the Firefox addons Firebug (with CSS Usage extension) or Dust-Me Selectors.

22. Process Hi-resolution Images (? hr.)

If the project manager provided high-resolution scans of the images in the text, use an image-processing program such as The Gimp or Adobe Photoshop Elements to optimize them—see the wiki topic. You can do this before, during, or after HTML conversion. For each image:

  • Load image from the originals folder (see step 1)
  • Straighten it (almost all scanned images are off-perpendicular; some are trapezoidal owing to the page not being flat on the scan window).
  • Crop it to remove all redundant white space and borders (provide margins and borders with CSS styling of the <img> markup).
  • Correct the contrast (you must have calibrated your monitor, see this page).
  • Sharpen.
  • Correct any major scratches, freckles, dirt, etc.
  • Save in the subfolder images using appropriate type:
    • Line drawings in .png at 8 bits per pixel (not the default 24-bit RGB format).
    • Photographs as .jpg with an appropriate compression level such as (Photoshop) level 6.
  • Page through entire HTML book making sure that each image is being loaded correctly. Test each thumbnail if used.

23. Upload the Finished Project

  • Prepare a new folder with a short name. The name you choose doesn't really matter because you only need it to create the zip file. The zip file itself is renamed automatically during the upload process.
  • Move into it only the files to be uploaded:
    • the etext file(s) bookname.asc, bookname.lt1, and/or bookname.utf.
    • the .bin files related to those (some PPVers use Guiguts too!)
    • the HTML file if one was made
    • the images folder if required by HTML
Do not include the original images or the page images; do not include any work files or scratch files or auto-backup editions. If you have been told to upload directly to the Gutenberg site for a whitewasher, do not include the .bin file(s). All filenames should contain lowercase letters only.
  • Mac OS X users: the Finder creates hidden files named .DS_Store in any folder you display as a window. Although harmless, these files are not wanted by PG. Get rid of them as follows: In a terminal window, cd into the project folder. Run this command, copying its arcane syntax precisely:
find . -name ".DS_Store" -ok rm '{}' \;

You will be asked for deletion confirmation.

  • Linux and Mac users: cd into this folder and use the command unix2dos *.txt; unix2dos *.html.
  • Use a zip utility to make a zip archive of this folder. (OS X users: do not use the Finder command File> Create Archive of...; it creates a gzip file that PG cannot use. Use a zip command in a terminal window.)
  • Windows users: The "images" folder will often contain a hidden file called thumbs.db. This shouldn't be included in the upload. The easiest way to get rid of it is to open the finished zip-file, navigate to the "images"-folder and delete it from there if present.
  • Open the project page in your web browser and at the bottom, select Change Project State: Upload for Verification.
  • On the next page, write comments noting any unusual features of the book.
Especially note the character code (7-bit, Latin-1, or Unicode) of the single .txt file, or the differences between multiple etext files.
  • use the Browse button to navigate to the zipped file. Wait while it uploads, which can take quite a while.

Ta-daaaa! Finished!! &#134; Treat yourself to your favorite beverage! When refreshed, return to Step 1.

&#134;Well, finished until you get the first PM from the PPVer listing the things you forgot to do...

Related Pages