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

НАЗВАНИЕ
Locale::Po4a::Text: преобразование обычных текстовых документов из/в PO-файлы

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

Locale::Po4a::Text — это модуль, предназначенным для помощи в переводе документов на другие [человеческие] языки.

Абзацы отделяются друг от друга пустыми строками (или строками, содержащими только пробелы и табуляции).

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

ПАРАМЕТРЫ ПРИНИМАЕМЫЕ ЭТИМ МОДУЛЕМ
Ниже приведены специфические для данного модуля параметры:

keyvalue
    Обрабатывать абзацы, которые выглядят как пара ключ-значение (разделённые двоеточием), как «буквальные» (verbatim, т.е. добавлять флаг "no-wrap" в PO-файл). Парой ключ-значение считается строка вида "ключ:значение", содержащая один или несколько символов не являющихся двоеточием или пробелом, за которыми следует двоеточие, за которым следует хотя бы один непробельный символ перед концом строки.

nobullets
    Отключить автоматическое обнаружение ненумерованных списков.

    По умолчанию при обнаружении маркера ненумерованного списка в начале строки, абзац не считается «дословным» (verbatim, т.е. флаг "no-wrap" в PO-файл не добавляется) и переводы строк в нём будут расставлены автоматически.

tabs=режим
    Указывает, как следует обрабатывать табуляции. режим может быть одним из:

    split
        Строки, содержащие только одну табуляцию будут разделять абзацы.

    verbatim
        Переносы строк в параграфах, содержащих табуляции, будут сохранены.

    По умолчанию табуляции считаются просто пробельными символами.

breaks=regex
    Регулярное выражение для строк, разделяющих абзацы. К этому регулярному выражению будут добавлены специальные символы (^$) так, чтобы оно сопоставляло всю строку целиком.

debianchangelog
    Обрабатывать верхний и нижний колонтитулы описаний пакетов, которые содержат только непереводимую информацию, специальным образом.

fortunes
    Обрабатывать формат fortune, в котором афоризмы разделяются строкой, состоящей из '%' или '%%', и '%%' используется в качестве начала комментария.

markdown
    Обрабатывать некоторую разметку, специфичную для текстов в формате Markdown.

yfm_keys (только для markdown)
    Список (разделённый запятыми) ключей из YAML-загаловка (Front Matter), которые нужно переводить. Все остальные ключи переводиться не будут. Ключи чувствительны к регистру. Если одновременно заданы и yfm_keys, и yfm_paths, то значения ключей будут переводиться, если они перечислены хотя бы в одном из этих параметров. Значения массивов всегда переводятся (если не задан параметр yfm_skip_array).

yfm_lenient (только для markdown)
    Допускать возникновение ошибок при анализе некорректного YAML-заголовка (Front Matter). Это особенно полезно, если ваш файл начинается с горизонтальной линии, а не собственно с YAML-заголовка, и вы по какой-то неизвестной причине убеждены, что вам необходимы продолжать использовать только три дефиса (и не больше) для обозначения этой линии линии.

yfm_paths (только для markdown)
yfm_paths
    Список (разделённый запятыми) «путей» из ключей хешей в YAML-заголовке (Front Matter), которые нужно переводить. Все остальные пути переводиться не будут. Пути чувствительны к регистру. Если одновременно заданы и yfm_keys, и yfm_paths, то значения ключей будут переводиться, если они перечислены хотя бы в одном из этих параметров. Значения массивов всегда переводятся (если не задан параметр yfm_skip_array).

yfm_skip_array (только для markdown)
    Не переводить значения массивов, присутствующих в YAML-загаловке (Front Matter).

control[=список_полей]
    Обрабатывать control-файлы Debian. Также можно задать список (разделённый запятыми) полей, значения которых будут извлечены для перевода.

neverwrap
    Сохранять все переносы. Это значит, что всё содержимое будет передано дословно (verbatim), даже простые текстовые абзацы.

СОСТОЯНИЕ ЭТОГО МОДУЛЯ
Успешно протестирован на простых текстовых файлах и файлах NEWS.Debian.

АВТОРЫ
 Николя Франсуа (Nicolas François) <nicolas.francois@centraliens.net>

АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИИ
 Copyright © 2005-2008 Николя Франсуа (Nicolas FRANÇOIS) <nicolas.francois@centraliens.net>.
 Copyright © 2008-2009, 2018 Йонас Смедегард (Jonas Smedegaard) <dr@jones.dk>.
 Copyright © 2020 Мартин Кенсон (Martin Quinson) <mquinson#debian.org>.

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