[docs] Re: доки

[Vitaly Ostanin]

On Tue, 22 Oct 2002 21:05:39 +0700
Alex Sergeyev <abc на executive-solutions.com> wrote:

> Добрый день
> 
> Ох и много же ... с этим Docbook приходится терпеть при
> переделках... Сроки напомните пожалуйста?

Присоединяюсь к вопросу.

> У меня есть острая необходимость размечать такие строчки,
> которые будут внутри <term></term> от <variablelist>
> 
> Формат строк таков - 
> 
> директива параметры контекст

Формат - это уже оформление, нужно размечать смысл.

> Параметры могут быть интересно разными:
> 1) имя файла/каталога
> 2) относительный/абсолютный URL
> 3) строка
> 4) число
> 5) keyword
> 
> Контекст будет набором буковок в квадратных скобочках
> например...(директива общего конфига, Directory, VirtualHost,
> Location, .htaccess уровни) Буковки ADVLh соответственно.

Вы хотите перевести в DocBook конфиг apache ? :)

Кусок конфига можно вставить в тег programlisting.
Пример директивы можно вставить в example.
Для описания директивы её можно вставить в term/varname, а само
описание - в listinfo/para (всё это в variablelist).

> Ой как хочется что нибудь еще содержательного написать не
> застревая так сильно на переводе в docbook... Может кто помочь
> желает - дайте знать... Хочется написать еще краткий FAQ по
> частоначинающим вопросам (НАДО?) В какую сторону вообще двигать

Конечно, надо!

> "собственные мысли"? Всю документацию все равно не перевести
> же... А пару примеров с Rewrite например и с другими важными
> моментами хочется привести. Чтоб людям становилось интереснее
> почитать Apache-Manual

Сейчас в cvs docs есть структура для книг от ALT Linux
"Руководство по установке"
"Руководство пользователя"
"Руководство администратора"

Там же будут храниться документы о linux вообще, не только ALT.
Так что краткое руководство администратора по apache можно
включить в книгу, а дополнительные общие документы (когда будут),
рядышком :)

Кстати, если в документе есть "более детальные места", можно их
помечать атрибутом role="verbose1" (или verbose2,3), в
зависимости от степени детальности.

Тогда при сборке документов можно будет использовать profiling
http://docbook.sourceforge.net/release/xsl/current/doc/tools/profiling.html
включая только нужные (или все) части.

<skipped/>

-- 
Regards, Vyt
mailto:  vyt на vzljot.ru
JID:     vyt на vzljot.ru
----------- следущая часть -----------
Было удалено вложение не в текстовом формате...
Имя     : отсутствует
Тип     : application/pgp-signature
Размер  : 189 байтов
Описание: отсутствует
Url     : /pipermail/docs/attachments/20021022/6abd9c15/attachment.bin