Process

Proofreading your online file

Proofreading your online file

Once you have your file in PinPoint, you must review it.

Repeatedly adjust the document`s element structure (exporting and viewing the results) until the online document satisfactorily matches the hard copy.

The following list details several items that you need to check:

Excessive vertical spacing in code examples Use only soft returns (SHIFT-RETURN) in <ExampleBlockVerbatim> elements.
Excessive occurrences of the string Example (resulting from use of the <ExampleBlock> element) Use the <ExampleBlock> element sparingly.
Cross-references
- Extra text appearing in cross-references
- Cross-references replaced with question marks
- Missing cross-references
See the "Cross-references" section.
Figures
- Is the numbering consecutive in the TOC's List of Figures?
  The figure numbering will not be consecutive if there are figures that do not have captions.
- Are figures being used for screen captures when code examples are sufficient?
  Replace the figures with code examples.
- Are there any vector figures?
  Use bitmaps for all figures.
  See the "Converting figures" section.
- Are the rectangles around the perimeters of the figures present when the Main view shows figures inline?
  Be sure to capture the entire rectangle when you take the snapshots.
Improperly indented definition lists
Investigate the structure of the Frame file.
Miswrapped lists
Investigate the structure of the Frame file.
Missing line breaks
Investigate the structure of the Frame file.
Strings not wrapped in <Voice...> elements
Wrap the strings as needed.
Tables
- Is the numbering consecutive in the TOC's List of Tables?
  The table numbering will not be consecutive if hidden tables are not wrapped properly or if visible tables have no captions.
  See the "Tables" section.
- Only the first row of each table should be bold (assuming the table design does not require other rows to be bold).
  See the "Tables" section.
If you have items you want to be included in this checklist, contact scox@convex.com.

Previous Page | Next Page | Contents | Convex Press Home | Help
Please submit comments and questions about these pages to scox@convex.com