Skip to content

Link style and tone guide #532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ann0see merged 1 commit into from
Jun 21, 2021
Merged

Link style and tone guide #532

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is the content repository for [jamulus.io](https://jamulus.io). Text appearing in the Jamulus software application itself is part of the [main code repository](https://github.com/jamulussoftware/jamulus). The web site is built with Jekyll and Fox-CSS.

### Please also note that discussions should be in English so as to be open to all.
### Please also note that discussions should be in English so as to be open to all.

## Making changes to the English version

Expand All @@ -14,15 +14,15 @@ To view the website offline one your own machine, you will need to clone it loca

## Formatting and style

We use [GitHub markdown](https://guides.github.com/features/mastering-markdown/) to format the basic text. Have a look at the markdown in existing pages for examples.
We use [GitHub markdown](https://guides.github.com/features/mastering-markdown/) to format the basic text. Have a look at the markdown in existing pages for examples.

Note that we use British English spelling and grammar conventions.
Note that we use British English spelling and grammar conventions.

## Adding pictures

Use the `{{site.url}}` variable to call an existing image in the corresponding directory for that language. This ensures the correct URL is used:

`<img src="{{site.url}}/assets/img/en-screenshots/mixer-channles.png" …`
`<img src="{{site.url}}/assets/img/en-screenshots/mixer-channles.png" …`

If you want to add a new image, use .png format if possible, and if it’s not a screenshot, ask about where you should store it. Localised images must go in a directory for that language (see the example for English, above).

Expand All @@ -31,6 +31,10 @@ If you want to add a new image, use .png format if possible, and if it’s not a

### For details on the website translation process, please consult the README file contained in the `translator-files/` folder

### Style and tone

Language on the website should be consistent. Please have a look at our [style and tone guide](https://jamulus.io/contribute/Style-and-Tone).

#### Please note: if your language has no translated documents, please start with the following sections of the website:

- Home page
Expand All @@ -50,7 +54,7 @@ We collect changes to the English version of the site on a "next-release" branch

### Points to note

- Each page on the site has a .md or .html language suffixed version. Some of the website content is in \_includes/wiki/[langCode]. These files must be translated in order not to break the site.
- Each page on the site has a .md or .html language suffixed version. Some of the website content is in \_includes/wiki/[langCode]. These files must be translated in order not to break the site.

- The homepage (https://jamulus.io/) is located in the repo root and named 1-[langCode]-index.html

Expand Down