CDS submission Check List

Before submitting a document to CDS please go though the check list below. You are welcome to add to this list and correct it.

Absolutely required:

  • A document to be reviewed must have line numbers.
  • Use lead-lead in the title and Pb+Pb, p+p in the text
  • do not capitalize:
    • inner detector (ID)
    • electromagnetic calorimeter (EMC)
    • hadronic calorimeter (HCal)
    • forward calorimeter (FCal)
    • zero degree calorimeter (ZDC)
    • minimum bias trigger scintillator (MBTS)
    • transition radiation tracker (TRT)
  • do capitalize
    • Pixel detector (says who? -- check)
    • Semiconductor tracker (SCT)
  • do not use short forms and abbreviations.
    • don't
    • it's
    • let's
    • w.r.t.
  • Put citations in incremental order

Conventionally required:

  • do not use italic for units and do not leave space after numbers. For example:
    • 2.76TeV
    • 2mm
    • 64μb
  • do not use k,M for numbers instead of 40M events, use 4x10^{7} events.
  • Use passive voice: "it was measured" instead of "we measured" (ATLAS choice)

Good style

  • use expressions:
    • centrality class. denote centrality classes as (XX-YY)%, for example: (20-30)%
    • rapidity region or rapidity interval.
    • pT region or pT bin if you need to say "bin" at all. denote pT region as 2<pT[GeV]<3
  • consider splitting a sentence longer than 2 lines in a single column page.
  • for native speakers of Slavic languages, like myself, and some other languages too: minimize use of parentheses.
  • If you are writing a proceeding add the first comment to the discussion by yourself stating the deadline.

Tips

  • References:
    • ATLAS detector hardware:
    • public reference for centrality determination procedure
    • HIJING
    • PDG
    • PYTHIA

  • Common typos a spell checker would miss:
    • "form" can be misspelled word "from"
    • "its" can be misspelled "it's", but do not use it anyway
    • "week" can be "weak"

Requirements to figures, tables and captions.

  • Use ATLAS style (link)
  • Figures must have axis titles, you know...
  • No publisher would accept a figure if a font size appears to be less than 1.X mm in printed version
  • Submitted figure must be in PDF or EPS format.
  • Figures and tables must be called in the text and preferably placed as close to the first call as possible.
  • Refer to figures as Fig.1 or fig.2 or Figs.1,2 in the text. Always write Figure 1 at the beginning of the sentence.
  • Always refer to tables as Table 1, do not abbreviate.
  • Use [arb. units] not [a.u.] which are "atomic units"
  • L_{int} = 8 μb^{-1} takes much less space in your legend compared to #Int Ldt = 8 μb^{-1}

-- AlexanderMilov - 31-Aug-2011

Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r6 - 2011-10-15 - AlexanderMilov
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    Sandbox All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback