[docs] Re: Making docs status in cvs

cornet cornet на altlinux.ru
Вс Ноя 10 22:31:19 MSK 2002


Vitaly Ostanin wrote:
> 
> On Sun, 10 Nov 2002 01:42:45 +0300
> cornet <cornet на altlinux.ru> wrote:
> 
> <skipped/>
> 
> > 2. У каждого документа единовременно может быть только один
> > майнтейнер - как у rpm-пакета.
> 
> Не уверен, но это и не важно. Пусть будет только один. (Горец :))
> 
> > Фактически это лицо ответственное за выпуск документа и
> > поддержание его в актуальном состоянии.
> 
> Это, скорее, редактор.

Не совсем. Детактор это скорее лит-вычитка. А я говорю про
выпускающего - такой человек и за содержание отвечает и за код
xml.

Пример:
samba.xml
Имеется 3 автора - я, Игорь Вергейчик, Александр Боковой. 
При этом майнтейнер документа именно я. Когда мне потребуется
доработать контент по samba3 - обращусь к Вергейчику или
Боковому, когда доработка по samba2 - сделаю сам, когда
потребуется лит-вычитка - обращусь к Александру Прокудину. Но за
коректность xml, за правильность оформления и за готовность
документа к нужному сроку в нужном виде отвечаю именно я.

> > Разумеется этот человек одновременно может быть (и как правило
> > будет) одним из авторов.
> > Всё общение с авторами документа возлагается на майнтейнера.
> 
> Это когда дойдём до policy с документами. Авторы здесь вообще ни
> при чём.

А какие мысли есть на счет policy ??
 
> > Вот, отсюда следствия - необходимо оставить в данном документе
> > только одну запись:
> >    <mantainer>
> >      <name>Foo</name>
> >      <email>Bar</email>
> >    </mantainer>
> > а список авторов всегда можно взять из основного документа,
> > статус которого мы описываем.
> 
> Да. Оттуда же будем брать и полное название документа.
> 
> > Ну и в качестве общего предложения:
> > Вытеснить ВСЕХ авторов в общий ent/authors.ent а в документах
> > соответственно использовать только сущности. В этом случае мы
> > отстреливаем сразу двух ушастых - имеем общий список авторов в
> > одном общем файле, причем со всеми их атрибутами, и можем с
> > минимальными изменениями вносить правки - если например у кого
> > то из плодовитых авторов изменился почтовый адрес то менять
> > прибется только в одном файле ent/authors.ent а не во всех,
> > автором которых он является. Так же существенно упрощается
> > изменение списка атрибутов авторов если мы захотим что либо
> > менять в будущем.
> 
> > Например, в ent/authors.ent записываем:
> > <!ENTITY cornet
> > "<firstname>Vlasenko</firstname><surname>Oleg</surname><affili
> > ation><address><email>cornet на altlinux.ru</email><otheraddr></o
> > theraddr></address></affiliation>">
> >
> > А в теле документа пишем:
> > <authorgroup>
> >   <author lang="en">
> >     &cornet;
> >   </author>
> > </authorgroup>
> 
> Лучше взять уровнем выше - делать сущности с началом на <author>.

Не уверен что это правильно - один и тот же человек в разных
документах может быть и author и othercredit и ещё как то.
Как раз суть моего предолжения - загонять в сущность свойства
самого человека. А вот его роль в создании документа должна
описываться в самом документе.

> Кстати, недавно пришли к тому, что имена должны быть на русском.

А нельзя выбор написания имени как то завязать с lang="ru" и
lang="en"
??

-- 
Власенко Олег.
Отдел технической поддержки ALT Linux Team.
mailto:cornet на altlinux.ru



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