LHCb paper draft checklist

Before every circulation, the paper should be checked for common style errors with the checklist below. This will take about an hour but this is easily gained back in a smoother review. Clicking on the links below will give more detailed info, examples and hints on how to check.

These are just the most common mistakes. For a complete set of guidelines, see the template and Publications FAQ.

Language:

Title and section titles

  • Have you used the latest LHCb style and bib files?
  • Is "(c) 20YY CERN for the benefit of the LHCb collaboration. CC BY 4.0 license " on title page?
  • Do not start with article.
  • Only the first word should be capitalised.
  • Everything bold, including symbols and particles?

Typography:

  • All minus signs and dashes should be full size.
  • All subscripts and superscripts that refer to words should be in roman font.
  • Use a protected space (~) before every \cite \ref, after every Fig., Eq., Table.
  • Ranges in consistent format: x-y or [x,y]

Numbers:

Abbreviations:

  • Abbreviations defined at first occurrence?
  • No unnecessary capitalization when defining abbreviation?

Equations:

  • Displayed results should not be numbered.
  • Do not precede equations or displayed results with a colon.
  • Write the equation as though it is part of the natural text flowing around it, including commas or full stops after the equation.
  • Multiple differentials are separated by a thin space?
  • Definitions with ≡ (\equiv) instead of 'regular' = ?

Tables:

  • Must be either top or bottom of page.
  • Caption in \small font and above the table (automatic in latest template)?
  • No 'summary of' or 'list of' in the caption?
  • Similar style as in the example of the guideline?
  • Numbers well aligned on +- symbols and/or decimal points?
  • Does the caption give a self-contained description?

Figures:

  • Contain 'LHCb' or 'LHCb simulation' label?
  • Either on top or bottom of page?
  • Axis labels correct, including units?
  • Are the font sizes consistent and not too small?
  • Minus signs have same size, alignment as plus signs?
  • No touching or overlapping items?
  • All curves distinguishable and described in either legend or caption?
  • Are all curves distinguishable when printed in black and white?
  • Data points appear on top of all fit curves?
  • Does the caption give a self-contained description?
  • Caption in \small font?
  • Subfigures clearly indicated with (a) (b), (left) (right) etc?
  • Subfigure label in caption precedes description?
  • Imagine this figure was shown at a conference; does it contain all the necessary information to be understandable?

References:

  • Picked up the latest LHCb-PAPER.bib, LHCb-CONF.bib, and LHCb-DP.bib? (Those files are here)
  • Added a space between author initials of BibTex entries taken from Inspire?
  • Any unpublished result has in the meanwhile been published?
  • Click all hyperlinks and check correctness of authors, title and volume
  • Is the title correctly formatted?
  • BaBar and Belle spelled correctly (they are defined in the LHCb symbols file)?
  • All JHEP volume numbers have 2 digits?
  • Removed all volume numbers e.g. "no. 5" in journal references?
  • "collaboration" starts with a lower-case?
  • No unnecessary capitalization in the title (usually only first word is capitalised)?
  • Are the units and particle symbols in the titles compatible with the LHCb symbol style?

Collaboration Wide Review:

  • The draft should contain the author list (sent to you by the EB after approval-to-go-to-review) at the very end of the document.
  • All the supplementary or supplemental material should be included.
  • All the sections of the main part (text, figures, tables, acknowledgements, references but not the author list) must appear before any of the supplementary/supplemental material.
  • If a PRL, have you included the "Justification for PRL" and the the word count?

For questions and suggestions please send an email to lhcb-editorial-questions@cern.ch.

Edit | Attach | Watch | Print version | History: r26 < r25 < r24 < r23 < r22 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r26 - 2020-06-09 - FranzMuheim
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    LHCb/FAQ All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2023 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