Skip to content

Commit 346b7f2

Browse files
Merge pull request #28 from r-devel/simple-numbering
Switch to generic numbering in ordered markdown lists
2 parents 2fceb33 + b93a111 commit 346b7f2

7 files changed

+61
-59
lines changed

web/Conventions_for_Languages/Arabic-specific-translations.qmd

+5-5
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ improve the quality of your translations.
9595
# How to Contribute:
9696

9797
1. Join [R Contributors](https://app.slack.com/client/T01DW9DLB2A/C01EST8PTFA) Slack group.
98-
2. Join [#core-translation](https://app.slack.com/client/T01DW9DLB2A/C0210D7EN1X) channel.
99-
3. Create an account on [Weblate](https://translate.rx.studio/) (currently maintained by
98+
1. Join [#core-translation](https://app.slack.com/client/T01DW9DLB2A/C0210D7EN1X) channel.
99+
1. Create an account on [Weblate](https://translate.rx.studio/) (currently maintained by
100100
[@daroczig](https://twitter.com/daroczig));
101-
4. Choose Arabic language to see all components.
102-
5. Add your translation to a component that's not 100% translated.
103-
6. Review translated components.
101+
1. Choose Arabic language to see all components.
102+
1. Add your translation to a component that's not 100% translated.
103+
1. Review translated components.
104104

105105
## Glossary #### Note: The Arabic translation here is based on Google translate! It requires some review and edit. This
106106
can be done later!

web/Conventions_for_Languages/Catalan-specific-translations.qmd

+9-9
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ To help in the translation process, you need to:
2020

2121
1. Sign up to the [R Contributors Slack](https://contributor.r-project.org/slack) and introduce yourself in the
2222
`#core-translations` channel;
23-
2. Join [#core-translation-ca](https://app.slack.com/client/T01DW9DLB2A/C061B671J8G) channel.
24-
3. Read the [Resources](#resources) section of this document, because the translation has some conventions that should
23+
1. Join [#core-translation-ca](https://app.slack.com/client/T01DW9DLB2A/C061B671J8G) channel.
24+
1. Read the [Resources](#resources) section of this document, because the translation has some conventions that should
2525
be followed;
26-
4. Create an account on [Weblate](https://translate.rx.studio/) (currently maintained by
26+
1. Create an account on [Weblate](https://translate.rx.studio/) (currently maintained by
2727
[@daroczig](https://twitter.com/daroczig));
28-
5. List every Catalan [component](https://translate.rx.studio/languages/ca/r-project/);
29-
6. Choose a component that's not 100% translated;
30-
7. Click **Unfinished strings** to list all messages that haven't been translated and
31-
8. Start!
28+
1. List every Catalan [component](https://translate.rx.studio/languages/ca/r-project/);
29+
1. Choose a component that's not 100% translated;
30+
1. Click **Unfinished strings** to list all messages that haven't been translated and
31+
1. Start!
3232

3333
## Resources
3434

@@ -66,10 +66,10 @@ Alternatively, you can:
6666
git clone https://$USER:$PRIVATE_TOKEN@translate.rx.studio/git/r-project/base-r-gui/
6767
```
6868

69-
2. Look for the files at `src/library/*/po/*ca.po` and use any app to help you to review and fix the translations (eg.
69+
1. Look for the files at `src/library/*/po/*ca.po` and use any app to help you to review and fix the translations (eg.
7070
[Poedit](https://poedit.net/) or [Lokalize](https://apps.kde.org/ca/lokalize/))
7171

72-
3. You can not push to this repository. To upload the finished files, use the Weblate web interface (see image above).
72+
1. You can not push to this repository. To upload the finished files, use the Weblate web interface (see image above).
7373

7474
### R-project specific conventions
7575

web/Conventions_for_Languages/Chinese-specific-translations.qmd

+6-6
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ _这里包含R语言翻译过程中的基本用语风格指南,您必须遵守
3737
## 基本用语
3838

3939
1. 对翻译中的“你(you)”代称应使用敬语“您”,示例:您应该检查变量类型;
40-
2. 基本统计术语应当参考当前主流应用词汇;
41-
3. `%s`,`%i`,`%1$s`等被称作占位符,这里的文字会按照运行时生成的内容自动替换,您不能去掉或增加任何占位符,仅调整语序;
42-
4. 对于上述3中的占位符,您可根据需要调整其语序。例如:`%s in %s must be a numerical` 可被翻译为 `%2$s 中的 %1$s 必须是数值型`。显然您可以看到这里每个`%s`的含义不一样,如果您需要调整第二个`%s`的语序,您可以添加它们的位置像`1$`这样的参数到其中。如果您不确定如何使用它,可以参考其他已被翻译的内容;
43-
5. 禁止词汇:查阅 Weblate 的术语册一栏,会出现建议翻译/禁止翻译为XXX的提示,例如禁止将'robust' 翻译为“鲁棒”,而应当翻译为稳健性;
40+
1. 基本统计术语应当参考当前主流应用词汇;
41+
1. `%s`,`%i`,`%1$s`等被称作占位符,这里的文字会按照运行时生成的内容自动替换,您不能去掉或增加任何占位符,仅调整语序;
42+
1. 对于上述3中的占位符,您可根据需要调整其语序。例如:`%s in %s must be a numerical` 可被翻译为 `%2$s 中的 %1$s 必须是数值型`。显然您可以看到这里每个`%s`的含义不一样,如果您需要调整第二个`%s`的语序,您可以添加它们的位置像`1$`这样的参数到其中。如果您不确定如何使用它,可以参考其他已被翻译的内容;
43+
1. 禁止词汇:查阅 Weblate 的术语册一栏,会出现建议翻译/禁止翻译为XXX的提示,例如禁止将'robust' 翻译为“鲁棒”,而应当翻译为稳健性;
4444

4545
## 排版指南
4646
1. 中英文(含数字)混合排版时,应当在英文字符前后保持一个空格,像这样`欢迎使用 R 语言`
47-
2. 无须翻译的内容:一些内置函数、参数、值不能被翻译。例如`WARNING: no value given for '--max-connections'` 其中 `'--max-connections'` 这样的我们可以判断为参数,则保持不变。因此我们翻译成`警告:'--max-connections' 没有给定值`
48-
3. 保持术语一致性:我们应当尽可能保持程序和统计术语在上下文的一致性,并保证其与一些教材、论文当常用术语的继承性。
47+
1. 无须翻译的内容:一些内置函数、参数、值不能被翻译。例如`WARNING: no value given for '--max-connections'` 其中 `'--max-connections'` 这样的我们可以判断为参数,则保持不变。因此我们翻译成`警告:'--max-connections' 没有给定值`
48+
1. 保持术语一致性:我们应当尽可能保持程序和统计术语在上下文的一致性,并保证其与一些教材、论文当常用术语的继承性。

web/Conventions_for_Languages/Nepali-specific-translations.qmd

+13-13
Original file line numberDiff line numberDiff line change
@@ -43,66 +43,66 @@ accuracy and linguistic clarity of the translated text. Here's a translation gui
4343
Before translating any message or warning, it's crucial to understand the context. Know what the message is conveying,
4444
what part of the code it relates to, and its intended audience.
4545

46-
2. Maintain Technical Accuracy:
46+
1. Maintain Technical Accuracy:
4747

4848
Ensure that the translated message conveys the same technical information as the original. The goal is to make sure that
4949
users can still understand the issue or information provided.
5050

51-
3. Preserve Clarity:
51+
1. Preserve Clarity:
5252

5353
Clarity is paramount in translations. Make sure the translated message is clear and easy to understand. Avoid overly
5454
complex or verbose translations.
5555

56-
4. Use Formal Nepali:
56+
1. Use Formal Nepali:
5757

5858
When translating messages for a general audience or professional context. Avoid using dialects unless the message is for
5959
a specific region where a particular dialect is preferred.
6060

61-
5. Consistency:
61+
1. Consistency:
6262

6363
Maintain consistency in your translations. Use consistent terminology and wording throughout the translation to avoid
6464
confusion.
6565

66-
6. Be Mindful of Length:
66+
1. Be Mindful of Length:
6767

6868
Consider that the Nepali translation might be longer or shorter than the English text. Ensure that the translated
6969
message fits within the space allocated in the code or interface.
7070

71-
7. Retain Technical Terms:
71+
1. Retain Technical Terms:
7272

7373
For technical terms and code-related elements such as function names, object names, and variable names, it's often best
7474
to keep them in English. Use the Nepali script for these terms if necessary but maintain the English terminology.
7575

76-
8. Handle Plurals:
76+
1. Handle Plurals:
7777

7878
Nepali nouns have different forms for singular and plural. Ensure that you correctly handle plurals when translating
7979
messages that involve counts or quantities.
8080

81-
9. Punctuation:
81+
1. Punctuation:
8282

8383
Use punctuation stop (|) and ensure proper spacing around punctuation marks.
8484

85-
10. Special Characters:
85+
1. Special Characters:
8686

8787
Some technical messages may contain special characters like `%s, %d, or %f` for string, integer, and floating-point
8888
substitutions. Keep these special characters and their order in the translated message, making sure they correspond
8989
correctly with the placeholders.
9090

91-
11. Test the Translation:
91+
1. Test the Translation:
9292

9393
After translating, test the messages in the R environment to ensure they appear correctly and are still functional.
9494

95-
12. Document Translations:
95+
1. Document Translations:
9696

9797
Keep a record of your translations for reference. This documentation can help maintain consistency in future
9898
translations and facilitate collaboration with other translators.
9999

100-
13. Seek Feedback:
100+
1. Seek Feedback:
101101

102102
If possible, seek feedback from native Nepali speakers who are also familiar with programming to ensure the translations
103103
make sense in the intended context.
104104

105-
14. Revise and Update:
105+
1. Revise and Update:
106106

107107
Programming languages evolve, and so should your translations. Periodically review and update your translations to align
108108
with changes in the R programming language or best practices in translation.

web/Weblate-FAQ.qmd

+8-6
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,16 @@ see e.g. at <https://translate.rx.studio/projects/r-project/base-c/>
2626
Only Weblate admins can do that. For now, please reach out to @daroczig or @MichaelChirico.
2727

2828
1. Go the the [R Project project dashboard](https://translate.rx.studio/projects/r-project/)
29-
2. Click on the "Add new translation component" button at the bottom of the page 3. Provide a name for the component
29+
1. Click on the "Add new translation component" button at the bottom of the page
30+
1. Provide a name for the component
3031
following the naming schema of the other components (package name optionally followed by R or C files between parens,
3132
e.g. `methods (R files)`). It is required to split a package into (at least) two components when there are multiple PO
3233
files around, e.g. for R and C files, sometime even a 3rd one for the GUI
33-
4. Source code repo should point to `weblate://r-project/base-r-gui` (this is set to auto-poll the SVN repo)
34-
5. File format is usually `gettext PO file` (for strings extracted from R core and recommended packages), or e.g. iOS
35-
strings (for Mac GUI) 6. Provide file mask, e.g. `src/library/base/po/*.po` or `src/library/compiler/po/R-*.po`
36-
7. Set a Language filter when needed to guide Weblate which files to pick up (e.g. to exclude the PO files starting with
34+
1. Source code repo should point to `weblate://r-project/base-r-gui` (this is set to auto-poll the SVN repo)
35+
1. File format is usually `gettext PO file` (for strings extracted from R core and recommended packages), or e.g. iOS
36+
strings (for Mac GUI)
37+
1. Provide file mask, e.g. `src/library/base/po/*.po` or `src/library/compiler/po/R-*.po`
38+
1. Set a Language filter when needed to guide Weblate which files to pick up (e.g. to exclude the PO files starting with
3739
`R` (part of the "R files" component) for the "C files" component, something like `^(?!en$)[a-z][^.]+$`
3840

3941
### How to add a new package?
@@ -55,7 +57,7 @@ installation of Weblate to crowdsource the translation of your already extracted
5557
in short, the following steps are expected:
5658

5759
1. The Weblate admins create a [new component](#how-to-add-a-new-component) using your git/SVN repo
58-
2. Optionally set up push-back hooks to the `master` or other branch, so that new translations are available in the
60+
1. Optionally set up push-back hooks to the `master` or other branch, so that new translations are available in the
5961
original repo as well
6062

6163
### How to test the changes I made in Weblate?

web/Weblate-server.qmd

+16-16
Original file line numberDiff line numberDiff line change
@@ -134,23 +134,23 @@ _NB: Weblate links below assume you're logged in there, otherwise you'll be redi
134134
### To generate a report on the translation updates in a time period:
135135

136136
1. Visit <https://translate.rx.studio/projects/r-project/#reports>
137-
2. Select time period and generate report in rST format
138-
3. Convert ~markdown to HTML and share in the R Contributors slack group's #core-translation channel
137+
1. Select time period and generate report in rST format
138+
1. Convert ~markdown to HTML and share in the R Contributors slack group's #core-translation channel
139139

140140
### To submit a patch file on the translations found in Weblate but not in the trunk of the main R subversion repo:
141141

142142
The basic idea is to compare the Weblate repo (which copies the R subversion repo, but also adds translations provided _via_ Weblate) to the "official" R sources; any difference in .po files should be submitted as a patch.
143143

144144
1. Make sure the Weblate repo is fully up-to-date. Check status at https://translate.rx.studio/projects/r-project/#repository -- be sure there are no `Update` or `Commit` actions needed.
145-
2. Get the two repos cloned on any machine:
145+
1. Get the two repos cloned on any machine:
146146

147147
```sh
148148
git clone -o weblate https://translate.rx.studio/git/r-project/base-r-gui/ # remote #1: Weblate source
149149
git remote add svn git remote add svn [email protected]:r-devel/r-svn.git # remote #2: SVN source
150150
git fetch svn master # retrieve the latest from SVN
151151
```
152152

153-
3. Revert unwanted changes to reduce noise, e.g. something like:
153+
1. Revert unwanted changes to reduce noise, e.g. something like:
154154

155155
```r
156156
library(data.table)
@@ -203,14 +203,14 @@ The basic idea is to compare the Weblate repo (which copies the R subversion rep
203203
system2("sed", c("-i", "'s/[email protected]/bugs.r-project.org/'", po_summary$filename))
204204
```
205205

206-
4. Generate a patch file from the diff, going back to the most recent commit with translations merged, e.g.
206+
1. Generate a patch file from the diff, going back to the most recent commit with translations merged, e.g.
207207

208208
```sh
209209
# NB: _not_ 'git diff weblate/master svn/master' since we've just deleted the empty .po files locally
210210
git diff svn/master --no-prefix -- "*.po"
211211
```
212212

213-
8. Share the patch file on the R Contributors Slack group's #core-translation channel and kindly ping @MichaelLawrence for his assistance on getting the patch file applied on the trunk of R dev to get it merged. We should do this ~once per quarter.
213+
1. Share the patch file on the R Contributors Slack group's #core-translation channel and kindly ping @MichaelLawrence for his assistance on getting the patch file applied on the trunk of R dev to get it merged. We should do this ~once per quarter.
214214

215215
## Maintenance
216216

@@ -241,20 +241,20 @@ rebase refs/remotes/origin/trunk: command returned error: 1
241241
Weblate will provide a suggestion on how to fix, but in short:
242242

243243
1. SSH to the Weblate server
244-
2. Make a backup on the Git repo before messing with the rebase process:
244+
1. Make a backup on the Git repo before messing with the rebase process:
245245

246246
```sh
247247
tar -zcvf /root/base-r-gui-repo-$(date '+%Y-%m-%d').tar.gz \
248248
/var/lib/docker/volumes/weblate-docker_weblate-data/_data/vcs/r-project/base-r-gui
249249
```
250250

251-
3. Attach the Docker container (this image is offered by `weblate`):
251+
1. Attach the Docker container (this image is offered by `weblate`):
252252

253253
```sh
254254
sudo docker exec -ti weblate-docker_weblate_1 bash
255255
```
256256

257-
4. Enter the git folder:
257+
1. Enter the git folder:
258258

259259
```sh
260260
cd app/data/vcs/r-project/base-r-gui
@@ -266,14 +266,14 @@ Weblate will provide a suggestion on how to fix, but in short:
266266
/var/lib/docker/volumes/weblate-docker_weblate-data/_data/vcs/r-project/base-r-gui
267267
```
268268

269-
5. Pull from SVN and start the rebase process to see the actual errors:
269+
1. Pull from SVN and start the rebase process to see the actual errors:
270270

271271
```sh
272272
git svn fetch
273273
git svn rebase
274274
```
275275

276-
6. Optionally, if not yet done, install [helpers](https://github.com/JulienPalard/po3way) to make it easier to deal with the git conflicts (inside Docker). Start Docker as root to install `po3way` system-wide:
276+
1. Optionally, if not yet done, install [helpers](https://github.com/JulienPalard/po3way) to make it easier to deal with the git conflicts (inside Docker). Start Docker as root to install `po3way` system-wide:
277277

278278
```sh
279279
$ sudo docker exec -u root -ti weblate-docker_weblate_1 bash
@@ -307,7 +307,7 @@ Weblate will provide a suggestion on how to fix, but in short:
307307
*.pot merge=po3way
308308
```
309309

310-
7. Resolve the conflict via a text editor, then continue. Let's say `src/library/base/po/es.po` is affected:
310+
1. Resolve the conflict via a text editor, then continue. Let's say `src/library/base/po/es.po` is affected:
311311

312312
```sh
313313
mcedit src/library/base/po/es.po
@@ -339,14 +339,14 @@ In case of any questions, reach out to them on the R-devel Slack's `#core-transl
339339
To add a new admin in the Weblate app:
340340

341341
1. Go to the [Users page](https://translate.rx.studio/manage/users)
342-
2. Select the user
343-
3. Go to "Groups"
344-
4. Add to the "The R Project for Statistical Computing / Administration" group
342+
1. Select the user
343+
1. Go to "Groups"
344+
1. Add to the "The R Project for Statistical Computing / Administration" group
345345

346346
To grant SSH access:
347347

348348
1. Share your public key with one of the admins, who will add that to `~/.ssh/authorized_keys`
349-
2. Ask for the SSH config from one of the admins
349+
1. Ask for the SSH config from one of the admins
350350

351351
### Team leaders
352352

web/index.qmd

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ So if you want to start, you can contribute by following these steps:
1717
1. Sign up to the [R Contributors Slack](https://contributor.r-project.org/slack) and introduce yourself in the
1818
#core-translations channel;
1919

20-
2. Create an account on [Weblate](https://translate.rx.studio/) (currently maintained by
20+
1. Create an account on [Weblate](https://translate.rx.studio/) (currently maintained by
2121
[@daroczig](https://twitter.com/daroczig)) and read the Translations chapter on the [R Development
2222
guide](https://contributor.r-project.org/rdevguide/);
2323

24-
3. Read the [Conventions for translation](Conventions_for_Languages/index.qmd)
24+
1. Read the [Conventions for translation](Conventions_for_Languages/index.qmd)
2525
section of this Wiki, for some conventions that should be followed;
2626

27-
4. Read the guidelines for the specific language you want to contribute to. If a guideline for your language doesn't
27+
1. Read the guidelines for the specific language you want to contribute to. If a guideline for your language doesn't
2828
exist yet, please feel free to submit a pull request and create it.
2929

3030
|Language |
@@ -38,7 +38,7 @@ exist yet, please feel free to submit a pull request and create it.
3838
|[Portuguese (Brazilian)](Conventions_for_Languages/Brazilian‐Portugese-specific-translations.qmd)|
3939
|[Spanish](Conventions_for_Languages/Spanish-specific-translations.qmd)|
4040

41-
5. You can start translating!
41+
1. You can start translating!
4242

4343
You can check the
4444
[guide](https://contributor.r-project.org/rdevguide/message-translations.html#how-to-contribute-new-translations) on how

0 commit comments

Comments
 (0)