Post by outspaced on Jun 9, 2004 9:18:24 GMT
This is a slightly revamped (widescreen, digitally remastered) and expanded version of a post made in the "A Head Start" thread some months ago. It contains a simple example of how to use the Project Aon Editor Companion. It would be advantageous for any editors or potential editors to re-/familiarise themselves with this information.
If you're going to start editing (editing being something of a misnomer as explained below), you really should acquaint yourself with the terrifying Project Aon Editor Companion
www.projectaon.org/editor/
As an editor, your job is to flag up problems, typos, rule problems, inconsistently italicised onomatopoeia, etc. But not to change anything! All changes are ultimately made by the XMLer, and all final rulings are made by the Project Coordinator. The Editor Companion is a tool that shows an editor what issues have been submitted to the project, but it also has various filters, based on type of error, whether the problem has already been fixed in the pre-release version, whether the problem has be ignored, etc. This is extremely useful, and I wish we'd had it a couple of years ago. (You will need a decent browser to view it, however. M$ Internet Explorer simply isn't web-compliant enough to view it properly. I would suggest Mozilla Firefox, though others prefer Opera.)
Once you understand the Editor, editing will become much simpler and easier. I'll make up an example:
Suppose you find that in LW13 there's a typo in Section 100. It reads:
That's obviously wrong. So you want to flag this up and suggest that it be changed. You select the book from the dropdown menu of the right-hand side of the editor (LW18+ isn't currently there; bear with me) and then select which section it is in, either from the second menu for the introductory and rules part of the book, or the actual section number in the box next to it. For this example, you type 100 into the Section Number box.
Then you select what type of error it is:
Let's suppose you don't own a copy of the UK version of the book. You have no way of checking against the original text to see whether this typo--Magnakal--is Errata or not. So you select Unknown as the Correction Type.
In the next box you type what the section currently says. You could just type the mis-spelling, but it will be easier for XMLers to find the problem if you type in some words around it. So you type in the first box:
In the box beneath this, you type in what you believe it should be:
Ignore the Issue # box. I'll explain what that's for below.
If you have any comments regarding this correction, you could add them to the Add Comments box. For this example we don't, so we leave it blank.
Now click the Add Correction Button. This will auto-create the string of information to send to Project Aon. It will be as follows:
You can then fill in your name, initials, e-mail address, and post the error to Project Aon. However, it would be best to keep adding to the list until you are going to stop for the night, then post the corrections all in one go. This is easy since the Add Correction button adds subsequent corrections to the auto-generated corrections box; it does not overwrite them.
When the Editor Companion was first unveiled a few months ago, the following message was sent to the Mailing List members respecting the syntax of submitted edits:
So if you decide you don't like the Editor Companion, you could still submit the errors using the correct syntax. (Actually, you could submit the errors without worrying about the syntax stuff, but someone will go through your submissions and alter them to the correct syntax anyway, so you'll be saving someone an extra job if you can do it this way right from the start.)
If you're happy with the syntax, you could ignore the Editor Companion altogether. And for submitting problems with Books 18+ you can't currently use the Editor Companion anyway. So for example, when working on book 18 the syntax will be:
The Freeway Warrior titles are in the format:
If you want to add a comment to your submitted correction, you would put it at the end of the correction, enclosed within square brackets. For example, suppose you were querying something, you might want to state that you think this error occurs in several places.
The Issue # box is for when someone is replying to an issue. In the example above, the original editor didn't know what whether the error was Errata or not. Some days later, suppose someone is looking through the proposed changes (click the Changes button, bottom left) and sees this error. They look in their copy of LW13 and see that in the original text it reads 'Magnakai', so it's Not Errata. They set up the Editor Companion to LW13, Section 100, then they select which Issue Number they are responding to. In our example, there is only one problem with Section 100, so it would be issue 1. They then type into the 'comment' field on the right: "This is Not Errata". They then 'Add Correction' and submit the information to the Mailing List.
Intimidated? Scared? Quaking in your boots? Don't be--it's really much, much simpler than I've tried to explain it!
Apologies all round for writing the longest post in the world. My fingers hurt now.
If you're going to start editing (editing being something of a misnomer as explained below), you really should acquaint yourself with the terrifying Project Aon Editor Companion
www.projectaon.org/editor/
As an editor, your job is to flag up problems, typos, rule problems, inconsistently italicised onomatopoeia, etc. But not to change anything! All changes are ultimately made by the XMLer, and all final rulings are made by the Project Coordinator. The Editor Companion is a tool that shows an editor what issues have been submitted to the project, but it also has various filters, based on type of error, whether the problem has already been fixed in the pre-release version, whether the problem has be ignored, etc. This is extremely useful, and I wish we'd had it a couple of years ago. (You will need a decent browser to view it, however. M$ Internet Explorer simply isn't web-compliant enough to view it properly. I would suggest Mozilla Firefox, though others prefer Opera.)
Once you understand the Editor, editing will become much simpler and easier. I'll make up an example:
Suppose you find that in LW13 there's a typo in Section 100. It reads:
Your Magnakal Discipline of Huntmastery saves you from the bear.
That's obviously wrong. So you want to flag this up and suggest that it be changed. You select the book from the dropdown menu of the right-hand side of the editor (LW18+ isn't currently there; bear with me) and then select which section it is in, either from the second menu for the introductory and rules part of the book, or the actual section number in the box next to it. For this example, you type 100 into the Section Number box.
Then you select what type of error it is:
- (1) Errata - an error that occurs in the original (UK) printing of the book.
- (2) Not Errata - an error that has crept in via OCR and proofreading
- (3) Unknown - Unsure what type of correction it is.
- (4) Footnote - you are motioning for a footnote to be included in this section
Let's suppose you don't own a copy of the UK version of the book. You have no way of checking against the original text to see whether this typo--Magnakal--is Errata or not. So you select Unknown as the Correction Type.
In the next box you type what the section currently says. You could just type the mis-spelling, but it will be easier for XMLers to find the problem if you type in some words around it. So you type in the first box:
Your Magnakal Discipline of Huntmastery
In the box beneath this, you type in what you believe it should be:
Your Magnakai Discipline of Huntmastery
Ignore the Issue # box. I'll explain what that's for below.
If you have any comments regarding this correction, you could add them to the Add Comments box. For this example we don't, so we leave it blank.
Now click the Add Correction Button. This will auto-create the string of information to send to Project Aon. It will be as follows:
(??) 13tplor 100: Your Magnakal Discipline of Huntmastery -> Your Magnakai Discipline of Huntmastery
[/b]You can then fill in your name, initials, e-mail address, and post the error to Project Aon. However, it would be best to keep adding to the list until you are going to stop for the night, then post the corrections all in one go. This is easy since the Add Correction button adds subsequent corrections to the auto-generated corrections box; it does not overwrite them.
When the Editor Companion was first unveiled a few months ago, the following message was sent to the Mailing List members respecting the syntax of submitted edits:
<correction> ::= (<type> ) <section>: <correction>? <comment>*
<type> ::= er | e | ne | n | ft | f | "??" | "?"
<section> ::= <section-number> | <xml-id>
<correction> ::= <original> "->" <corrected> | <natural-language-description>
<comment> ::= "[" <initials-notation>? <natural-language-comment> "]"
<initals-dec> ::= <initals> ":"
<type> ::= er | e | ne | n | ft | f | "??" | "?"
<section> ::= <section-number> | <xml-id>
<correction> ::= <original> "->" <corrected> | <natural-language-description>
<comment> ::= "[" <initials-notation>? <natural-language-comment> "]"
<initals-dec> ::= <initals> ":"
So if you decide you don't like the Editor Companion, you could still submit the errors using the correct syntax. (Actually, you could submit the errors without worrying about the syntax stuff, but someone will go through your submissions and alter them to the correct syntax anyway, so you'll be saving someone an extra job if you can do it this way right from the start.)
If you're happy with the syntax, you could ignore the Editor Companion altogether. And for submitting problems with Books 18+ you can't currently use the Editor Companion anyway. So for example, when working on book 18 the syntax will be:
({type}) 18dotd {section}: {error} -> {suggested fix}
The Freeway Warrior titles are in the format:
01hh, 02smr, 03oz, 04cc
[/center]If you want to add a comment to your submitted correction, you would put it at the end of the correction, enclosed within square brackets. For example, suppose you were querying something, you might want to state that you think this error occurs in several places.
({type}) 18dotd {section}: {error} -> {suggested fix} [{Your Initials}: {your comment}]
The Issue # box is for when someone is replying to an issue. In the example above, the original editor didn't know what whether the error was Errata or not. Some days later, suppose someone is looking through the proposed changes (click the Changes button, bottom left) and sees this error. They look in their copy of LW13 and see that in the original text it reads 'Magnakai', so it's Not Errata. They set up the Editor Companion to LW13, Section 100, then they select which Issue Number they are responding to. In our example, there is only one problem with Section 100, so it would be issue 1. They then type into the 'comment' field on the right: "This is Not Errata". They then 'Add Correction' and submit the information to the Mailing List.
Intimidated? Scared? Quaking in your boots? Don't be--it's really much, much simpler than I've tried to explain it!
Apologies all round for writing the longest post in the world. My fingers hurt now.
