LOCALE::PO4A::ASCIIDOC.3PM(1)

НАЗВА
Locale::Po4a::AsciiDoc — перетворення документів AsciiDoc на файли PO, і навпаки

ОПИС
Метою проєкту po4a (PO для усього) є спрощення перекладу (та, що ще цікавіше, супровід перекладів) за допомогою інструментів gettext у областях, де такий переклад спочатку не передбачався, зокрема у документації.

Locale::Po4a::AsciiDoc — модуль, який допомагає у перекладі документації у форматі AsciiDoc.

ПАРАМЕТРИ, ЯКІ МОЖНА ПЕРЕДАВАТИ ЦЬОМУ МОДУЛЮ
Ось параметри, які можна передавати цьому модулю:

definitions
    Назва файла, що містить визначення для po4a, як це визначено у розділі НАЛАШТОВУВАННЯ НА МІСЦІ. Ви можете скористатися цим параметром, якщо вставляння визначень до документа, який ви перекладаєте, є неможливим.

    У файлі визначень рядки мають починатися не з двох символів похилої риски, а безпосередньо із po4a:.

entry
    Список відокремлених пробілами записів атрибутів, вміст яких ви хочете перекладати. Типово, атрибути не перекладаються.

macro
    Список відокремлених пробілами визначень макросів.

style
    Список відокремлених пробілами визначень стилів.

forcewrap
    Увімкнути автоматичне перенесення рядків у блоках, які не є блоками з наперед визначеним форматуванням, навіть якщо результат може бути оброблено з помилками засобами форматування AsciiDoc.

    Типово, po4a не переноситиме рядки у створених файлах AsciiDoc, оскільки уникнути впливу перенесення рядків на форматування тексту у таких файлах можна лише вручну. Розгляньмо, наприклад, такий пункт списку:

     * довге речення, яке завершується цифрою 1. Друге речення.

    Якщо перенесення рядків призводить до наведеного нижче варіанта, пункт буде поділено — з'явиться упорядкований підлеглий список. Погіршує ситуацію і те, що помилку зможуть помітити лише ті, хто користуватиметься перекладом.

     * довге речення, яке завершується цифрою
       1. Друге речення.

    Зауважте, що якщо рядки у файлі, який буде створено po4a, не буде перенесено, ніяких проблем виникнути не повинно — ці файли все одно буде оброблено автоматично. Їх не слід розглядати з точки зору подальшого редагування людиною.

    Використання цього параметра надає змогу po4a створювати файли AsciiDoc із зручнішим для редагування форматуванням, але може призвести до помилок під час обробки природними для формату файлів засобами форматування.

noimagetargets
    Типово, записи блоків зображень можна перекладати, щоб надати можливість перекладачеві вказати зображення із перекладеними повідомленнями. Вимкнути переклад цих блоків можна за допомогою цього параметра.

tablecells
    Цей параметр є прапорцем, який вмикає поділ за підтаблицями у вмісті комірки. Поділ обмежено вмістом комірки, без обробки даних всередині.

compat
    Перемикає правила обробки для сумісності із різними інструментами. Доступними значеннями є «asciidoc» і «asciidoctor». Asciidoctor має строгіші правила обробки, зокрема вимагає збереження довжини початкових і завершальних обв'язок блоків.

nolinting
    Вимкнути повідомлення щодо правильності коду. Якщо початковий код не можна виправити з метою поліпшення структурування документа, ці повідомлення не мають сенсу.

cleanspaces
    Вилучити зайві пробіли з частин початкового тексту у режимі без перенесення рядків. Корисно, якщо інструменти перекладу є чутливими до кількості пробілів.

yfm_keys
    Список відокремлених комами ключів, які слід обробляти для перекладу у вступній частині YAML. Усі інші ключі буде пропущено. Відповідність ключів встановлюватиметься з врахуванням регістру. Якщо yfm_paths і yfm_keys використано разом, значення буде включено, якщо буде встановлено відповідність хоч за одним параметром. Значення масивів завжди перекладатимуться, якщо не вказано параметр yfm_skip_array.

yfm_skip_array
    Не перекладати значення масивів у вступному розділі YAML.

yfm_paths
    Список відокремлених комами шляхів хешів, які слід обробляти для видобування у вступному розділі YAML. Усі інші шляхи буде пропущено. Відповідність шляхів встановлюватиметься з врахуванням регістру. Якщо yfm_paths і yfm_keys використано разом, значення буде включено, якщо буде встановлено відповідність хоч за одним параметром. Значення масивів завжди перекладатимуться, якщо не вказано параметр yfm_skip_array.

НАЛАШТОВУВАННЯ НА МІСЦІ
Налаштувати модуль AsciiDoc можна рядками, які починаються з //po4a:. Такі рядки вважатимуться командами, які віддаються засобу обробки. Передбачено такі команди:

//po4a: macro назва[список атрибутів]
    Цей рядок докладно описує параметри макроса; назва має бути коректною назвою макроса і має завершуватися символом підкреслювання, якщо ціль має бути перекладено.

    Аргумент список атрибутів є списком відокремлених комами значень, які містять дані щодо придатних до перекладу аргументів. У цьому списку містяться або номери, для визначення позиційних параметрів, або іменовані атрибути.

    Якщо перед назвою стоятиме символ «плюс» (+), макрос і його аргументи перекладатимуться як ціле. У цьому випадку немає потреби у визначенні списку атрибутів, але квадратні дужки все ж доведеться дописати.

//po4a: style [список атрибутів]
    Цей рядок надає змогу докладно описати атрибути стилю, які слід перекласти.

    Аргумент список атрибутів є списком відокремлених комами значень, які містять дані щодо придатних до перекладу аргументів. У цьому списку містяться або номери, для визначення позиційних параметрів, або іменовані атрибути. Перший атрибут є назвою стилю, його не буде перекладено.

    Якщо перед назвою стилю вказано символ «плюс» (+), список атрибутів перекладається як ціле. У такому випадку немає потреби у визначенні атрибутів, які слід перекладати.

    Якщо перед назвою стилю вказано символ «мінус» (-), список атрибутів не перекладається.

    Якщо до назви стилю додано символ відсотків (%), стиль буде оброблено буквально. Рядки у абзаці або блоці такого стилю буде збережено у файлах po, а відповідні запис буде позначено як записи без перенесення рядків.

//po4a: entry назва
    Ця команда оголошує запис атрибута як придатний до перекладу. Типово, записи атрибутів не перекладаються.

СТАН ЦЬОГО МОДУЛЯ
Успішно перевірено на простих файлах AsciiDoc.

АВТОРИ
 Nicolas François <nicolas.francois@centraliens.net>
 Denis Barbier <barbier@linuxfr.org>

АВТОРСЬКІ ПРАВА ТА ЛІЦЕНЗУВАННЯ
 © Nicolas FRANÇOIS <nicolas.francois@centraliens.net>, 2005–2008.
 © Denis BARBIER <barbier@linuxfr.org>, 2012.
 © Martin Quinson <mquinson#debian.org>, 2017.

Ця програма є вільним програмним забезпеченням; ви можете поширювати її і/або вносити до неї зміни за умов дотримання GPL версії 2.0 або пізнішої (див. файл COPYING).