Аннотация
Borges предоставляет простую процедуру для создания нового проекта документации. Мы детально опишем этапы конфигурирования, необходимые для создания шаблона проекта. Позже образец документа, поставляемый вместе с Borges, будет скомпилирован в форматах PDF и HTML и будет сгенерирован отчёт о выполненных работах.
Чтобы начать новый репозиторий Borges, вам необходимо выполнить следующие шаги:
Создать скелет проекта
Borges предоставлет простой скрипт для создания скелета нового проекта. Допустим, что вы хотите поместить свои файлы в каталог Мой_проект в своём домашнем каталоге, тогда для этого вы должны выполнить:
/usr/share/Borges/bin/configure ~/Мой_проект
Инициализировать систему с помощью предоставленного образца
Теперь должен быть проинициализирован Borges с новым рабочим документом. Чтобы выполнить это с помощью предоставленного образца, просто выполните:
make adddoc doc=My_Book master=/usr/share/Borges/Sample/master.top.xml
и каталоги будут заполнены минимумом необходимых файлов.
Скомпилировать My_Book в PDF и проверить результат
Теперь вы можете скомпилировать образец документа в PDF, чтобы проверить как он выглядит. Для этого выполните
make -C manuals/My_Book My_Book.pdf LANG=en
и проверьте полученный PDF, выполнив
xpdf manuals/My_Book/My_Book.pdf
Если всё в порядке, вы увидите приятный PDF с образцом документа. Конечно же при желании вы можете открыть PDF при помощи Acrobat Reader вместо Xpdf.
Скомпилировать My_Book в HTML и проверить результат
Вы также можете скомпилировать образец документа в формате HTML. Для этого выполните
make -C manuals/My_Book My_Book.flat.html LANG=en
а затем проверьте результат, открыв в своём любимом браузере ~/Мой_проект/manuals/My_Book/My_Book.flat.html.
Сгенерировать и просмотреть отчёт
Отчёт - это утилита Borges, которая информирует вас о ходе выполненных работ в вашем проекте по всем поддерживаемым языкам. Чтобы сгенерировать отчёт для образца документа, выполните
make -C reports all LANG=en
и просмотрите полученный отчёт, открыв в своём любимом веб-браузере страницу ~/Мой_проект/reports/index.html.
Это было несложно, не так ли? Теперь вы можете настроить Borges на работу со своими собственными проектами.