Памятка для переводчика

Статистика: Символов — 2 914/2 491 без пробелов (2 383/2 061 без кода):, слов — 323
Разметка: Wiki
== Словарь терминов ==
Термины с особым переводом (не транслитом):
##    
    = action действие (контроллера)
    = closure замыкание
    = composer составитель (шаблона), не путать с ((https://getcomposer.org Composer))
    = configuration настройка
    = cookie cookie (не переводится)
    = eager активная (загрузка)
    = environment среда или окружение
    = field поле (таблицы, класса)
    = input ввод, не путать с //(text) input// - поле (ввода)
    = instance экземпляр 
    = log журнал или лог 
    = manager управляющий (класс)
    = manual руководство
    = namespace пространство имён
    = pagination страничный вывод
    = redirect переадресация или перенаправление
    = repository хранилище (кода)
    = response ответ или отклик
    = route/routing маршрут/маршрутизация
    = service provider == поставщик услуг
    = tag метка или тег (не "т__э__г" - см. [[https://ru.wikipedia.org/wiki/Тег#cite_note-1 орфографический словарь]])
    = template шаблон (HTML и пр.) или заготовка (запроса и пр.)
    = unit test == юнит-тест
    = validation проверка (ввода)
    = view представление или шаблон
##

== Оформление ==
=== Внимание ==
%%(t)
.(alert)
Текст абзаца.
%%
Либо:
%%(t)
Текст (!!(alert) сообщение!!), продолжение.
%%

.(alert)
Текст абзаца.

=== Примечание переводчика ==
Можно использовать, когда нужно что-либо уточнить, чего нет в оригинале.
%%(t)
.(tl_note)
Абзац-примечание. - //прим. пер.//
%%
Либо:
%%(t)
Текст (!!(tl_note) строчное примечание - //прим. пер.//!!), продолжение.
%%

.(tl_note)
Абзац-примечание. - //прим. пер.//

== Версионность в документации ==
=== **DOCVER** - версия перевода ==
Каждая переводимая статья должна содержать указатель на версию в английском Git, с которого был сделан перевод (т.е. на какой момент актуальна переведённая документация). Делается это в формате:

%%(t)
{{DOCVER ветка=хэш-коммита дата-коммита время-коммита, ветка-2=...}}
%%

Например:

%%(t)
{{DOCVER 4.2=de58abc604bdfe0fbaffe4f35ad48e12da78a4b5 16.10.2014 1:18}}
%%

{{DOCVER 4.2=de58abc604bdfe0fbaffe4f35ad48e12da78a4b5 16.10.2014 1:18}}

Так как перевод - это слияние всех веток (4.х), то если переводимая статья - часть нескольких веток, то каждая из них указывается в **DOCVER** через запятую. Порядок веток в списке не важен (4.2, затем 4.1, или наоборот).

Если в статье есть %%(t){{TOC}}%%, то %%(t){{DOCVER}}%% идёт **после** него.

=== **DOCNEW** - новые элементы в переводе ==
Когда в английской версии, в любой из веток, добавляется новый элемент (функция, параметр, класс, раздел и т.п., а не простое незначительное исправление), которого не было в младшей ветке (старшая = 4.2, младшая = 4.1, для которой младшая = 4.0 и т.п.), то этот элемент оборачивается в **DOCNEW**:

%%(t)
%%(DOCNEW ветка=хэш-коммита дата-коммита время-коммита, ветка-2=...)
... текст, разметка ...
~%%
%%

Формат идентичен формату **DOCVER**. Если элемент появился в нескольких ветках сразу - перечисляются все, в любом порядке.

Между первой и последней строками (~%%) может быть любая разметка. Однако если там нужно использовать блочный код, то его собственные ~%% превращаются в ~~%%. Например:

%%(t)
%%(DOCNEW 4.2=de58abc604bdfe0fbaffe4f35ad48e12da78a4b5 16.10.2014 1:18)
Добавлен параметр **$format**. Пример:
~~%%
func('format');
~~%%
~%%
%%

%%(DOCNEW 4.2=de58abc604bdfe0fbaffe4f35ad48e12da78a4b5 16.10.2014 1:18)
Добавлен параметр **$format**. Пример:
~%%
func('format');
~%%
%%

Если опустить тильды (~~), то **DOCNEW** закончится на первом ~%% (до кода).

**Внимание:** блок формата с параметрами (%%(t)~%%(param...)%%) экранировать не нужно, так как он не может закрыть блок и поэтому однозначно определяется как начало нового блока, а не конец уже открытого **DOCNEW**:
%%(t)
%%(DOCNEW 4.2=de58abc604bdfe0fbaffe4f35ad48e12da78a4b5 16.10.2014 1:18)
Пример:
%%(html)
<b>разметка</b>
~~%%
~%%
%%

%%(DOCNEW 4.2=de58abc604bdfe0fbaffe4f35ad48e12da78a4b5 16.10.2014 1:18)
Пример:
%%(html)
<b>разметка</b>
~%%
%%