Altdocs

Материал из ALT Linux Wiki

Данная страница находится в разработке. Эта страница ещё не закончена. Информация, представленная здесь, может оказаться неполной или неверной.

Содержание 1 Пакеты документации, создаваемые ALT Docs Team 2 Определение 3 Именование 4 Формат

[править] Пакеты документации, создаваемые ALT Docs Team

Тут пока кратко будут излагаться рекомендации/правила/соглашения по пакетам документации.

Пакеты документации, создаваемые ALT Docs Team делятся на

• модули
• выпуски

[править] Определение

Модули представляют из себя самодостаточные тексты на определённую тему. Самодостаточность модулей выражается в том, что они не должны содержать ссылок на другие модули.

Выпуски представляют из себя тексты (в минимальном необходимом количестве), обильно содержащие ссылки на модули. Т.е. выпуски служат для объединения модулей.

[править] Именование

Модули как пакеты именуются следующим образом: docs-далее_всё_что_угодно Выпуски именуются следующим образом: docs-issue-далее_всё_что_угодно

[править] Формат

Для наиболее полной интеграции в систему поддерживаются несколько форматов:

• docbook
• html
• m-k