[docs] Re: Docbook root element

[Ildar Mulyukov]

Vitaly Ostanin wrote:

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

Поэтому я и не написал, как хотел с самого начала, что "book и article 
должны быть корневыми". Я понял, что так нигде не было написано.

> Там просто указывается, что такой-то элемент не поддерживается стилями 
> в качестве корневого. 

Угу. Очень хорошо. А вообще, кроме book и article, нет элементов, 
которые бы имело смысл использовать, как корневые? То есть для 
нормального использования: вёрстки, публикации на ВВВ...

> Нужно понять разницу между:
> - самим документом в структурном виде

угу. Это *.dbk (по крайней мере abiword сохраняет с этим расширением)

> - описанием этой структуры

DTD. Необязательное описание. Но удобное.

> - стилями для обработки документа.

угу, apt-get install docbook-style-{xsl,dsssl}

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

Интересно. Можно поэксперементировать.

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

Буду иметь в виду.

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

Согласен.

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

хорошо, это понятно

>> При этом root-элементом является <book/> или <article/>. (Это 
>> обязательно? Или DTD не декларирует, какой будет root-элемент?)
>
> Это необязательно, и DTD не декларирует. Можно написать и собрать 
> документ, вообще не пользуясь DTD, просто описание структуры - это 
> удобно.
>
>> * Есть потребность создать новый вид документа, который не является 
>> ни книгой, ни статьёй: <my-type-of-doc/>
>
> Сейчас почти невозможно создать новый вид документа :) :) 

Это непонятно. Правда, что ли? Всё так плохо и нет смысла браться?

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

Очевидно, я имею в виду что-то, не совпадающее с понятиями "книга" и 
"статья". Как пример, лицензионное соглашение (или какое-нибудь EULA) - 
это ни книга, ни статья. То есть суть вопроса такая: я что-то имею в 
виду, и хочу использовать docbook-style-xsl для поддержки этого 
"что-то", то есть моего типа документа.

>> В связи с такой потребностью возникают следующие вопросы:
>> 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. Есть ли примеры успешной реализации поставленной задачи? 
>> Кто-нибудь так уже делал?
>
> Задача всё-таки не поставлена.

Таки я попытаюсь ещё раз. Повторюсь:
Я имею в виду что-то, не совпадающее с понятиями "книга" и "статья". 
Нельзя сказать, что вся печатная (и, заметьте, непечатная) продукция - 
это только книги и статьи. Есть ещё много чего. Как пример, лицензионное 
соглашение (или какое-нибудь EULA) - это ни книга, ни статья. Или те же 
website-ы. Или, например (иллюстрация), существует ThML 
(http://www.ccel.org/ThML/). (Правда, он по идеологии далёк от DBk)

То есть последний вопрос таков: я что-то (мой тип документа) имею в 
виду, и хочу использовать docbook-style-xsl для поддержки этого 
"что-то", то есть моего типа документа. Что для этого мне надо сделать?

С уважением, Ильдар.

-- 
Ildar  Mulyukov, 
  free SW designer/programmer
================================================
email: ildar at users.sourceforge.net
projects: http://os-development.sourceforge.net/
home: http://tuganger.narod.ru/
ALT Linux Sisyphus
================================================