Style Guide for Language in ILIAS
Tabs
Style Guide for English Language in ILIAS
Page Overview
[Hide]Up until now, English language entries in ILIAS have had a bit of a Wild West feel to them. Everyone working on ILIAS (at least on the English language parts) writes English pretty darn well. But everyone also writes things slightly differently. This can make things look untidy and unprofessional. In an effort to bring some overall cohesion to things, I have decided to put together some guidelines on the use of the English language in ILIAS.
1 The Basic Guidlines
- British vs American English
- Title Case and Sentence Case - Using the Correct Case.
- Bylines
- Notifications
2 Grammar and Punctuation
- Compound Adjectives (Hyphenating Words).
- Title Case Rules
- Quotation Marks
- Exclamation Marks!!!
3 Some Notes on Style
4 Terminology
5 Special Cases
Last edited: 11. Nov 2024, 12:06, Potter, Chris [ChrisPotter]
Comments
Becker, Maximilian [mbecker]
I like to leave a note here how much I enjoyed reading this guide! Very well done!
Created on20. Sep 2022- NR
Roeser, Nico [nicoroeser]
As far as I understand it, this is about texts (for users), and not for code. Or am I mistaken?
When I add a function to the ILIAS codebase which shows an apology because a part of a home address is not black on white, am I supposed to name it “apologiseForColouredPostcode” or “apologizeForColoredZipCode”?
Created on11. Jul 2022