[docs] Re: milestones

Vitaly Ostanin vyt на vzljot.ru
Пн Сен 1 12:09:52 MSD 2003


On Fri, 29 Aug 2003 20:00:26 +0400
Oleg A.Paraschenko <olpa на xmlhack.ru> wrote:

>   Попробую уменьшить объём вопроса. Давайте рассмотрим не
>   наличие текстов (их всегда будет не хватать), а технические
>   цели и задачи. Я взглянул на архив рассылки и понял, что за
>   деревьями не вижу леса. Какие-то проблемы решаются, но зачем
>   и откуда они появились - зачастую мне не понятно.

Да, с технической точки зрения проблема номер один - создание
системы публикации проблем :)

Планируется для каждого документа сделать вспомогательный
xml-файл (условное название - document-info), содержащий
информацию:

- статус документа (draft, прошёл лит.вычитку, тех. вычитку)
- пакет, в котором находится программа, которую описывает
  документ (если есть)
- автор
- мантейнер

Такие document-info можно обрабатывать в куче, собирая информацию
о документах, которые нужно вычитывать, править и т.п.

Потом собранную информацию нужно публиковать на сайте.

Я сейчас занимаюсь созданием механизма публикации документов на
сайте, который будет уметь то же, что умеет механизм публикации в
html:

1. предварительная обработка (tuning, arrange)
2. импортирующая обработка (изменения стилей docbook xsl)
3. сборка модульных документов
4. ссылки между модульными документами
5. сбор картинок для модульных документов
6. profiling (не доделан до конца, потому что пока никому
   реально не нужен)

и должен дополнительно уметь:

7. навигацию по сайту
8. генерацию документов в подкаталоги
9. публикацию больших документов (book) с разбиением на несколько
   html-файлов (chunk), интегрируя в них навигацию по сайту
10. включения динамической геренации страниц (php-код, например)
11. публикацию не только html, но и стилей, тарболлов с релизами
12. навигацию, которая будет прилично смотреться в кастрированных
    браузерах (internet explorer)

Пока ко всему этому ближе всего website. В нём, кроме тесной
интеграции с docbook, изначально есть: 3,4,7,8,10,12

Сейчас добавлены: 1,2,5

Сломано: 12

Для хотя бы тестового использования не хватает: 9

Можно считать это моим ТЗ на публикацию документов на
docs.altlinux.ru, если никто не против :)

Повторюсь, сейчас я занимаюсь пунктом 9, после которого собираюсь
заняться document-info, которые публиковать на сайте вместе с
документами.

Изменения website пока находятся в моём cvs, т.к. пока не
появилось желающих заняться website. Если появятся - выложу в cvs
docs.

<skipped/>

> * HTML-версия в составе дистрибутива или на сайте.

Да

> * PDF-версия для распечатки на каком-нибудь принтере.

Надо бы ещё экранную версию PDF. Вообще сборка в PDF - больное
место проекта. Свободного нормального XSL/FO процессора, а тем
более визуального редактора - нет и пока не предвидится, AFAIR.

Наиболее реальный вариант из ранее предлагавшихся, IMHO - вялое
допиливание passivetex и db2latex для рабочих сборок. Для сборок,
которые пойдут на печать, использовать купленный XEP RenderX
(не будет доступен всем участникам проекта).

> * Plan-text версия для распечатки на матричном принтере.

На матричном принтере можно распечатать и pdf. Для получения
plain text можно использовать html-вывод и "lynx -dump".

Он вообще нужен?

> * Ещё?

Нам бы хоть это сделать :))) Можно, в принципе htmlhelp и eclipse
сделать, только кому они нужны...

<skipped/>

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


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