⚠️ This is a copy-paste from RDMkit and still needs to be adjusted to the Metroline. Also, check what Elixir has adjusted in their style-guide for potential inspiration, see here. Todo.
The content of this page is based on RDMkit’s Style Guide and extended with styling information specific for the FAIR Metroline. Like RDMKit, we follow the European Commission’s Web Writing Style Guide and their English Style Guide. Search online for “EC English style guide” to find the link, since it changes regularly.
...
Acronyms: spell them out the first time.
Ampersands: do not use these in the main text or headings. It is fine to use them in menus, if you need to save space.
Capitals: do not use all capitals for emphasis or in headings.
Data: treat as singular (“Data is…”). (Whether “data” is singular or plural is contentious - see the Wikipedia article and this Guardian article.)
Dates: use Wednesday 7 July 2021 (not Wednesday 7th July 2021, or other variations).
Datasets: not “data sets”.
Email: not “e-mail”.
Email addresses: spell these out and make the email address the link e.g. rdm-toolkit@elixir-europe.org. Do not hide the email address behind a word or phrase like “contact us”.
Etc. should be avoided. Try using ‘for example’ or ‘such as’ or ‘including’ “for example” or “such as” or “including” at the start of a listing. If etc. is used, put a comma before it if it is in a list, like “A, B, etc.”.
Gender: avoid using gender-specific words like “he” or “she”.
Headings:
Only the first word is capitalised, unless other words are proper nouns.
Headings must be hierarchical. They must go down in order (level one, level two, level three), and not skip a level. It is fine to skip levels when moving back up e.g. you can skip from level four to level two.
-ise/-ize: use the “-ise” form.
Life cycle: two separate words.
Links: make the link text say where the link goes e.g. “the Contribute page”, not “click here”. Avoid using the url as the link text.
Lists:
A list of short items: introduce with a colon, start each bullet point with a capital and don’t use punctuation at the end of each bullet point:
Item 1
Item 2
A list of longer items following an incomplete introductory sentence (e.g. a sentence ending in a colon): each item ends with a semi colon and the final item ends with a full stop. Do not capitalise the first letter of each item e.g. This is the first part of a sentence that includes:
a longer item 1;
a longer item 2;
a longer item 3.
A list following a complete sentence (with a full stop): each item ends with a full stop and each point begins with a capital letter e.g. This a complete sentence.
This is item 1 of the list.
This is item 2 of the list.
This is item 3 of the list.
Metroline: when referring to the FAIR Metroline, use a capital “M”.
Numbers: spell the numbers one to ten out. After that, write the numbers (11, 12, 13, etc.).
Quotations: use double quotes for quotations, and single quotes for quotes within quotes.
References: add references directly in the text, e.g. “According to FAIRifcation models, such as FAIRopoly…”.
That/which: use “that” when you are defining something and “which” when you are adding extra information about it e.g.:
“The cat that was on the table suddenly got up” is telling us which cat it was. It is important to the meaning of the sentence because you are not talking about any cat, just the cat on the table.
“The cat, which was sitting on the table, suddenly got up” is giving us extra information about the cat. The information is not necessary to understand the sentence. You can remove the clause and the sentence will still be clear. Clauses starting with “which” usually begin with a comma.
Titles (the “title” in the front matter of pages): only the first word, proper nouns and acronyms are capitalised.Tool assembly: there are multiple tools in one assembly. The plural is “tool assemblies”.
Training: training is an uncountable noun and cannot have a plural. You can write “training courses” and “training materials” but not “trainings”.
Bibliography
Add your citations as bibtex to the
_bibliography/references.bibfile.Add
{% cite reference_key %}to the text where you are citing the reference.Add
## Bibliography {% bibliography --cited %}to show a bibliography section containing the references in the page.
Graphic design
White space: make sure there is plenty of space so that the main elements stand out and the text does not appear overwhelming.
Colours:
The headings, links and text will automatically appear in the right colour if you use the site page templates.
Use only the following colours in the design, text and illustrations of the site. The RDM life cycle diagram colours are only for use in the pages related to the diagram.
#C23669MagentaLogo, Menu highlight, Second level heading (h2), Main theme colour#376AC3BlueLink colour#2a2e3dDark blueFirst level headings (h1), Third level heading (h3), Body text, Header, Footer#73757dGrayGray text, Fourth level heading (h4)#f3f1f2Light grayBox backgrounds
Fonts: Exo 2 is used for headings and main branding font, Open Sans for body text.
Icons: the icons used in the data life cycle diagram come from the Noun Project. We have a Pro license and so the right to publish them without attribution. Other icons on this site come from Font Awesome.
Templates: keep the structure of the pages consistent by using the site templates (see the contribute page).
Illustrations: use the colours listed above. The icons we use for illustrations come from the Noun Project. Please use these icons in any illustrations. If you need extra icons, or any help with illustrations, open a new issue on GitHub or email rdm-toolkit@elixir-europe.org.
Images:
Do not use images to display text.
Include an ‘alt’ attribute in images.
Naming of files, tags, keywords, and navigation titles
Markdown file names:
Do not contain spaces or special characters like &, %, #, (, ), è, é, ê, ë, …
Are unique among the website.
Are lowercase, except for acronyms.
Tags for tools, resources and pages:
Do not contain special characters like &, %, #, (, ), è, é, ê, ë, …
Are lowercase, except for acronyms.
Are short if possible, but distinguishable from existing tags.
Can contain spaces.
Keywords:
Are lowercase.
Can contain spaces.
Titles in the navigation side panel:
First word and acronyms capitalised.
Should contain the same words as the filename where this title points to.
Description: add clear descriptions to images
How to suggest amendments or additions to this style guide
Open a new issue on GitHub or email rdm-toolkit@elixir-europe.orgSend an email to fairservicedesk@health-ri.nl. See also the contribute page.
...