Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 1.55 KB

STYLE.md

File metadata and controls

23 lines (19 loc) · 1.55 KB

Style

We detail language and markup considerations for working with the EOG.

Titles

Document titles should be in title case. Headings and subheadings should be in sentence case.

Bulleted lists

For bullet pointed lists, use dash ('-') to denote the list items. Sub-lists should be indented with three spaces. For example:

  • list item
    • sub item 1
    • sub item 2
      • sub sub item 2.1
      • sub sub item 2.2
    • sub item 3

Bulleted lists punctuation

If your bulleted lists contain sentence fragments, as a style choice we require capitalisation but no full stop at the end. See this for reference.

On links

Look at how links are contructed in different scenarios and copy their usage:

  • external links (see external links in the Sphinx documentation), see introduction in the EOG
    • if the same link text is used multiple times in one file then you need to us __ as the target, see authors in the EOG
  • internal / relative links (see internal links in the Sphinx documentation), see finance for other documents or risk assessment for figures in the EOG