ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

style-guide: add mnemonic translations

pull/23/head
Reinhart Previano Koentjoro 2023-12-01 00:46:27 +07:00 committed by Starbeamrainbowlabs
parent 8b8a2d2de0
commit 67f90450a4
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contributing-guides/style-guide.md
View File

@ -189,7 +189,7 @@ In this case, provide a note and method to determine whether the command current
### Short option mnemonics
Short option mnemonics are optional hints which can be added to help English users understand the meaning of these short options. For example:
Short option mnemonics are optional hints which can be added to help users understand the meaning of these short options. For example:
```md
- [d]isplay the ins[t]allation [i]D for the current device. Useful for offline license activation:
@ -205,6 +205,8 @@ Note that, on the first example, the `[d]`, `[t]`, and `[i]` characters are encl
**Mmemonic characters must be written in case-sensitive**, even though it is placed as the first character of the sentence (i.e. `[d]isplay` instead of `[D]isplay`). This is to avoid conflicts with GNU-style command options which may intepret 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, `[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.
## Placeholder syntax
User-provided values should use the `{{placeholder}}` syntax