com doc/ru: Руководс тво по пере воду: .yaspellerrc.js CONTRIBUTIN G.md README.md translation_standards.xml

[email protected] (Sergey Panteleev) Wed, 13 Jan 2021 09:59:16 +0000
Newsgroups php.doc.ru
Message-ID <[email protected]>
Commit:    293b78477df1423aef48df775e3fd1b423a05f49
Author:    Sergey Panteleev <[email protected]>         Tue, 12 Jan 2021 14:34:12 +0300
Parents:   dd01f13bf2ca4cd1b1774f3da54ad8d47941472e
Branches:  master

Link:       http://git.php.net/?p=doc/ru.git;a=commitdiff;h=293b78477df1423aef48df775e3fd1b423a05f49

Log:
Руководство по переводу

Closes GH-11

Changed paths:
  M  .yaspellerrc.js
  A  CONTRIBUTING.md
  M  README.md
  D  translation_standards.xml
diff_293b78477df1423aef48df775e3fd1b423a05f49.txt (text/plain, 11.5 KB)
diff --git a/.yaspellerrc.js b/.yaspellerrc.js
index 807a7eb44..ee1ed281b 100644
--- a/.yaspellerrc.js
+++ b/.yaspellerrc.js
@@ -191,6 +191,7 @@ module.exports = {
     "проприетарност.*",
     "прослушивател.*",
     "псевдо(объект|массив|тип|терминал).*",
+    "пул.*",
     "пуш.*",
     "радиокнопк.*",
     "разблокируется",
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..4766ee3dc
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,93 @@
+# Участие в переводе
+
+## Оформление
+
+- Символ отступа — это пробел (табуляция в файлах `.xml` запрещена)
+- В документации используется буква `Ё`. Обращайте на это, пожалуйста, внимание.
+
+## Рекомендации по переводу
+
+Комментарии к коду должны быть переведены,
+описание вывода, например, `echo "You reload page $num times";` также.
+
+Исключение к правилу перевода английских слов в коде составляет случай, когда
+функция будет по-разному обрабатывать английский и русский варианты, например,
+`strtolower("Alex") === "alex"`, но `strtolower("Алексей") !== "алексей"`.
+
+Заголовок `<title><function>func_name</function> example</title>`
+всегда переводится как `<title>Пример использования <function>func_name</function></title>`.
+
+## Соглашение по переводу
+
+| Оригинал | Перевод |
+| -------- | ------- |
+| Application | Приложение |
+| Cache | Кеш |
+| Callback function | Callback-функция |
+| Child | Потомок, дочерний элемент (узел) |
+| CLI | Интерфейс командной строки |
+| Code (php-code) | Код, PHP-код |
+| Coding standards | Стандарты кодирования |
+| Commandline program | Консольная программа |
+| Commit | Фиксация (например, транзакции) |
+| Default, by default | По умолчанию (пишется без дефиса) |
+| Directory | Директория |
+| Entry | Элемент (существительное, для массивов, списков и прочих структур) |
+| Extension | Модуль |
+| Features/functionality | Возможности, функциональность |
+| Hash | Хеш |
+| HTML entity | HTML-сущность |
+| HTTP-Authentication | HTTP-аутентификация |
+| Hypertext preprocessor | Препроцессор гипертекста |
+| Handle | Дескриптор (например, cURL) |
+| ID (БД) | ID |
+| ID (в тексте) | Идентификатор |
+| Legacy (system, server) | Устаревшая система, сервер, протокол |
+| Legacy support | Поддержка старых версий |
+| Magic quotes | "Магические" кавычки |
+| Magic constants/methods/numbers | "Магические" константы/методы/числа |
+| Multibyte string | Многобайтовая строка |
+| Node | Узел |
+| Optional | Необязательный |
+| Override | Переопределять |
+| Otherwise | В противном случае, иначе |
+| On success | В случае успешного выполнения |
+| On fail | В случае возникновения ошибки |
+| Parameter(s) | Параметр(ы), аргумент(ы) |
+| Parser | Парсер |
+| Parsing | Разбор (например, разбор строки) |
+| Prefetch | Предварительная выборка |
+| PCRE | Perl-совместимые регулярные выражения |
+| Private | Закрытый |
+| Public | Общедоступный |
+| Read-only | Доступен только для чтения |
+| Result set | Результирующий набор |
+| Returns | Возвращает |
+| SAPI | Интерфейс разработки серверных приложений |
+| Script | Скрипт |
+| Single quotes | Одинарные кавычки |
+| Stream | Поток |
+| Shared block | Общая блокировка |
+| Shared memory | Разделяемая память |
+| SQL query | Запрос SQL, SQL-запрос |
+| SQL | Структурированный язык запросов |
+| Throw exception | Выбросить исключение |
+| Timezone, time zone | Временная зона |
+| Token | Лексема |
+| Tokenizer | Лексер |
+| Trait | Трейт |
+| Writable | Доступен для записи |
+| Wrapper | Обёртка |
+| URL wrapper | Обёртка URL |
+| To throw a warning/error | Вызвать предупреждение/ошибку |
+
+## Не переводятся
+
+- Cookie
+- PEAR
+- PECL
+- PHP Group
+- PHP
+- Referer
+- Имена переменных
+- Типы переменных (integer, string, bool, resource)
diff --git a/README.md b/README.md
index 85f26f0f3..4fde046db 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,12 @@
 # Русский перевод документации PHP
 
-[![Slack Status](https://img.shields.io/badge/[email protected]?logo=slack)](https://join.slack.com/t/ruphpdoc/shared_invite/zt-ax1czx68-c3_XSVhsgzYJCOslmwvJkQ)
-![Sync](https://github.com/php/doc-ru/workflows/Build%20Test/badge.svg)
+[![Slack Status](https://img.shields.io/badge/[email protected]?logo=slack)](https://join.slack.com/t/ruphpdoc/shared_invite/zt-ax1czx68-c3_XSVhsgzYJCOslmwvJkQ)
+![Build Test](https://github.com/php/doc-ru/workflows/Build%20Test/badge.svg)
+![Spell checking](https://github.com/php/doc-ru/workflows/Spell%20checking/badge.svg)
 
-## Руководство
+## Помощь
 
-- [Рекомендации по переводу](translation_standards.xml)
-
-## Оформление
-
-- Символ отступа — это пробел (табуляция в файлах `.xml` запрещена)
+Если вы хотите поучаствовать в переводе, пожалуйста, ознакомьтесь с [данным руководством](CONTRIBUTING.md).
 
 ## Принятие пулреквестов
 
@@ -22,7 +19,7 @@
 bash scripts/apply_patch.sh %PR_NUM%
 
 # То же самое, но вручную:
-curl http://url_of_github_patch.patch | git am
+curl -L "http://url_of_github_patch.patch" | git am
 git commit --am # Добавить в конец "Closes GH-%PR_NUM%"
 git push origin
 ```
diff --git a/translation_standards.xml b/translation_standards.xml
deleted file mode 100644
index a076ff154..000000000
--- a/translation_standards.xml
+++ /dev/null
@@ -1,96 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<root>
-<![CDATA[
-Рекомендации по переводу:
-
- ---------------------------
-|Что    -    Как переводить |
- ---------------------------
-
-application - приложение
-cache - кеш
-callback function - callback-функция
-child - потомок, дочерний элемент (узел)
-children - потомки
-CLI - интерфейс командной строки
-code (php-code) - код, php-код
-coding standards - стандарты кодирования
-commandline program - консольная программа
-commit - фиксация (например, транзакции)
-cookie - cookie
-default, by default - по умолчанию (пишется без дефиса)
-directory - директория
-entry - элемент (существительное, для массивов, списков и прочих структур)
-extension - модуль
-features/functionality - возможности, функциональность
-hash - хеш
-HTML entity - HTML-сущность
-HTTP-Authentication - HTTP-аутентификация
-Hypertext preprocessor - препроцессор гипертекста
-handle - дескриптор (например, cURL)
-ID (БД) - ID
-id (в тексте) - идентификатор
-legacy (system, server) - устаревшая система, сервер, протокол.
-legacy support - поддержка старых версий
-magic quotes - "магические" кавычки
-magic constants/methods/numbers - "магические" константы/методы/числа
-multibyte string - многобайтовая строка
-node - узел
-optional - необязательный
-override - переопределять
-otherwise - в противном случае, иначе
-parameter(s) - параметр(ы), аргумент(ы)
-parser - парсер
-parsing - разбор (например, разбор строки)
-prefetch - предварительная выборка
-PCRE - Perl-совместимые регулярные выражения
-PEAR - PEAR
-PECL - PECL
-PHP Group - PHP Group
-PHP - PHP
-private - закрытый
-public - общедоступный
-read-only - доступен только для чтения
-referer - referer
-result set - результирующий набор
-returns - возвращает
-SAPI - интерфейс разработки серверных приложений
-script - скрипт
-single quotes - одинарные кавычки
-stream - поток
-shared block - общая блокировка
-shared memory - разделяемая память
-SQL query - запрос SQL
-SQL - структурированный язык запросов
-throw exception - выбросить исключение
-timezone, time zone - временная зона
-token - лексема
-tokenizer - tokenizer (лексер)
-trait - трейт
-true/false/null - использовать специальные сущности &false;, &true; и &null;
-writable - доступен для записи
-wrapper - обёртка
-URL wrapper - обёртка URL
-to throw a warning/error - вызвать предупреждение/ошибку
-имена переменных - не переводятся
-типы переменных (integer, string, bool, resource etc.) - не переводятся
-
-+----------------+
-|Перевод примеров|
-+----------------+
-
-Комментарии к коду должны быть переведены,
-описание вывода (например, echo "You reload page $num times";) также.
-Исключение к правилу перевода английских слов в коде составляет случай, когда
-функция будет по-разному обрабатывать английский и русский варианты, например,
-strtolower("Alex") === "alex", но strtolower("Алексей") !== "алексей".
-
-Заголовок <title><function>func_name</function> example</title>
-всегда переводится как <title>Пример использования <function>func_name</function></title>
-
-
-Этот список не претендует на полноту.
-Если у вас есть вопросы, комментарии или предложения по его
-содержанию - обращайтесь в лист [email protected]
-]]>
-</root>