[docs] Re: Chapters and articles
Vitaly Ostanin
vyt на vzljot.ru
Вт Ноя 5 14:54:42 MSK 2002
On Tue, 5 Nov 2002 13:18:54 +0300
Alexandre <avp на altlinux.ru> wrote:
> On Tue, 5 Nov 2002 13:14:14 +0300
> "Anton V. Boyarshinov" <boyarsh на ru.echo.fr> wrote:
>
> > On Tue, 5 Nov 2002 12:26:02 +0300
> > Alexandre <avp на altlinux.ru> wrote:
> >
> > > Кроме того, вчера мы с Виталием Останиным обсуждали вопрос
> > > включения jabber-common и Psi в документацию. Как вы
> > > видите, оба документа включены в User guide. Однако, я
> > > настаиваю, чтобы структура выглядела так:
> > >
> > > book - Руководство пользователя
> > > ...
> > > part - Сетевая коммуникация
> > > chapter - Web
> > > section - Введение
> > > section - Mozilla Navigator
> > > chapter - Mail
> > > section - Введение
> > > section - Mozilla Mail & News
> > > chapter - Instant Messaging
> > > section - jabber-common
> > > section - Psi
> >
> > При наличии всех перечисленных документов -- логично.
> > Впрочем, это вопрос "оси" документации. Если мы делаем
> > документацию ориентированную на задачи -- тогда так. Если на
> > программы -- тогда вся мозилла должна быть в одном месте,
> > задаче-ориентированные chapter исчезают и jabber-common & psi
> > идут уровнем выше.
>
> На задачи. Я не вижу смысла в сосредоточениина приложениях. Мы
> же не журнал делаем :-)
Давайте ориентироваться на документы. Если какие-то из документов
нужно включить лишь частично, и под другим корневым тегом, то
это легко делается с помощью XInclude.
По поводу jabber-common и psi:
в текущем состоянии (и по смыслу) они оба - статьи (article),
которые должны быть переделаны в главы (chapter). Если для
Мастера будут ограничения по объёму, то нужно об этом
предупредить.
Не вижу смысла вводить дополнительный промежуточный уровень
(Web, Mail, Instant Messaging) всего для двух документов в
каждом, при этом кастрировать их из article в section.
PS Похоже, что придётся заводить ветки для (сбора)
документации по каждому дистрибутиву, как предсказывал Антон.
<skipped/>
--
Regards, Vyt
mailto: vyt на vzljot.ru
JID: vyt на vzljot.ru
----------- следущая часть -----------
Было удалено вложение не в текстовом формате...
Имя : отсутствует
Тип : application/pgp-signature
Размер : 189 байтов
Описание: отсутствует
Url : /pipermail/docs/attachments/20021105/8426184f/attachment.bin
Подробная информация о списке рассылки docs