Docbook - Как получить входные xml-файлы из таблицы стилей xsl

Question

Я пишу некоторую документацию с помощью плагина docbook maven, и я ищу автоматическое создание панели навигации в заголовке вывода HTML.

У меня есть некоторые книги организованы следующим образом:

• Guide1
• Guide2
• Учебники
  • tuto1
  • tuto2

Желаемый результат - создать панель навигации на выходе HTML, для каждой книги с использованием таблицы стилей XSL. Что-то вроде:

<xsl:template name="user.header.content"> 
    <xsl:for-each select="something"> 
     <xsl:value-of select="somethingelse"/> 
    </xsl:for-each> 
</xsl:template> 

Заранее спасибо :).

Answer 1

Используйте стандартную функцию XSLT document().

Пример:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
xmlns:xs="http://www.w3.org/2001/XMLSchema"> 
<xsl:output method="text"/> 

<xsl:template match="/"> 
    <xsl:value-of select= 
    "document('http://www.w3.org/2007/schema-for-xslt20.xsd') 
    /*/xs:annotation[1]/xs:documentation 
    "/> 
</xsl:template> 
</xsl:stylesheet> 

Когда это преобразование применяется на любом документе XML (не используется), он обращается документ XML по указанному URL-адресу (это XSD для языка XSLT 2.0) и выводит строковое значение первого элемента xs:annotation/xs:documentation этого удаленного документа XML:

This is a schema for XSLT 2.0 stylesheets. 

It defines all the elements that appear in the XSLT namespace; it also 
provides hooks that allow the inclusion of user-defined literal result elements, 
extension instructions, and top-level data elements. 

The schema is derived (with kind permission) from a schema for XSLT 1.0 stylesheets 
produced by Asir S Vedamuthu of WebMethods Inc. 

This schema is available for use under the conditions of the W3C Software License 
published at http://www.w3.org/Consortium/Legal/copyright-software-19980720 

The schema is organized as follows: 

PART A: definitions of complex types and model groups used as the basis 
     for element definitions 
PART B: definitions of individual XSLT elements 
PART C: definitions for literal result elements 
PART D: definitions of simple types used in attribute definitions 

This schema does not attempt to define all the constraints that apply to a valid 
XSLT 2.0 stylesheet module. It is the intention that all valid stylesheet modules 
should conform to this schema; however, the schema is non-normative and in the event 
of any conflict, the text of the Recommendation takes precedence. 

This schema does not implement the special rules that apply when a stylesheet 
has sections that use forwards-compatible-mode. In this mode, setting version="3.0" 
allows elements from the XSLT namespace to be used that are not defined in XSLT 2.0. 

Simplified stylesheets (those with a literal result element as the outermost element) 
will validate against this schema only if validation starts in lax mode. 

This version is dated 2007-03-16 
Authors: Michael H Kay, Saxonica Limited 
     Jeni Tennison, Jeni Tennison Consulting Ltd. 

2007-03-15: added xsl:document element 
      revised xsl:sequence element 
      see http://www.w3.org/Bugs/Public/show_bug.cgi?id=4237   

ли Примечание:

В случае, если XML-документы, которые будут доступны постоянно находиться в локальных файлах, используйте «файл:» схемы, как это:

'file:///c:/temp/myXmlDocument.xml'

Answer 2

В моем опыте лучший способ создания документации доступный через веб-браузер, - maven-site-plugin.

maven-site-plugin позволяет создавать сайт, а затем публиковать его по URL-адресу, указанному в разделе <distributionManagement> ПОМ.

Вы можете написать свою "панель навигации" в index.html пути редактирования (в вики-как APT format) относительная index.apt:

+- src/ 
    +- site/ 
     +- apt/ 
     | +- index.apt 

Затем генерируя сайт:

+- target/ 
    +- site/ 
     +- index.html 
     +- resources/ 
     +- Guide1.html 
     +- Guide2.html 
     +- tuto1.html 
     +- tuto2.html 
     +- Guide1.pdf 
     +- Guide2.pdf 
     +- tuto1.pdf 
     +- tuto2.pdf 

достижимый по Maven way:

• создать проект с двумя подпроектами (модули Maven): т. Е.my-prj-doc, my-prj-site
• my-prj-doc создает документацию DocBook по docbkx-maven-plugin. Основным артефактом этого проекта должен быть my-prj-doc-1.0.0.jar, который будет установлен в вашем местном хранилище Maven (.m2)
• my-prj-site создает сайт по maven-site-plugin; кроме того, по maven-dependency-plugin (в конечном счете, прикрепленного к site фазе) получает от вашей локальной Maven хранилище my-prj-doc-1.0.0.jar и распаковывает его в target/site/resources/ каталог

Мой опыт показывает, что этот путь является одним из лучших один, потому что дает:

• развязку - прочитать документацию и просматривать его отдельные понятия, и вы можете подумать, что в отдельных проектах и ​​процессах
• ремонтопригодность - Работа над отдельными проектами менее подвержены ошибкам
• модульность - Для краткости: если вы начать думать документации как код можно упаковать и распространять документацию в качестве API; например, вы могли бы написать проект подпрограммы «Maven sub», а затем вы могли бы импортировать артефакт faq-1.0.0.jar в своих подпроектах Maven в Guide1 и Guide2 Maven, поэтому, имея один и тот же FAQ-проект, вы будете иметь одинаковые FAQ в двух (или более) разных финальных документах.