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

Alexandre Prokoudine avp на altlinux.ru
Пт Янв 17 11:18:47 MSK 2003


On Thu, 16 Jan 2003 16:47:03 +0300
"Anton V. Boyarshinov" <boyarsh на ru.echo.fr> wrote:

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

Да, это хорошая идея. Полностью одобряю и жду соответствующих коммитов в CVS. 

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

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

Какие будут идеи насчёт реализации управления этой сущностью?

А.П.



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