[docs] Возможная организация документации

Anton V. Boyarshinov boyarsh на ru.echo.fr
Чт Янв 16 16:47:03 MSK 2003


Добрый день

У меня есть несколько идей по ограницации документации на
будущее.

1. Все документы создаются как section. Возможно кроме некоторых,
но исключения должны осбкждаться каждый раз отдельно. Перед
сборкой они обрабатываются дополнительным стилем (в дополнение к
существующему tuning.xsl) для создания корректной структуры.
Стиль должен допускать конфигурирование в широких пределах, для
того, чтобы можно было указать корневой тэг (book, article ...) а
также управлять внутренней структурой (например делать ли части
или за book должны следовать сразу главы, выделять ли первый
раздел в preface и т. п.). Таким образом, мы получаем гибкость в
объединении материалов и нам не придётся менять вручную doctype
при изменении положения метериала.

2. Следует определить entety &DISTR; (имя дискутабельно, но не
стоит делать его слишком длиным) и продумать механизм лёгкого
измененмия его значения. Все ссылки на текущий дистрибутив должны
делаться только через него.

Антон
-- 
mailto:boyarsh на mail.ru
mailto:boyarsh на ru.echo.fr
 10:28am  up 51 days, 16:35,  9 users,  load average: 0.01, 0.20,
0.20



Подробная информация о списке рассылки docs