Skip to main content

Images

  • If you're adding an image to illustrate a paragraph, place the image after the corresponding paragraph.

Terms#

  • Refer to the Chemotion Electronic Lab Notebook as Chemotion ELN.
  • The Chemotion spectra editor for analytical data is ChemSpectra.

Titles#

  • Capitalize only the first word of a title.

Tables#

  • Do not capitalize words inside tables.

Automatic style checking#

By every push to the chemotion_saurus repository an automatic style guide checking is running. Naming typos are fixed within an automatic push to the repository, after the initial push from the user and will be deployed within the next push from a user. If tables contain uppercased words or the commited file is missing in the table of contents, warning or error messages are printed in the Style Guide Parser step in the GitHub Actions.
Style checking can be skipped with this command in the commit message:

skip style guide
Recommendation

The Style Guide Parser works best for natural language text like in the chemistry manual of this documentaiton. It may be better to skip the Stlye Guide Parser (skip style guide in the commit message) if you are using the terms with an extra spelling, e. g. "chemotion_ELN" as name for the Ruby app, like in the developer section of this documentation.

Last updated on by maipy