Scroll to navigation

Locale::Po4a::AsciiDoc(3pm) Инструменты Po4a Locale::Po4a::AsciiDoc(3pm)

НАЗВАНИЕ

Locale::Po4a::AsciiDoc: преобразование документов AsciiDoc в/из PO-файлы

ОПИСАНИЕ

Целью проекта po4a (PO for anything, PO везде и для всего) является облегчение процесса перевода (и что более важно — поддержки перевода), используя инструменты gettext в тех случаях, когда их применение может выглядеть неожиданным, например для документации.

Locale::Po4a::AsciiDoc — это модуль, предназначенным для помощи в переводе документации в формате AsciiDoc.

ПАРАМЕТРЫ ПРИНИМАЕМЫЕ ЭТИМ МОДУЛЕМ

Ниже приведены специфические для данного модуля параметры:
definitions
Имя файла с po4a-определениями (definitions), которые описаны в разделе ВСТРОЕННЫЕ НАСТРОЙКИ ПОВЕДЕНИЯ. Вы можете использовать этот параметр, если добавить эти определения непосредственно в переводимый документ не является возможным.

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

entry
Список атрибутов, разделённых пробелом, значения которых должны переводиться. По умолчанию ни какие атрибуты не считаются переводимыми.
macro
Список определений макросов (macro definitions), разделённых пробелом.
style
Список определений стилей (style definitions), разделённых пробелами.
noimagetargets
По умолчанию, дабы дать переводчикам возможность вставлять в документ локализованные версии изображений, ссылки на них являются переводимыми строками. Это можно изменить, указав данный параметр.
tablecells
Этот параметр является флагом, при указании которого таблицы будут разбиты на ячейки. Разбиение ограничивается только ячейками без какого-либо разбора их содержимого.
compat
Switch parsing rules to compatibility with different tools. Available options are "asciidoc" or "asciidoctor". Asciidoctor has stricter parsing rules, such as equality of length of opening and closing block fences.

ВСТРОЕННЫЕ НАСТРОЙКИ ПОВЕДЕНИЯ

Поведение модуля AsciiDoc может быть настроено строками в документе начинающимися с //po4a:. Эти строки рассматриваются, как команды данному парсеру. Возможно задать следующие команды:
//po4a: macro имя[список атрибутов]
Этот параметр позволяет описать, как именно нужно обрабатывать макрос и его параметры. Имя должно быть действительным именем макроса. Если цель (target) макроса должна быть переведена, то к имени оного должно быть добавлено подчёркивание.

список атрибутов — это список аргументов макроса, разделённых пробелом, которые также должны быть переведены. Этот список состоит из либо чисел, которые задают номера позиционных параметров, либо непосредственно самих имёна оных атрибутов.

Если в начало имени добавлен знак плюс (+), то макрос и все его аргументы переводятся как единое целое. В этом случае нет необходимости задавать список аргументов, но скобки всё равно должны присутствовать.

//po4a: style [список атрибутов]
Этот параметр позволяет описать, какие именно атрибуты стиля должны переводиться.

список атрибутов — это список аргументов, разделённых запятыми, которые должны быть переведены. Этот список содержит либо числа, которые задают номера позиционных параметров, либо непосредственно сами имена оных. При этом первым аргументом считается имя стиля, которое в любом случае не будет переведено.

Если в начало имени стиля добавлен знак плюс (+), то весь список атрибутов переводится как единое целое. В этом случае нет необходимости задавать список атрибутов.

Если в начало имени стиля добавлен знак минус (-), то его атрибуты не будут переводиться.

//po4a: entry имя
Этот параметр объявляет значение атрибута переводимым. По умолчанию все оные не являются таковыми.

СОСТОЯНИЕ ЭТОГО МОДУЛЯ

Успешно протестирован на простых файлах AsciiDoc.

АВТОРЫ

 Николя Франсуа (Nicolas François) <nicolas.francois@centraliens.net>
 Денис Барбье (Denis Barbier) <barbier@linuxfr.org>

АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИИ

 Copyright © 2005-2008 Николя Франсуа (Nicolas FRANÇOIS) <nicolas.francois@centraliens.net>.
 Copyright © 2012 Денис Барбье (Denis BARBIER) <barbier@linuxfr.org>.
 Copyright © 2017 Мартин Кенсон (Martin Quinson) <mquinson#debian.org>.

Данная программа является свободным программным обеспечением; вы можете распространять и/или изменять её на условиях Универсальной общественной лицензии (GPL) GNU (см. файл COPYING).

2020-08-19 Инструменты Po4a