[docs] Re: Docbook root element

Vitaly Ostanin vyt на vzljot.ru
Пн Окт 25 19:13:58 MSD 2004


Ildar Mulyukov пишет:

>       Виталий, уважаемое сообщество!
> чувствую, что получу поддержку, что очень радует :-) Спасибо за ссылку 
> на Complete Guide, там можно научиться многому полезному. Про Website 
> больше речь не веду, принимая, что это - тупиковая ветвь (вернее 
> совершенно неудачный предмет для того, чтобы на него ссылаться в 
> данном контексте).
> По-видимому, я недопонимаю чего-то важного, поэтому задаю вопросы, на 
> которые ответ: "а чего Вы хотите?"
> Попробую изложить с самого начала:
> * Во всяких материалах по DBk описано, как делать докумены, то есть 
> использовать BOOK и ARTICLE, в качестве root-элементов.


Я не встречал таких материалов, оригинальная документация не 
ограничивает использование элементов в качестве корневых. Там просто 
указывается, что такой-то элемент не поддерживается стилями в качестве 
корневого. Нужно понять разницу между:
- самим документом в структурном виде
- описанием этой структуры
- стилями для обработки документа.

В самом документе можно использовать _любой_ элемент как корневой, 
руководствоваться нужно только здравым смыслом. Если Вы пишете статью - 
корнем должен быть article. Если Вам нужен только email адрес, ну вдруг 
понадобилось иметь такие маленькие документы, всегда можно добавить 
поддержку email как корня в стили обработки.

Описанием структуры может быть не только DTD, есть ещё XML Schema, Relax 
NG и т.д.

Стили необязательно должны быть родными DocBook'овыми.

> * Соответственно есть принятые DTD для таких документов. 


В случае DocBook XML - DTD один на все элементы, корнем можно взять 
любой элемент.

> При этом root-элементом является <book/> или <article/>. (Это 
> обязательно? Или DTD не декларирует, какой будет root-элемент?)


Это необязательно, и DTD не декларирует. Можно написать и собрать 
документ, вообще не пользуясь DTD, просто описание структуры - это удобно.

> * Есть потребность создать новый вид документа, который не является ни 
> книгой, ни статьёй: <my-type-of-doc/>


Сейчас почти невозможно создать новый вид документа :) :) Любой документ 
имеет смысл (ну должен иметь :)). Вам нужно написать документацию к 
программе? Статью, диссертацию, хранить данные?

> В связи с такой потребностью возникают следующие вопросы:
> 1. Надо для такого документа написать DTD. Предположим, эта проблема 
> решаема :-) Надо только почитать доки по DTD.
> 2. Для реального использования надо как-то подцепиться к DBk-ским xsl. 
> Видимо, это делается простым include-ированием html/docbook.xsl?


Зависит от документа и что имеется в виду под реальным использованием. 
Основные файлы стилей называют driver'ом. Таких драйверов в DocBook 
несколько:
html/docbook.xsl
html/chunk.xsl
fo/docbook.xsl
htmlhelp/htmlhelp.xsl
и т.д.

Для документации в alt docs есть свои драйверы, использующие docbook'овые:
http://docs.altlinux.ru/releases/xsl/current/
например:
http://docs.altlinux.ru/releases/xsl/current/html/html-dir.xsl

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

> 3. Есть ли примеры успешной реализации поставленной задачи? Кто-нибудь 
> так уже делал?


Задача всё-таки не поставлена.

<skipped/>

-- 
Regards, Vyt
mailto:  vyt at vzljot.ru
JID:     vyt at vzljot.ru

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 252 bytes
Desc: OpenPGP digital signature
Url : http://lists.altlinux.ru/pipermail/docs/attachments/20041025/32098cdf/signature.bin


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