0.2 Editing Guide

This is a general guide for section editors to help create a unified editing process.

The main goal of the editors is to consider the quality of the content, each editor should consider these questions and hopefully answer them by the end of editing a section.

  • What is the point of the section?
  • Is that point clear or could it be presented in a different way?
  • Are the example useful?
  • Are there holes or assumptions in the section content which need to be improved?
  • What could be added or removed to improve the quality of the section?

Comments

When editing a section add comments by starting with your initials, and wrap the comment in a css span tag to color the text so that it sticks out, an example is:

<span style="background-color:cyan">GSF:this is the comment text</span>

renders as:

GSF: this is the comment text

Spelling and Grammar Correction

Please fix any spelling mistakes or minor grammar errors. If a sentence or paragraph is confusing or poorly written, make a note for the author.

Spelling Style

Since we all come from different backgrounds on our spelling stylea we need to formalize the text on one style, we will use the MNRAS style which is essentially British English spelling, e.g. colour instead of color, but uses 'z' in most '-ize' ending words. The specific direction taken from the MNRAS style guide:

Punctuation

Hyphens (one dash in LaTeX) should be used for compound adjectives (e.g. low-density gas, least-squares fit, two-component model). This also applies to simple adjectival units (e.g. 1.5-m telescope, 284.5-nm line), but not to complex units or ranges, which could become cumbersome (e.g. 15 km s–1 feature, 100–200 µm observations). Some words (e.g. time-scale) are always hyphenated as part of journal style (see below).

N-rules (two dashes in LaTeX): these are longer than hyphens and are used (i) to separate key words, (ii) as parentheses (e.g. the results – assuming no temperature gradient – are indicative of …), (iii) to denote a range (e.g. 1.6–2.2 µm), and (iv) to denote the joining of two words (e.g. Kolmogorov–Smirnov test, Herbig–Haro object).

M-rules (three dashes in TeX/LaTeX) are not used in MNRAS.

Spelling and grammar

Please use British English spellings – e.g. centre not center, labelled not labeled. For words ending in -ise/yse or -ize follow this style: use -ise/yse for devise, surprise, comprise, revise, exercise, analyse; use -ize for recognize, criticize, minimize, emphasize, organize, ionize, polarize, parametrize (note the spelling of this word in particular).

‘None’ is a singular word (none of the stars is a white dwarf), whilst ‘data’ is a plural word (these data show…).

Miscellaneous journal spellings: acknowledgements, artefact, best-fitting (not best-fit), disc (except computer disk), haloes (not halos), hotspot, none the less, non-linear, on to, time-scale.

For any other spellings, use whichever version is listed first in the Oxford English Dictionary.

Figures, Equations, and Tables

When referencing a figure, equation, or table in the text use Fig. [Number], Eq. [Number], Table [Number].

Section Referencing

When referencing a section in the text use the $\S$ symbol using the notation $\S$ [section number], e.g. $\S$ 4.3.1.

Editor/Author Collaboration

We leave it to the editors and authors on how best to collaborate on incorporating edits and comments into the text. A suggestion is for the editor to send a pull request to the author's github fork. Once the edits are worked out, the author will then do a pull request to the main github repository.

Editing Attribution

At the introduction of each chapter there is a list of chapter writers and editors. Please add your name to the editor's list, include the particular section number which you edited. We need this so we can keep track of who knows about each section. And, we want to give you recognition for your work.