Editor's Companion - Help

Requirements

This utility makes heavy use of JavaScript. Your web browser must support JavaScript and have it enabled in order to make use of this program.

The Editor's Companion also makes optional use of cookies in order to safeguard your work. If the window is closed and reloaded (or just reloaded), the program will attempt to retrieve the work that was in progress. If cookies are disabled, this retrieval will fail, and your work will probably be lost.

It is also recommended to have your monitor resolution set no lower than 1024x768 pixels.

Offline Installation

If you choose to work offline, download the Editor Kit (only listed on the online version of the Editor's Companion) and any books that you'll be working on. Install all files into your Project Aon directory on your home computer as instructed on the Project Aon main website.

Navigation Controls

Track Page Changes

This option will update the current selection to reflect the page being viewed.

Correction Types

Errata (er)
Problems that appear in the original, printed books.
Non-errata (ne)
Problems that don't appear in the original, printed books. If a footnote is being discussed, use that designation instead.
Unknown (??)
Problems that have not been verified against the original in order to determine their status as errata or non-errata.
Footnote (ft)
A suggested footnote.

Auto Generated Correction Fields

Original or Description

This field has two purposes: to hold the original text of the error, and to hold a simple description of the problem. Read the Corrected entry for examples.

Corrected

The Correction field holds the corrected version of whatever was entered into the Original or Description field. If that field holds a simple description, this field should be left blank. Entering information such as that shown in Figure 1 will lead to a correction as shown in Figure 2.


Figure 1

Figure 2

Entering a simple description alone as in Figure 3 will generate the correction in Figure 4.


Figure 3

Figure 4

Comment

This field may contain any extra information or commentary that you feel is necessary to explain the situation. Entering a correction as in Figure 5 will genrate the correction shown in Figure 6. If you haven't yet entered your initials, you will be prompted for them the first time you enter a comment.


Figure 5

Figure 6

Check Page Consistency

If this box is checked, Editor's Companion will check to make sure that the page that you're viewing (which is probably the one on which you're commenting) matches the page selected. If they don't match, it will advise you of this and ask if you want to resolve the inconsistency before proceeding.

User Information and Submission

Full Name

Your first and last names (e.g. "Joe Dever") in the order that they would appear normally. This information is collected so that you can be cited on the book's Acknowledgements page. If you really don't want your name to appear there, put "anonymous" in this field and "xx" in the initials field.

Initials

The first letters of your first and last names (e.g. "jd" for "Joe Dever"). This is only used in the comment fields.

Email

Please double check this field before submitting. We will only use your email address to contact you with concerns about your submission, and will not retain or distribute it for any other purpose.

Corrections

The corrections field hold your corrections in a format that makes it easier to create tools to deal with programatically. Although they are autogenerated, you can edit them manually if you wish. The best way to learn the syntax is by using the autogeneration tool for a while and seeing into what form your correction is translated. The formal definition can be found below.

Submission

The corrections will be emailed to our staff. Please be sure that you have an active connection to the internet before submitting.

Correction Syntax

<correction>       ::= (<type>) <book>? <section>:
                       <correction-text>? <comment>*
<type>             ::= er | e | ne | n | ft | f | "??" | "?"
<book>             ::= 01fftd  | 02fotw  | 03tcok | 04tcod |
                       05sots  | 06tkot  | 07cd   | 08tjoh |
                       09tcof  | 10tdot  | 11tpot | 12tmod |
                       13tplor | 14tcok  | 15tdc  | 16tlov |
                       17tdoi  | 18dotd  | 19wb   | 20tcon |
                       21votm  | 22tbos  | 23mh   | 24rw   |
                       25totw  | 26tfobm | 27v    | 28thos |
                       01gstw  | 02tfc   | 03btng | 04wotw |
                       01hh    | 02smr   | 03oz   | 04cc   |
                       tmc     | rh
<section>          ::= <section-number> | <xml-id>
<correction-text>  ::= <original> "->" <corrected> |
                       <natural-language-description>
<comment>          ::= "[" <initials-notation>?
                       <natural-language-comment> "]"
<initals-notation> ::= <initals> ":"