You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/doc/stylesheets/dbschema_k/xsl/dbschema2docbook.xsl

303 lines
9.1 KiB

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!--
* $Id: dbschema2docbook.xsl 4518 2008-07-28 15:39:28Z henningw $
*
* database schema to docbook convert xsl script
*
* Copyright (C) 2001-2007 FhG Fokus
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version
*
* Kamailio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
-->
<!-- Namespaces are NOT used in docbook < 5.0 - they SHOULD NOT be used in db schema description -->
<!--
<xsl:stylesheet version="1.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
>-->
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<!-- doctype-system, doctyp-public found in http://www.xml.com/pub/a/2002/09/04/xslt.html -->
<!--<xsl:output method="xml" indent="yes" version="1.0"
doctype-system="http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
doctype-public="-//OASIS//DTD DocBook XML V4.2//EN"/>-->
<xsl:template match="//database">
<!--<section><title><xsl:value-of select="name"/> database tables</title>-->
<!-- generate table descriptions -->
<xsl:choose>
<xsl:when test="table">
<para><variablelist>
<xsl:for-each select="table">
<xsl:call-template name="table_proc_desc" mode="table_desc"/>
</xsl:for-each>
</variablelist></para>
<!-- generate table contents -->
<para>
<xsl:for-each select="table">
<xsl:call-template name="table_proc" mode="column_table"/>
</xsl:for-each>
</para>
</xsl:when>
<xsl:otherwise>
<para/><!-- no table present, insert some dummy content to make docbook happy -->
</xsl:otherwise>
</xsl:choose>
<!--</section>-->
</xsl:template>
<!-- Needed for copying whole nodes from db schema description. We
can not use xsl:copy because in such case are always included namespaces
defined in compiled document (ser.xml for example uses
xmlns:xi="http://www.w3.org/2001/XInclude") but Docbook DTD (version less
than 5) doesn't allow "xmlns" attributes -->
<xsl:template match="@*|node()" mode="copying">
<xsl:choose>
<xsl:when test="local-name() and node()"> <!-- it is probably an element ;-) -->
<xsl:element name="{local-name()}">
<xsl:apply-templates select="@*|node()" mode="copying"/>
</xsl:element>
</xsl:when>
<xsl:otherwise> <!-- anything else - copy it -->
<xsl:copy>
<xsl:apply-templates select="@*|node()" mode="copying"/>
</xsl:copy>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="copy_content_without_namespaces">
<xsl:apply-templates select="@*|node()" mode="copying"/>
</xsl:template>
<!-- Common processing <description> node within <table> and within <column>:
- text in <description> element is given at first (if not empty, it is nested in para)
- all nested elements are included
- if there are no nested elements the text is added even if empty
-->
<xsl:template name="process_description">
<xsl:choose>
<xsl:when test="description/*">
<xsl:choose>
<xsl:when test="description/para"> <!-- there are some para elements -->
<xsl:for-each select="description"><xsl:call-template
name="copy_content_without_namespaces"/></xsl:for-each>
</xsl:when>
<xsl:when test="description/*[local-name()='para']"> <!-- there are some para elements -->
<!-- <xsl:message>copying description X: '<xsl:value-of select="description/text()"/>'</xsl:message>-->
<xsl:for-each select="description"><xsl:call-template
name="copy_content_without_namespaces"/></xsl:for-each>
</xsl:when>
<!-- if text of description is not empty add description
internals into a para element -->
<xsl:otherwise>
<!-- <xsl:message>copying description into para: '<xsl:value-of select="description/text()"/>'</xsl:message>-->
<para><xsl:for-each select="description">
<xsl:call-template name="copy_content_without_namespaces"/></xsl:for-each></para>
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:otherwise>
<!-- use text within description element (may be empty) -->
<para>
<xsl:choose>
<xsl:when test="description/text()">
<xsl:value-of select="description/text()"/>
</xsl:when>
<xsl:otherwise>
<xsl:text> </xsl:text>
</xsl:otherwise>
</xsl:choose>
</para>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
<xsl:template name="table_proc_desc" match="table" mode="table_desc">
<xsl:variable name="tmp" select="translate(name, '_', '-')"/> <!-- '_' is not allowed in docbook -->
<varlistentry>
<term><link linkend='gen-db-{$tmp}'><xsl:value-of select="name"/></link></term>
<listitem><xsl:call-template name="process_description"/></listitem>
</varlistentry>
</xsl:template>
<xsl:template name="table_proc" match="table" mode="column_table">
<!-- create table for columns -->
<!--<section><title><xsl:value-of select="name"/></title>
<para><xsl:value-of select="description"/></para>-->
<xsl:variable name="tmp" select="translate(name, '_', '-')"/> <!-- '_' is not allowed in docbook -->
<table id='gen-db-{$tmp}' frame='all'><title>Table "<xsl:value-of select="name"/>"</title>
<tgroup cols='8' align='left' colsep='1' rowsep='1'>
<!--<colspec colname="c1"/><colspec colname="c2"/><colspec colname="c3"/><colspec colname="c4"/>-->
<thead>
<row>
<entry>name</entry>
<entry>type</entry>
<entry>size</entry>
<entry>default</entry>
<entry>null</entry>
<entry>key</entry>
<entry>extra attributes</entry>
<entry>description</entry>
</row>
</thead>
<tbody>
<xsl:for-each select="column">
<row>
<entry><varname><xsl:value-of select="name"/></varname></entry>
<entry><varname><xsl:value-of select="type"/></varname></entry>
<!-- some datatypes (e.g. time) don't have a size -->
<entry><constant>
<xsl:choose>
<xsl:when test="size">
<xsl:value-of select="size"/>
</xsl:when>
<xsl:otherwise>
<xsl:text>not specified</xsl:text>
</xsl:otherwise>
</xsl:choose>
</constant></entry>
<entry>
<xsl:choose>
<xsl:when test="default">
<xsl:choose>
<xsl:when test="default/null">
<xsl:text>NULL</xsl:text>
</xsl:when>
<xsl:when test= "string(number(default))='NaN'"><!-- test for string value -->
<xsl:text>'</xsl:text>
<xsl:value-of select="default"/>
<xsl:text>'</xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select="default"/><!-- ommit the quotes for numbers -->
</xsl:otherwise>
</xsl:choose>
</xsl:when>
<xsl:otherwise><xsl:text> </xsl:text></xsl:otherwise>
</xsl:choose>
</entry>
<entry>
<xsl:choose>
<xsl:when test="null">
<xsl:text>yes</xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:text>no</xsl:text>
</xsl:otherwise>
</xsl:choose>
</entry>
<entry>
<xsl:choose>
<xsl:when test="primary">
<xsl:text>primary</xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:text> </xsl:text>
</xsl:otherwise>
</xsl:choose>
</entry>
<entry>
<xsl:choose>
<xsl:when test="autoincrement">
<xsl:text>autoincrement</xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:text> </xsl:text>
</xsl:otherwise>
</xsl:choose>
</entry>
<entry><xsl:call-template name="process_description"/></entry>
</row>
</xsl:for-each>
</tbody></tgroup></table>
<!-- create table for indexes -->
<xsl:if test="index">
<table id='gen-db-{$tmp}-index' frame='all'><title>Table "<xsl:value-of select="name"/>" indexes</title>
<tgroup cols='4' align='left' colsep='1' rowsep='1'>
<thead>
<row>
<entry>name</entry>
<entry>type</entry>
<entry>links</entry>
<entry>description</entry>
</row>
</thead>
<tbody>
<xsl:for-each select="index">
<row>
<entry><varname><xsl:value-of select="name"/></varname></entry>
<entry>
<xsl:choose>
<xsl:when test="unique">
<xsl:text>unique</xsl:text>
</xsl:when>
<xsl:when test="primary">
<xsl:text>primary</xsl:text>
</xsl:when>
<xsl:otherwise>
<xsl:text>default</xsl:text>
</xsl:otherwise>
</xsl:choose>
</entry>
<entry>
<xsl:choose>
<xsl:when test="colref">
<xsl:for-each select="colref">
<xsl:call-template name="get-column-name">
<xsl:with-param name="select" select="@linkend"/>
</xsl:call-template>
<xsl:if test="not(position()=last())">
<xsl:text>, </xsl:text>
</xsl:if>
</xsl:for-each>
</xsl:when>
<xsl:otherwise>
<xsl:text> </xsl:text>
</xsl:otherwise>
</xsl:choose>
</entry>
<entry><xsl:call-template name="process_description"/></entry>
</row>
</xsl:for-each>
</tbody></tgroup></table>
</xsl:if>
</xsl:template>
</xsl:stylesheet>