Skip to content
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.

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

style-guide: recommend hyphen over en dash and em dash #15407

Merged
merged 3 commits into from
Jan 4, 2025
Merged
Changes from 2 commits
Commits
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
15 changes: 14 additions & 1 deletion contributing-guides/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@
Short option mnemonics are optional hints that can be added to help users understand the meaning of these short options. The assigned mnemonics should match with the ones in the command's official documentation (e.g. from `man` or `Get-Help`). For example:

```md
- [d]isplay the ins[t]allation [i]D for the current device. Useful for offline license activation:

Check failure on line 366 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

isplay ==> display

`slmgr.vbs /dti`

Expand All @@ -375,11 +375,11 @@
Note that, in the first example, the `[d]`, `[t]`, and `[i]` characters are enclosed with square brackets to indicate that the `/dti` option of the command is a combination of "display", "installation", and "ID", respectively.
Group consecutive mnemonic characters under the same square brackets, for example: `e[xp]i[r]ation` instead of `e[x][p]i[r]ation`.

**Mnemonic characters must be written in a case-sensitive manner**, even when it is placed as the first character of the sentence (i.e. use `[d]isplay` instead of `[D]isplay`).

Check failure on line 378 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

isplay ==> display

Check failure on line 378 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

isplay ==> display
This is to avoid conflicts with GNU-style command options which may interpret uppercase options differently than the lowercase ones, such as `-v` for displaying the command's `[v]ersion` number and `-V` to run the command in `[V]erbose` mode.

Option mnemonics may also be used in translations as long as the highlighted word contains similar meanings to the language (commonly English) which the command is written for.
For example, `[d]ownload` in English may be translated into `[d]escargar` in Spanish, `[i]nstall` in English may be translated to `[i]nstallieren` in German, and `[a]pp` in English may be translated into `[a]plikasi` in Indonesian and Malay.

Check failure on line 382 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

ownload ==> download, own load

Check failure on line 382 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

nstall ==> install

- Optionally, mnemonics and their enclosed terms can be separated with brackets from the rest of the description (i.e. `([a]ll)`) in translations and specific pages to provide additional context or mention a word not present in the description.

Expand Down Expand Up @@ -468,7 +468,20 @@

## Language-Specific Rules

The below section contains additional language-specific rules for translating pages:
The below section contains additional language-specific rules:

### English-Specific Rules

A normal hyphen (`-`) should be used in places where various style guides may recommend en dash (`–`) or em dash (`—`).

- For example, use `for lengths 3-12` rather than `for lengths 3–12`

The reason for this is four-fold:

1. There is no widely-accepted standard among various style guides on when each of these dashes should be used.
sebastiaanspeck marked this conversation as resolved.
Show resolved Hide resolved
2. Hyphen (`-`) is the only dash-like character in ASCII, which reduces the likelihood of compatibility issues.
3. Hyphen (`-`) is by far the easiest to type.
4. Many English speakers, especially non-native ones, are not aware of the difference.

### Chinese-Specific Rules

Expand Down Expand Up @@ -550,7 +563,7 @@
| Image (as means of storage, such as CD, ISO, and Docker) | Image | Another recommended word, [`citra`](https://kbbi.kemdikbud.go.id/entri/citra), is not officially recognized for computing. |
| Initialize, Reinitialize | Inisialisasikan, Inisialisasikan Ulang | The word [`inisialisasi`](https://kbbi.kemdikbud.go.id/entri/inisialisasi) is officially considered as noun. Requires a `-kan` suffix to convert into a verb. |
| Interpreter | Interpreter | Preferred over [`penerjemah`](https://kbbi.kemdikbud.go.id/entri/penerjemah) which is also commonly used to describe `translator`. |
| Install, Reinstall | Pasang, Pasang Ulang | Preferred over `instal` [which is not considered a standard word](https://kbbi.kemdikbud.go.id/entri/instal). |

Check failure on line 566 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

instal ==> install

Check failure on line 566 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

instal ==> install
| Load, Reload | Muat, Muat ulang | These words are the same for `boot` and `reboot`. See notes in the bottom section. |
| Options / Preferences (macOS) / Settings | Pengaturan | Preferred over [`opsi`](https://kbbi.kemdikbud.go.id/entri/opsi). |
| Server | Server | Preferred over [`peladen`](https://kbbi.kemdikbud.go.id/entri/peladen) or [`pelayan`](https://kbbi.kemdikbud.go.id/entri/pelayan), which are less common when used in computing contexts. |
Expand All @@ -571,7 +584,7 @@

Add detailed contexts to remove ambiguity (notice the highlighted word):

> Muat konfigurasi dari file yang ditentukan setelah **pengguna** memuat ulang **sistem operasi**

Check failure on line 587 in contributing-guides/style-guide.md

View workflow job for this annotation

GitHub Actions / build

sistem ==> system

Similarly, for the word `start` / `mulai`

Expand Down
Loading