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

Anton V. Boyarshinov boyarsh на ru.echo.fr
Чт Окт 24 10:08:47 MSD 2002


Добрый день

On Wed, 23 Oct 2002 18:18:17 +0400
Vitaly Ostanin <vyt на vzljot.ru> wrote:

> > Насколько я понимаю, для html версии не является проблемой,
> > если авторы будут в соответствующих section, а не в начале
> > документа.
> 
> Для любого выходного формата можно написать стиль, собирающий
> авторов и помещающий список в начало объединяющего документа.
Да. Более того, эта часть стиля будет одинакова для всех форматов
(как одинакова она и в оригинальных стилях). Просто моё время
ограничего и я сейчас занимаюсь преимущественно стилем для
печати.
 
> Осталось решить, что указывать авторам - нужно ли отчество и
> на каком языке.
Я думаю, стоит указывать, так как оторвать его стилями не сложно,
а вот добавить... Язык, я полагаю, должен совпадать с языком
документа. С другой стороны -- если кто-то хочет подписаться
псевдонимом -- это его право.
 
> > <imho>Лично я против размещения в revhistory технических
> > изменений, не затрагивающих собственно содержание.</imho>
> > 
> > <imho>Я вообще отношусь к revhistory отрицательно, как и к
> > моде помещать log изменений в головном комменарии программы.
> > В случае сколько-нибудь частых изменений за деревьями
> > становится не виден лес. Может быть сделать отдельный
> > Changelog для документации и не загромождать сами
> > статьи?</imho>
> 
> revhistory в common/ru.xml переводится как "история
> переизданий", что очень близко к истине.
> 
> По поводу 1-го <imho/>:
> Например, доки пересобираются и
> выкладываются с корректным указанием кодировки. Это очень
> похоже на переиздания и нужно это отразить в revhostiry.

Сложный вопрос. Таким образом у нас получается как минимум 2
истории переиздания: в online и в печатной форме. Как это можно
совместить -- неясно.

> Конечно, про
> "обновления DTD до версии 4.2" и тех. детали можно и не писать
> - это моё занудство :) 

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

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

Для этого можно генерировать changelog из cvs.

> Мне, например,
> не хватает TODO в теле документа :)

Хотел съязвить, но не придумал, чего бы мне ещё захотеть в теле
документа;-)
Можно держать TODO в комментарии.
 
> Насчёт вывода изменений в начале документа - вот это напрягает,
> но никто не мешает поправить стили на эту тему. Например,
> оформлять изменения, как appendix, или вообще выбрасывать.

В печатной версии -- скорее выбрасывать. Для экономии
бумаги->денег.

Антон
-- 
mailto:boyarsh на mail.ru
mailto:boyarsh на ru.echo.fr
  9:52am  up 8 days, 22:49,  0 users,  load average: 0.00, 0.00,
0.00



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