Система управления документацией Borges
   След.

Система управления документацией Borges

Собственная документация

Под редакцией

Camille Bégnis

Joël Pomerleau, Christian Roy, Fabian Mandelbaum, Peter Pingus, Jerry Huynh-Tot, John Rye.

Copyright © 2002 MandrakeSoft SA

2002-04-19

Аннотация

Содержание

Введение
1. Юридическое замечание
2. О документации Borges
1. Революционная концепция
1. Что такое Borges?
1.1. Возможности
2. Выбор Borges
2.1. Нужен ли он мне?
2.2. Borges для меня?
3. Небольшой словарь
2. Руководство по быстрому старту
1. Установка
1.1. Где его взять?
1.2. Как мне его установить?
1.3. Зависимости
2. Первые шаги
3. Создание нового проекта
3.1. Настройка Borges для создания нового проекта
3.2. Пошаговый пример
3.3. Заключительные замечания
3. Справочное руководство пользователя
1. Написание документов
1.1. Конфигурационные файлы
1.2. Функции создания документов
1.3. Функции изменения документов
1.4. Добавление в систему новых языков
2. Создание конечных документов
2.1. Создание одного модуля
2.2. Создание нескольких документов за один раз
2.3. Создание одного модуля
2.4. Поддержка OMF
3. Настройка стиля выходного документа
3.1. Настройка существующих форматов
3.2. Создание нового уровня оформления
4. Управление ревизиями
4.1. Жизненный цикл модуля
4.2. Межязыковая синхронизация модуля
4.3. Старший релиз проекта
4.4. Создание отчётов
4. Возможности менеджера проектов
1. Репозиторий на стороне сервера
2. Автоматическая компиляция и публикация отчётов
3. Отправка писем авторам
3.1. Добавление информации в конец письма
4. Бухгалтерские отчёты
4.1. Отчёт по проекту
4.2. Отчёт по авторам
5. Borges и XML-редакторы
1. Какой редактор мне следует использовать?
2. Emacs+PSGML
2.1. Установка PSGML
2.2. Осведомлённость о DTD
2.3. Основные команды PSGML
3. XML-редакторы WYSIWYG
6. Borges и интеграция с CVS
1. Создание нового проекта в CVS
2. Что изменяется при использовании CVS
2.1. Команды с изменённым поведением
2.2. Новые полезные команды
7. Справочное руководство программиста
1. Makefile'ы
1.1. Makefile исходного кода Borges
1.2. Makefile'ы проектов документации
1.3. Makefile'ы в действии
2. Последовательность создания руководства
3. Добавление/изменение правил руководства
4. Поддержка другого DTD, отличного от DocBook
5. Замечания по установке Borges
5.1. Установка Borges в нестандартный каталог
5.2. Адаптация Borges к нестандартному окружению
8. Получение справки
1. Отчёты об ошибках, запросы новых возможностей, патчи
2. Контакты
9. Тестовый образец модуля
A. Перечень команд Borges
1. Команды общего назначения
2. Компиляция выходных документов
3. Команды управления ревизиями
4. Команды редактирования модуля
5. Команды создания отчётов
6. Команды управления проектом
B. GNU Free Documentation License
1. GNU Free Documentation License
1.0. PREAMBLE
1.1. APPLICABILITY AND DEFINITIONS
1.2. VERBATIM COPYING
1.3. COPYING IN QUANTITY
1.4. MODIFICATIONS
1.5. COMBINING DOCUMENTS
1.6. COLLECTIONS OF DOCUMENTS
1.7. AGGREGATION WITH INDEPENDENT WORKS
1.8. TRANSLATION
1.9. TERMINATION
1.10. FUTURE REVISIONS OF THIS LICENSE
2. How to use this License for your documents

Список иллюстраций

3.1. Стандартный жизненный цикл модуля Borges
3.2. Получение отчёта по супердокументу
3.3. Образец отчёта по модулю
3.4. Изменения в ID/ревизиях
3.5. Несинхронизированные элементы бок о бок
3.6. Сгенерированные Borges'ом отчёты
7.1. Распределение Makefile'ов
7.2. Взаимосвязи между Makefile'ами
7.3. Распределение Makefile'ов

Список таблиц

3.1. Выходные форматы Borges
3.2. Соответствие элементов DocBook и OMF
5.1. Команды PSGML

Список примеров

4.1. Публикация сrontab'ом
4.2. Доставка писем crontab'ом
7.1. Установка Borges в домашний каталог
   След.
   Введение