[docs] требования к формату модуля документации

[Fr. Br. George]

On Tue, Jan 11, 2005 at 05:12:42PM +0300, Kirill Maslinsky wrote:
> 
> Требования к формату
> --------------------
> 
> Исходя из перечисленных условий, а также из требований, накладываемых 
> необходимостью подготовить печатный формат (см. письмо с сабжектом 
> "отчёт и "), можно сформулировать, какие примерно теги для 
> разметки нужны в искомом формате.
> 
> + Теги секционирования. Заголовок и подразделы. Должно быть достаточно 3--4
>   уровней вложенности.
> 
> + Теги для списков. Нумерованных и ненумерованных, в несколько уровней.
	+ списки-определния? (типа <DL>) и выделение элементов, имеющих
определения (типа <defn>, со ссылкой на само определение) -- а то как же
глоссарий делать, в который ``всё уприается''? По-моему, пара
``термин''--``определение'' не моделируется имеющимися тегами.
> 
> + Теги для оформления "цитат из системы": имён файлов, пакетов, URL, примеров командной строки. Необходимы, т. к. к ним нужно применять специальные 
> правила переноса.
> 
> + Теги для оформления текстовых примеров в несколько строк (набираются не 
> прямо в тексте абзаца, а в виде плавающих объектов или отдельных абзацев). 
> Внутри текстовых примеров должен быть способ указать (специальный тег)
> допустимые точки для разрыва строк, чтобы можно было сверстать примеры на 
> узкий формат автоматически. Более того, в текстовых примерах, ширина строки
> в которых больше, чем XX символов, такие точки _обязательно_ должны быть
> указаны.
> 
> + Тег для включения изображений (с подписью).
> 
> + Тег для включения таблиц с подписью (формат таблиц остаётся под вопросом).
> 
> + Тег (теги) для гиперссылок: на разделы документа и другие документы, 
> на URL. Возможно, эти теги могут служить для ссылок на любые внешние 
> и внутренние ресурсы, например, книжки в библиографии.
> 
> + Тег для оформления важных замечаний, которые должны быть выделены 
> графически в конечных форматах.
	+ Тег для оформления НЕважных замечаний, которые должны быть
спрятаны в конец страницы или документа. То есть -- сноски. Отличаются
от плавающих объектов способом ссылки из текста (явно заданным якорем --
звёздочкой-номером), а такжи и представрлением.
> + Тег (теги) для комментариев. Если в этом формате предполагается 
> взаимодействие с редактором -- то для редакторских заметок.

-- 
			George V Kouryachy (aka Fr. Br. George)
			mailto:george at altlinux_ru