[docs] Re: Форматирование имён авторов

[Vitaly Ostanin]

On Wed, 23 Oct 2002 17:47:22 +0400
"Anton V. Boyarshinov" <boyarsh на ru.echo.fr> wrote:

> Добрый день
> Ранее писалось, что авторы документа долны браться из частей.
> Это правильно. Я близок к тому, чтобы реализовать это для fo.
> Насколько я понимаю, для html версии не является проблемой,
> если авторы будут в соответствующих section, а не в начале
> документа.

Для любого выходного формата можно написать стиль, собирающий
авторов и помещающий список в начало объединяющего документа.

> Соответственно, я собираюсь раскомментировать имен авторов в
> документах где они есть и по возможности добавить их там, где
> их нет. 
> 
> Имеются ли возражения?

Нет. Осталось решить, что указывать авторам - нужно ли отчество и
на каком языке.

> Нужно ли отмечать это в revhistory или достаточно комментария
> при commit?

На Ваше усмотрение.

> <imho>Лично я против размещения в revhistory технических
> изменений, не затрагивающих собственно содержание.</imho>
> 
> <imho>Я вообще отношусь к revhistory отрицательно, как и к моде
> помещать log изменений в головном комменарии программы. В
> случае сколько-нибудь частых изменений за деревьями становится
> не виден лес. Может быть сделать отдельный Changelog для
> документации и не загромождать сами статьи?</imho>

revhistory в common/ru.xml переводится как "история переизданий",
что очень близко к истине.

По поводу 1-го <imho/>:
Например, доки пересобираются и
выкладываются с корректным указанием кодировки. Это очень похоже
на переиздания и нужно это отразить в revhostiry. Конечно, про
"обновления DTD до версии 4.2" и тех. детали можно и не писать -
это моё занудство :) 

Свежесть документа для читателя иногда определяется номером
издания (ревизии). Странно издавать разные версии документа с
одним и тем же номером.

По поводу 2-го <imho/>:
revhistory является неплохим способом описания
изменений в теле документа, поскольку документ может
разрабатываться и публиковаться без доступа к cvs. Мне, например,
не хватает TODO в теле документа :)

Насчёт вывода изменений в начале документа - вот это напрягает,
но никто не мешает поправить стили на эту тему. Например,
оформлять изменения, как appendix, или вообще выбрасывать.

<skipped/>

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