Skip to content

Commit 3f323bf

Browse files
authored
Merge pull request #61 from reactjs/another-guy/style-guide
Translate "style-guide.md"
2 parents 05c4976 + b56f71c commit 3f323bf

File tree

1 file changed

+118
-6
lines changed

1 file changed

+118
-6
lines changed

TRANSLATION.md

Lines changed: 118 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@
44

55
Пожалуйста, используйте этот ишью, если вы хотите что-то перевести и узнать.
66

7+
## Оглавление
8+
9+
* [Перевод на русский язык сайта reactjs.org](#Перевод-на-русский-язык-сайта-reactjsorg)
10+
* [Оглавление](#Оглавление)
11+
* [Общие правила](#Общие-правила)
12+
* [Слово живое и мёртвое](#Слово-живое-и-мёртвое)
13+
* [Универсальное руководство по стилю](#Универсальное-руководство-по-стилю)
14+
* [Идентификаторы заголовков](#Идентификаторы-заголовков)
15+
* [Текст в блоках кода](#Текст-в-блоках-кода)
16+
* [Внешние ссылки](#Внешние-ссылки)
17+
* [Соглашение по переводу (глоссарий)](#Соглашение-по-переводу-глоссарий)
18+
719
## Общие правила
820

921
- _Вы_ и его производные пишите с маленькой буквы
@@ -17,7 +29,7 @@
1729
- Исключайте отсылки на пол читателя (см. секцию 3 на [этой странице](http://www.un.org/ru/gender-inclusive-language/guidelines.shtml))
1830
- Названия статей и заголовки пишутся с одной заглавной буквы («Компоненты и пропсы», не «Компоненты и Пропсы»).
1931

20-
## Слово живое и мёртвое
32+
### Слово живое и мёртвое
2133

2234
Прежде чем переводить, почитайте пару страниц из «Слова живого и мёртвого» Норы Галь. Хотя бы эти две:
2335

@@ -49,7 +61,107 @@
4961

5062
Небольшие вольности в переводе допускаются, но только если они помогают передать смысл. Перевод не должен быть ни деревянным, ни фамильярным. Истина где-то посередине.
5163

52-
## Соглашение по переводу
64+
## Универсальное руководство по стилю
65+
66+
Описанные ниже правила пришли [из репозитория](https://github.com/reactjs/reactjs.org-translation/blob/master/style-guide.md), предписывающего стиль общий для **всех** языков, на которые переводится документация.
67+
68+
### Идентификаторы заголовков
69+
70+
Каждый заголовок имеет явный идентификатор:
71+
72+
```md
73+
## Try React {#try-react}
74+
```
75+
76+
**НЕ** переводите такие идентификаторы! Они используются для навигации. Изменение идентификатора неизбежно приведёт к поломке, если на документ ссылкаются извне, например так:
77+
78+
```md
79+
Прочтите [главу для начинающих](/getting-started#try-react), чтобы узнать больше.
80+
```
81+
82+
✅ Можно:
83+
84+
```md
85+
## Попробуйте React {#try-react}
86+
```
87+
88+
❌ НЕЛЬЗЯ:
89+
90+
```md
91+
## Попробуйте React {#попробуйте-react}
92+
```
93+
94+
Это сломает ссылку, приведённую в примере выше.
95+
96+
### Текст в блоках кода
97+
98+
Не переводите текст в блоках кода, кроме комментариев. А вот комментарии и текст в строках следует переводить, если они не относятся к коду.
99+
100+
Пример:
101+
```js
102+
// Example
103+
const element = <h1>Hello, world</h1>;
104+
ReactDOM.render(element, document.getElementById('root'));
105+
```
106+
107+
✅ МОЖНО:
108+
109+
```js
110+
// Пример
111+
const element = <h1>Hello, world</h1>;
112+
ReactDOM.render(element, document.getElementById('root'));
113+
```
114+
115+
✅ ТОЖЕ МОЖНО:
116+
117+
```js
118+
// Пример
119+
const element = <h1>Здравствуй, мир!</h1>;
120+
ReactDOM.render(element, document.getElementById('root'));
121+
```
122+
123+
❌ НЕЛЬЗЯ:
124+
125+
```js
126+
// Пример
127+
const element = <h1>Здравствуй, мир!</h1>;
128+
// "root" ссылается на идентификатор элемента.
129+
// Не переводите его!
130+
ReactDOM.render(element, document.getElementById('корень'));
131+
```
132+
133+
❌ СОВСЕМ НЕЛЬЗЯ:
134+
135+
```js
136+
// Пример
137+
const elemento = <h1>Здравствуй, мир!</h1>;
138+
ReactDOM.отрендери(elemento, documento.obtenerElementoPorId('корень'));
139+
```
140+
141+
### Внешние ссылки
142+
143+
Если внешняя ссылка ведёт к статье на [MDN] или [Wikipedia], и там существует статья на русском языке, исправьте ссылку, чтобы она указывала на русский вариант, даже если он неполный или требует улучшения.
144+
145+
[MDN]: https://developer.mozilla.org/en-US/
146+
[Wikipedia]: https://en.wikipedia.org/wiki/Main_Page
147+
148+
Пример:
149+
150+
```md
151+
React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object).
152+
```
153+
154+
✅ OK:
155+
156+
```md
157+
Элементы React [иммутабельны](https://ru.wikipedia.org/wiki/%D0%9D%D0%B5%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D1%8F%D0%B5%D0%BC%D1%8B%D0%B9_%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82).
158+
```
159+
160+
Для ссылок, у которых нету языковых эквивалентов (Stack Overflow, видео на YouTube, и т. д.), просто оставьте оригинальный вариант как есть.
161+
162+
## Соглашение по переводу (глоссарий)
163+
164+
**Пожалуйста, поддерживайте глоссарий в алфавитном порядке.**
53165

54166
| Оригинальный термин | Перевод |
55167
| ------------------ | ---------- |
@@ -116,18 +228,18 @@
116228
| props | пропсы *(мн. ч.)* |
117229
| production | продакшен |
118230
| production mode | продакшен-режим |
119-
| reducer | редюсер |
120-
| reuse | повторное использование, переиспользование |
121231
| React | React |
122232
| React element | React-элемент, элемент React |
123233
| reconciliation | согласование |
234+
| reducer | редюсер |
235+
| ref | реф *(ед. ч.)* |
236+
| refs | рефы *(мн. ч.)* |
124237
| render(ing) | рендер, рендерить, отрендерить |
125238
| renderer | рендерер (*напр., поверхностный рендерер*) |
126239
| re-render(ing) | (по контексту) рендер, повторный рендер, последующий рендер, отрендерить снова |
127240
| render prop | рендер-проп *(ед. ч.)* |
128241
| render props | рендер-пропсы *(мн. ч.)* |
129-
| ref | реф *(ед. ч.)* |
130-
| refs | рефы *(мн. ч.)* |
242+
| reuse | повторное использование, переиспользование |
131243
| (previous/next) section | (предыдущая/следующая) глава *(только в разделе Основные понятия)* |
132244
| shallow | поверхностное (сравнение, равенство), поверхностный (рендеринг) |
133245
| side effect | побочный эффект |

0 commit comments

Comments
 (0)