Skip to content

Commit

Permalink
Clarify use of capital letters (#1083)
Browse files Browse the repository at this point in the history
* Clarify use of capital letters, units clarification, flatten inverted commas, "e.g." not "eg", also suggestion per @mcfnord on earlier PR.
  • Loading branch information
gilgongo authored Jan 12, 2025
1 parent c5fe0d7 commit 4981b6e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 26 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To edit an individual file, you can use the Github web interface or make a fork

### Viewing the website offline

You can view the website (this repo) offline on your own machine using [Jekyll](https://jekyllrb.com/). Please see the [instructions for doing this here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). Note that Windows and macOS users will need to make their changes to the website files first, then make a pull request. Click on the "Checks" tab of the pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run `jekyll serve`. If you are on Linux, you can make and view your changes offline before making a PR, but you must install po4a (clone our [assets repo](https://github.com/jamulussoftware/assets) and install the latest .deb from there) along with Jekyll. Then clone the website repo, create your branch and run `_po4a-tools/po4a-create-all-targets.sh` before running `bundle exec jekyll serve` and viewing the site on `http://127.0.0.1:4000/`. Please ask in [Discussions](https://github.com/jamulussoftware/jamulus/discussions) for help with this if necessary.
You can view the website (this repo) offline on your own machine using [Jekyll](https://jekyllrb.com/). Please see the [instructions for doing this here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). Note that Windows and macOS users will need to make their changes to the website files first, then make a pull request. Click on the "Checks" tab of the pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run `jekyll serve`. If you are on Linux, you can make and view your changes offline before making a PR, but you must install po4a (clone our [assets repo](https://github.com/jamulussoftware/assets) and install the latest .deb from there) along with Jekyll. Then clone the website repo, create your branch and run `_po4a_tools/po4a-create-all-targets.sh` before running `bundle exec jekyll serve` and viewing the site on `http://127.0.0.1:4000/`. You can [ask for help in Discussions](https://github.com/jamulussoftware/jamulus/discussions).

## Formatting and style

Expand Down Expand Up @@ -56,9 +56,9 @@ Please have a look at our [style and tone guide](https://jamulus.io/contribute/S

We collect changes to the English version of the site on a "next-release" branch first. We then freeze changes prior to a Jamulus software release, and do a translation "sprint" over a couple of weeks when all translation takes place.

1. Changes are first made to EN (= English) *.md files and committed to the next-release branch.
1. Changes are first made to EN (= English) *.md files and committed to the "next-release" branch.
1. Once we’ve agreed the changes can go live (usually just before a software release), we then create GitHub issues for each language, tagged for that release. You can ask questions about the work there.
1. Translators for each language then update them on Weblate, or edit the .po files for their language in `_translator-files/po/LANGUAGE/` and open pull requests to merge them into the "next-release branch.
1. Translators for each language then update them on Weblate, or edit the .po files for their language in `_translator-files/po/LANGUAGE/` and open pull requests to merge them into the "next-release" branch.
1. When all translations are merged (issues will then close automatically), we merge that new branch into the `release` branch, which is automatically made live on the production site.

### Points to note
Expand Down
43 changes: 20 additions & 23 deletions contribute/en/Style-and-Tone.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ While contributing to Jamulus or the website, you should also keep style and ton
### Keep it concise and specific.
{:.no_toc}

Avoid long-winded phrases and overly stylised language. Start simple, expand to details later, if at all (inverted pyramid style).
Avoid long-winded phrases and overly stylised language. Start simple, expand to details later, if at all ("inverted pyramid" style).

### Be direct, but not demanding.
{:.no_toc}
Expand All @@ -51,12 +51,12 @@ Resist the temptation to say why something happens before offering a solution fo
### We use British English.
{:.no_toc}

Colour”, “minimise”, “centre
"Colour", "minimise", "centre"

### Tone (Keep it Light)
{:.no_toc}

Informal English is preferred (eg “haven’t not have not”. “Try to not Please attempt to).
Informal English is preferred (e.g. "haven’t" not "have not". "Try to" not "Please attempt to").

Try not to sound like a robot. Write conversationally, as if you were talking to a person.

Expand All @@ -65,49 +65,46 @@ Try not to sound like a robot. Write conversationally, as if you were talking to

## Capitalisation and references

Headings use sentence case This is a heading unless delineated (eg “Look - This is a heading).
Headings use sentence case "This is a heading" unless delineated (e.g. "Look - This is a heading").

Nouns use lower case unless they have a formal definition in this style guide (eg “Directory”, “Fader”). The only exception to this is the word person or people which can remain in lower case.
Nouns use lower case unless they have a formal definition in this style guide (e.g. "Directory", "Fader") or refer to specific Jamulus features (e.g. "Audio Alerts", "Jitter Buffer"). The only exception to this is the word "person" or "people" which can remain in lower case.

Refer to UI labels in inverted commas (eg 'click on the “mute” button')
Refer to UI labels in inverted commas (e.g. 'click on the "Mute" button')

## Standard terms

Sound card (not audio device or sound device) to refer to on-board audio interfaces only. Your sound card will be listed by default”, “Most computers have compatible sound cards.
"Sound card" (not "audio device" or "sound device") to refer to on-board audio interfaces only. "Your sound card will be listed by default", "Most computers have compatible sound cards".

Audio interface to refer to external sound cards. If your audio interface comes with a driver”, “Your audio interface may be set to ‘monitor’
"Audio interface" to refer to external sound cards. "If your audio interface comes with a driver", "Your audio interface may be set to ‘monitor’"

Sound hardware refers generically to both internal and external audio cards. Your sound hardware will introduce some latency”, “Most sound hardware can be used.
"Sound hardware" refers generically to both internal and external audio cards. "Your sound hardware will introduce some latency", "Most sound hardware can be used".

macOS (not Mac, or MacOS)
"macOS" (not "Mac", or "MacOS")

Jamulus is Free and Open Source (FOSS) (not free software or open source)
Jamulus is "Free and Open Source (FOSS)" (not "free software" or "open source")

Channel The audio signal as part of a mix. Mute a channel”, “Maximum number of channels”, “Group channels together.
"Channel" The audio signal as part of a mix. "Mute a channel", "Maximum number of channels", "Group channels together" (not "Mute a person" because one person might be using multiple channels).

"Fader" - the UI control that adjusts the channel volume heard in the mix. Not "volume slider", "volume control" or other term (adding the context of the mixer, if needed).
"Fader" The UI that controls a channel. "Each fader has a "Mute" button", "The person’s fader" ,"Group faders together" (not "The person’s channel" or "Mute a Fader", not "Slider" or "Volume control")

Person” When "channel" or "fader" isn't a good term (according to the above definitions), we refer to "people" connected to a server rather than "musicians" since (in English) the latter term does not imply singers.
"Person" A human connected to a server (may be on multiple channels). We might say "a person on the server", or "the people who have muted themselves", rather than _musicians_ or _Channels_.

"Volume" Referring to how loud a channel is. Not "Level", "Gain" or other terms.

“Country/Region” Keep in mind that some areas of the world have a controversial (political) status. If possible, be generic and remain neutral. Instead of just saying country, use "Country/Region" or "Location".
"Country/Region" Keep in mind that some areas of the world have a controversial (political) status. If possible, be generic and remain neutral. Instead of just saying country, use _Country/Region_ or _Location_.

"Client" When capitalised, this means an instance of Jamulus running in client mode, used to connect to Jamulus Servers.

Server When capitalised, refers to an instance of Jamulus running in server mode. When lowercase as _server_, this refers to the computer that runs the Server (e.g. "A Server running on an AWS server"). Not to be confused with Directory.
"Server" When capitalized, refers to an instance of Jamulus running in server mode. When lowercase as _server_, this refers to the computer that runs the Server (e.g. "A Server running on an AWS server"). Not to be confused with Directory.

Directory The term for a type of Server that a Client uses to get a list of Servers from. Avoid the use of the term _Directory Server_ because it may be confusing in the presence of _Server_ on its own.
"Directory" The term for a type of Server that a Client uses to get a list of Servers from. Avoid the use of the term _Directory Server_ because it may be confusing in the presence of _Server_ on its own.

Registration When a Server is configured in Registered mode, it will be _listed_ when successfully registered by a Directory. Note that if a Directory is full, a Registered Server will not be _listed_ because it has not been successfully _registered_. Note in this case we prefer to say, "Register with a Directory".
"Registration" When a Server is configured in Registered mode, it will be _listed_ when successfully registered by a Directory. Note that if a Directory is full, a Registered Server will not be _listed_ because it has not been successfully _registered_. Note in this case we prefer to say, "Register with a Directory".

Server List This is the list of Servers maintained by a Directory. A Server registers with a Directory to be _listed_ in that Directory’s _server list_.
"Server List" This is the list of Servers maintained by a Directory. A Server registers with a Directory to be _listed_ in that Directory’s _server list_.

## Units

We use the following abbreviations:

Kbit/s; Mbit/s; KByte/s; MByte/s.
Kbit/s; Mbit/s; KByte/s; MByte/s. We do not distinguish between 1024-based and 1000-based values for these.

Values followed by units such as `ms`, `s`, `m`, `km`, `GHz` etc. should be separated by a space; e.g. "20 ms" and "1 GHz" not "20ms" and "1GHz".

0 comments on commit 4981b6e

Please sign in to comment.