...making Linux just a little more fun!
The first requirement of this job is access to our Subversion repository - that's what we use for version control. This requires several steps:
There are three major areas of the repository that you will use as a proofreader: articles/, doc/, and p/. These are, in order, where the issue content is kept, documentation on the various aspects of SVN and LG-related work, and the per-user "home" directory structure.
Before beginning any work, run "svn update" to bring your working copy up to date.
Check the STATUS file in the issue directory. Articles ready for review have an 'X' in the RELEASED column, nothing in the REVIEW column, and no "HOLD" message. Choose an article and put your initials in the REVIEW column. "svn commit STATUS" immediately to let everyone know that the article is being processed.
Clarity and conciseness are paramount; many of our readers have a limited knowledge of English (although technical explanations need to be explicit and clear regardless of the audience.) Minimize colloquial phrases and unnecessarily obscure words. Reword or explain phrases not understood across all English dialects. (E.g., "petrol" is OK, "dodgy" is borderline, but "trolley" for a wheeled cart had better be explained.)
If the wording sounds really foreign (e.g., "Indian English", "Dutch English", "Russian English"), try to fix the most jarring constructions, especially those that will trip up speakers from other non-English backgrounds.
When all technical problems are fixed, put an 'X' in the REVIEW column. "svn commit STATUS" immediately.
author: author's_LG_name (usually the last name; see $SVN_ROOT/authors/) title: article_titleand must be followed by a blank line.
Convert literal special characters to entities:
< to < > to > & to &These are especially common in inline program listings.
Run the article through HTML Tidy, ignoring the following errors (occuring due to lack of HTML headers):
line 4 column 1 - Warning: missing <!DOCTYPE> declaration line 4 column 1 - Warning: plain text isn't allowed in <head> elements line 4 column 1 - Warning: inserting missing 'title' element
When done, update STATUS for the article by setting the appropriate columns to 'X'. Check your work into the repository by running "svn commit" (be careful not to run "svn update" instead, or you'll lose all your work!)
In case of any questions, problems, or errors, please contact either the proofreading team coordinator or the editor.