3. Небольшой словарь

Аннотация

Мы объясним все термины, используемые в документации по Borges: проект, автор, инициалы автора, документ, суб-документ, модуль, статус модуля, атом, ревизия атома и т.п.

Замечание

Термины представлены без какой-либо упорядоченности.

Автор

Автором может быть редактор, переводчик или рецензент модуля. Вообще говоря, понятие «автора» ограничивается создателем (в данном случае писателем) чего-либо, но в Borges под авторами подразумеваются переводчики и рецензенты.

См. также Инициалы автора, Модуль.

Инициалы автора

Borges идентифицирует различных авторов, участвующий в проекте, по их инициалам. Как следствие инициалы, используемые различными авторами одного проекта, должны быть уникальными.

Если в вашем проекте небольшая группа авторов, вполне хватит двухбуквенных инициалов, однако может использоваться и большее число букв, лишь бы инициалы были уникальными.

См. также Автор, Проект.

Проект

Проект - это документ или набор документов, которыми вы управляете при помощи Borges. Обычно проект содержит множество документов.

См. также Документ.

Супердокумент

Означает набор модулей, сгруппированных вместе в виде книги, статьи, руководства пользователя; любой исчерпывающий блок информации по определённой теме.

Супердокумент - это «мастер-копия», из которой могут быть сгенерированы различные документы. Структура супердокумента определена в файле master.top.xml.

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

См. также Документ.

Документ

Документ - это результат компиляции супердокумента в виде PDF-файла или (X)HTML-файлов. Вы на выбор можете откомпилировать весь свой супердокумент или его части. Документами могут быть книги целиком, статьи, справочные таблицы, письма, руководства и т.п.

См. также Компиляция, Супердокумент.

Компиляция

Компиляция - это процесс «преобразования» набора исходных XML-файлов в PDF- или (X)HTML-документ.

Элемент структурирования

В супердокументе элемент структурирования - это элемент DocBook, содержащий элементы модуля. Типичные элементы структурирования: part или chapter.

См. также Супердокумент, Элемент модуля.

Элемент модуля

В супердокументе элемент модуля - это элемент DocBook, содержащий специальные дочерние элементы

<para role="module">

Элемент модуля в конечном документе будет заменён его содержимым. Типичные элементы модуля: chapter или sect1.

См. также Супердокумент, Элемент модуля.

Модуль

Модули - это составные части документов. Обычно супердокумент разбивается на небольшие части, называемые модулями, для упрощения написания, перевода, управления и повторного использования контента. Главы, разделы, приложения и глоссарии представляют собой хороших кандидатов на роль модулей.

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

Модули могут содержать некоторые части, помеченные атрибутом condition= для того, чтобы они были исключены из отдельных переводов. Это даёт вам возможность создать более одного типа документов из одного набора модулей, улучшая функции повторного использования контента Borges.

См. также Документ, Супердокумент, Проект.

Оригинальный модуль

Используется для указания модуля, который был написан его редактором. Переводчики будут использовать оригинальный модуль в качестве основы для своих переводов.

См. также Модуль, Переведённый модуль.

Переведённый модуль

Означает перевод оригинального модуля.

См. также Модуль, Оригинальный модуль.

Статус модуля

Модули за свой жизненный цикл проходят различные состояния. Каждое «состояние» определяет статус модуля.

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

См. также Жизненный цикл.

Атом

Атомы - это элементы XML, используемые для проверки изменений в модуле. Это самые маленькие элементы, содержащие текст. Типичные атомы DocBook: <title> и <para>.

См. также Ревизия атома.

Ревизия атома

Атомы имеют номер редакции, используемый системой управления ревизиями Borges для отслеживания изменений, вносимых в модули, в «атомарной системе исчисления».

См. также Атом.

Жизненный цикл

Жизненный цикл модуля состоит из нескольких этапов (или состояний), через которые он должен пройти, чтобы стать готовым к выпуску. В настоящий момент Borges поддерживает только фиксированный жизненный цикл, рассмотренный более подробно в Раздел 4.1, «Жизненный цикл модуля».

См. также Модуль, Статус модуля.