Linux Mandriva 2007.1: Создание дкументации
Материал из EniseyName.
Версия 09:12, 1 февраля 2010 (править) Admin (Обсуждение | вклад) (Новая: 1. Набор текста, форматирование символов (жирный, курсив), картинки, использование стилей Заголовок 1, З...) ← К предыдущему изменению |
Текущая версия (09:19, 1 февраля 2010) (править) (отменить) Admin (Обсуждение | вклад) |
||
(1 промежуточная версия не показана) | |||
Строка 27: | Строка 27: | ||
xsltproc --version | xsltproc --version | ||
- | 7. Создаем XSL-драйвер | + | 7. Создаем XSL-драйвер docbook2.xsl |
+ | |||
+ | |||
+ | <?xml version="1.0" encoding="windows-1251"?> | ||
- | ?xml version="1.0" encoding="windows-1251"?> | ||
<xsl:stylesheet version="1.0" | <xsl:stylesheet version="1.0" | ||
+ | |||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> | xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> | ||
+ | |||
<xsl:import href="/home/student/docbook-xsl-1.75.2/xhtml/chunk.xsl"/> | <xsl:import href="/home/student/docbook-xsl-1.75.2/xhtml/chunk.xsl"/> | ||
+ | |||
<!-- xsl:output method="xhtml" /> --> | <!-- xsl:output method="xhtml" /> --> | ||
+ | |||
<xsl:param name="chunker.output.encoding" select="'windows-1251'"/> | <xsl:param name="chunker.output.encoding" select="'windows-1251'"/> | ||
+ | |||
<!-- xsl:param name="saxon.character.representation" select="'native'"/> --> | <!-- xsl:param name="saxon.character.representation" select="'native'"/> --> | ||
+ | |||
<xsl:param name="chapter.autolabel" select="'1'"/> | <xsl:param name="chapter.autolabel" select="'1'"/> | ||
+ | |||
<xsl:param name="l10n.gentext.default.language" select="'ru'"/> | <xsl:param name="l10n.gentext.default.language" select="'ru'"/> | ||
+ | |||
<xsl:param name="section.autolabel" select="'1'"/> | <xsl:param name="section.autolabel" select="'1'"/> | ||
+ | |||
<xsl:param name="section.label.includes.component.label" select="'1'"/> | <xsl:param name="section.label.includes.component.label" select="'1'"/> | ||
+ | |||
<xsl:param name="part.autolabel" select="'I'"/> | <xsl:param name="part.autolabel" select="'I'"/> | ||
+ | |||
<xsl:param name="navig.graphics" select="0"/> | <xsl:param name="navig.graphics" select="0"/> | ||
+ | |||
<xsl:param name="base.dir" select="'/home/student/tmp/pzis_0_9/'"/> | <xsl:param name="base.dir" select="'/home/student/tmp/pzis_0_9/'"/> | ||
+ | |||
<xsl:param name="html.stylesheet" select="'pzis.css'"/> | <xsl:param name="html.stylesheet" select="'pzis.css'"/> | ||
+ | |||
<xsl:param name="chunk.tocs.and.lots" select="1"/> | <xsl:param name="chunk.tocs.and.lots" select="1"/> | ||
+ | |||
<xsl:param name="chunk.section.depth" select="4"/> | <xsl:param name="chunk.section.depth" select="4"/> | ||
+ | |||
</xsl:stylesheet> | </xsl:stylesheet> | ||
Строка 65: | Строка 83: | ||
xsltproc --nonet docbook2.xsl book_pzis.xml | xsltproc --nonet docbook2.xsl book_pzis.xml | ||
+ | |||
+ | |||
+ | ----Литература | ||
+ | |||
+ | [http://docbook.ru/doc/sw/index.html Кратчайший путь к DocBook] |
Текущая версия
1. Набор текста, форматирование символов (жирный, курсив), картинки, использование стилей Заголовок 1, Заголовок 2 и т.п. для структурирования документа с помощью OpenOffice.org. Файл сохраняем в формате RTF.
2. Преобразование RTF файла в XML.
Используем UpCast 5.5.4 (Build 871). Свойства программы. Лицензию использовал старую upcast.license за 2006 г. И поэтому приходиться установливать на машине при работе с программой 2007 год.
Загрузка новой версии 7.1.8 (Build 1495) . Эту версию не проверял. Но The upCastRT download includes an Evaluation License (see License Agreement) which lets you evaluate the application with functional restrictions. To request a fully functional test license, please contact us at licensing@upcast.de. Написал письмо с просьбой о полной лицензии. Ответа нет.
3. Редактирование и проверка XML файла на соответствие стандарту DocBook c помощью XML-редактора. Используем
Syntext Serna - визуальный (WYSIWYG) редактор XML от компании Syntext, Inc. XML редактор Syntext Serna работает на операционных системах Windows, Linux, Mac OS X и Sun Solaris/SPARC.
4. Редактрование XML файла с помощью Kate (KDE Advanced Text Editor) — текстовый редактор, входящий в состав среды рабочего стола KDE.
5. Инсталлируем XSL-скрипты
Скачайте последнюю версию XSL-скриптов DocBook и распакуйте архив на сервере.
Местоположение каталога значения не имеет, но будем предполагать, что скрипты находятся в каталоге /home/student/docbook-xsl-1.75.2
Разработка ключевых компонент DocBook, в частности XSL-скриптов и DTD, ведется в рамках Open Source проекта, домашняя страница которого docbook.sourceforge.net.
6. Запускаем XSLT-процессор
xsltproc --version
7. Создаем XSL-драйвер docbook2.xsl
<?xml version="1.0" encoding="windows-1251"?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:import href="/home/student/docbook-xsl-1.75.2/xhtml/chunk.xsl"/>
<xsl:param name="chunker.output.encoding" select="'windows-1251'"/>
<xsl:param name="chapter.autolabel" select="'1'"/>
<xsl:param name="l10n.gentext.default.language" select="'ru'"/>
<xsl:param name="section.autolabel" select="'1'"/>
<xsl:param name="section.label.includes.component.label" select="'1'"/>
<xsl:param name="part.autolabel" select="'I'"/>
<xsl:param name="navig.graphics" select="0"/>
<xsl:param name="base.dir" select="'/home/student/tmp/pzis_0_9/'"/>
<xsl:param name="html.stylesheet" select="'pzis.css'"/>
<xsl:param name="chunk.tocs.and.lots" select="1"/>
<xsl:param name="chunk.section.depth" select="4"/>
</xsl:stylesheet>
Переопределенные параметры, наборы атрибутов, шаблоны — все они записываются в XSL-драйвер. Вопросы кастомизации DocBook подробнейшим образом рассматриваются в книге Bob Stayton. DocBook XSL: The Complete Guide. [http://www.sagehill.net/docbookxsl http://www.sagehill.net/docbookxsl/
Стандартные XSL-скрипты поддерживают специальный вариант трансляции в HTML — для последующего преобразования в Microsoft HTML Help. Вместо html/chunk.xsl задайте htmlhelp/htmlhelp.xsl, в результате образуется набор HTML-файлов и служебные файлы, которые понимает штатный Help-компилятор hhc.exe.
Ключ --nonet запрещает обращение в Интернет за XSL-скриптами. Обработка DocBook довольно трудоемка, поэтому предпочтительно чтобы скрипты находились на сервере локально. С этим ключом вы будете уверены, что берутся только локальные скрипты, а обращения в Интернет будут диагностироваться и блокироваться.
Ключами --param и --stringparam задают значения числовых и строковых параметров соответственно, управляя таким способом внешним видом выходного документа.
7. Транслируем в HTML
Переходим в каталог, где находятся файлы docbook2.xsl book_pzis.xml
cd /home/student/tmp/1/
Запускаем трансляцию
xsltproc --nonet docbook2.xsl book_pzis.xml
Литература