Constructor¶

process(%)

Эта функция может выполнить все, что вам нужно, с документом po4a за один вызов. Ее аргументы должны быть упакованы в виде хэша. ДЕЙСТВИЯ:

new(%)

Создать новый po4a-документ. Допустимые параметры (в хэше, передаваемом в качестве параметра):

Манипулирование файлами документов¶

read($$$)

Добавить содержимое другого входного документа в конец существующего массива "@{$self->{TT}{doc_in}}".

Эта функция принимает два обязательных аргумента и один необязательный. * Имя файла, считываемого с диска; * Имя используемое в качестве имени файла при создании ссылки в PO-файле; * Кодировка, используемая при чтении файла (по умолчанию UTF-8)

Массив "@{$self->{TT}{doc_in}}" содержит данные входного документа в виде массива строк с чередующимися значениями.
* Строка $textline содержит каждую строку входных текстовых данных.
* Строка "$filename:$linenum" содержит ее местоположение и называется
"ссылкой" ("linenum" начинается с 1).

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

write($)

Записывает переведенный документ в указанное имя файла.

Эти переведенные данные предоставляются с помощью:
* "$self->docheader()" содержит текст заголовка для плагина, и
* "@{$self->{TT}{doc_out}}" содержит в массиве каждую строку главного переведенного текста.

Манипулирование PO-файлами¶

readpo($)

Добавляет содержимое файла (имя которого передано в качестве аргумента) в существующий входной PO-файл. Старое содержимое не удаляется.

writepo($)

Записывает извлеченный PO-файл в файл в указанным именем.

stats()

Возвращает некоторую статистику о выполненном на данный момент переводе. Обратите внимание, что это не та статистика, которая выводится командой msgfmt --statistic.Здесь приведена статистика о недавнем использовании файла PO, в то время как msgfmt сообщает о состоянии файла. Это обертка для функции Locale::Po4a::Po::stats_get, применяемой к входному PO-файлу. Пример использования:

    ($percent,$hit,$queries) = $document->stats();
    print "We found translations for $percent\%  ($hit from $queries) of strings.\n";
    

Манипулирование аддендумами¶

addendum($)

Пожалуйста, обратитесь к po4a(7) для получения более подробной информации о том, что такое аддендумы и как переводчикам следует их писать. Чтобы применить аддендум к переведенному документу, просто передайте его имя в эту функцию, и все готово ;)

В случае ошибки эта функция возвращает числовое значение, отличное от нуля.

Получение входных данных, предоставление выходных данных¶

Для получения входных данных и возврата выходных данных предусмотрены четыре функции. Они очень похожи на shift/unshift и push/pop в Perl.

 * Оператор shift в Perl удаляет из массива первый элемент и возвращает его значение.
 * Оператор unshift в Perl добавляет элемент в начало массива.
 * Оператор pop в Perl удаляет из массива последний элемент и возвращает его значение.
 * Оператор push в Perl добавляет элемент в конец массива.

Первая пара относится к вводу, а вторая -- к выводу. Мнемоника: при вводе вас интересует первая строка -- то, что дает shift, а при выводе вы хотите добавить ваш результат в конец, как это делает push.

shiftline()

Эта функция возвращает первую строку для анализа и соответствующую ссылку (упакованную в виде массива) из массива "@{$self->{TT}{doc_in}}" и удаляет эти первые 2 элемента массива. Здесь ссылка представлена строкой "$filename:$linenum".

unshiftline($$)

Отменяет последнее действие shiftline(). Строка и соотвествующая ссылка помещаются обратно в начало массива "{$self->{TT}{doc_in}}".

pushline($)

Помещает новую строку в конец массива "{$self->{TT}{doc_out}}".

popline()

Удаляет из массива "{$self->{TT}{doc_out}}" последний элемент и возвращает его значение.

Пометка строк как переводимых¶

Предусмотрена одна функция для обработки текста, который должен быть переведен.

translate($$$)

Обязательные агрументы:

  $self->translate("string","ref","type",
                   'wrap' => 1);

Прочие функции¶

verbose()

Возвращает значение 1, если параметр verbose был передан во время создания TransTractor.

debug()

Возвращает значение 1, если параметр debug был передан во время создания TransTractor.

get_in_charset()

Эта функция возвращает кодировку, которая была предоставлена в качестве основной

get_out_charset()

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

Эта функция будет использовать выходную кодировку, указанную в командной строке. Если кодировка не была указана, будет использоваться кодировка, указанная во входном PO-файле, если же во входном PO-файле кодировка имеет значение "CHARSET", функция вернет кодировку входного документа, в этом случае перекодирование выполнено не будет.