mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-16 14:54:29 +01:00
f865d0feab
What annoyed me for a long time was the fact, that in order to break
into a new paragraph, you need to insert </para><para> in the
description attribute of an option.
Now we will automatically create <para/> elements for every block that
is separated by two consecutive newlines.
I first tried to do this within options-to-docbook.xsl, but it turns
out[1] that this isn't directly possible with XSLT 1.0, so I added
another XSLT file that postprocesses the option descriptions that are
now enclosed in <nixos:option-description/> by options-to-docbook.xsl.
The splitting itself is a bit more involved, because we can't simply
split on every \n\n because we'd also split text nodes of elements, for
example:
<screen><![CDATA[
one line
another one
]]></screen>
This would create one <para/> element for "one line" and another for
"another line", which we obviously don't want because <screen/> is used
to display verbatim contents of what a user is seeing on the screen.
So what we do instead is splitting *only* the top-level text nodes
within the outermost <para/> and leave all elements as-is. If there are
more than one <para/> elements at the top-level, we simply don't process
it at all, because the description then already contains </para><para>.
https://www.mhonarc.org/archive/html/xsl-list/2012-09/msg00319.html
Signed-off-by: aszlig <aszlig@nix.build>
Cc: @edolstra, @domenkozar
236 lines
8.4 KiB
XML
236 lines
8.4 KiB
XML
<?xml version="1.0"?>
|
||
|
||
<xsl:stylesheet version="1.0"
|
||
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||
xmlns:str="http://exslt.org/strings"
|
||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||
xmlns:nixos="tag:nixos.org"
|
||
xmlns="http://docbook.org/ns/docbook"
|
||
extension-element-prefixes="str"
|
||
>
|
||
|
||
<xsl:output method='xml' encoding="UTF-8" />
|
||
|
||
<xsl:param name="revision" />
|
||
<xsl:param name="program" />
|
||
|
||
|
||
<xsl:template match="/expr/list">
|
||
<appendix xml:id="appendix-configuration-options">
|
||
<title>Configuration Options</title>
|
||
<variablelist xml:id="configuration-variable-list">
|
||
<xsl:for-each select="attrs">
|
||
<xsl:variable name="id" select="concat('opt-', str:replace(str:replace(str:replace(str:replace(attr[@name = 'name']/string/@value, '*', '_'), '<', '_'), '>', '_'), '?', '_'))" />
|
||
<varlistentry>
|
||
<term xlink:href="#{$id}">
|
||
<xsl:attribute name="xml:id"><xsl:value-of select="$id"/></xsl:attribute>
|
||
<option>
|
||
<xsl:value-of select="attr[@name = 'name']/string/@value" />
|
||
</option>
|
||
</term>
|
||
|
||
<listitem>
|
||
|
||
<nixos:option-description>
|
||
<para>
|
||
<xsl:value-of disable-output-escaping="yes"
|
||
select="attr[@name = 'description']/string/@value" />
|
||
</para>
|
||
</nixos:option-description>
|
||
|
||
<xsl:if test="attr[@name = 'type']">
|
||
<para>
|
||
<emphasis>Type:</emphasis>
|
||
<xsl:text> </xsl:text>
|
||
<xsl:value-of select="attr[@name = 'type']/string/@value"/>
|
||
<xsl:if test="attr[@name = 'readOnly']/bool/@value = 'true'">
|
||
<xsl:text> </xsl:text>
|
||
<emphasis>(read only)</emphasis>
|
||
</xsl:if>
|
||
</para>
|
||
</xsl:if>
|
||
|
||
<xsl:if test="attr[@name = 'default']">
|
||
<para>
|
||
<emphasis>Default:</emphasis>
|
||
<xsl:text> </xsl:text>
|
||
<xsl:apply-templates select="attr[@name = 'default']" mode="top" />
|
||
</para>
|
||
</xsl:if>
|
||
|
||
<xsl:if test="attr[@name = 'example']">
|
||
<para>
|
||
<emphasis>Example:</emphasis>
|
||
<xsl:text> </xsl:text>
|
||
<xsl:choose>
|
||
<xsl:when test="attr[@name = 'example']/attrs[attr[@name = '_type' and string[@value = 'literalExample']]]">
|
||
<programlisting><xsl:value-of select="attr[@name = 'example']/attrs/attr[@name = 'text']/string/@value" /></programlisting>
|
||
</xsl:when>
|
||
<xsl:otherwise>
|
||
<xsl:apply-templates select="attr[@name = 'example']" mode="top" />
|
||
</xsl:otherwise>
|
||
</xsl:choose>
|
||
</para>
|
||
</xsl:if>
|
||
|
||
<xsl:if test="attr[@name = 'relatedPackages']">
|
||
<para>
|
||
<emphasis>Related packages:</emphasis>
|
||
<xsl:text> </xsl:text>
|
||
<xsl:value-of disable-output-escaping="yes"
|
||
select="attr[@name = 'relatedPackages']/string/@value" />
|
||
</para>
|
||
</xsl:if>
|
||
|
||
<xsl:if test="count(attr[@name = 'declarations']/list/*) != 0">
|
||
<para>
|
||
<emphasis>Declared by:</emphasis>
|
||
</para>
|
||
<xsl:apply-templates select="attr[@name = 'declarations']" />
|
||
</xsl:if>
|
||
|
||
<xsl:if test="count(attr[@name = 'definitions']/list/*) != 0">
|
||
<para>
|
||
<emphasis>Defined by:</emphasis>
|
||
</para>
|
||
<xsl:apply-templates select="attr[@name = 'definitions']" />
|
||
</xsl:if>
|
||
|
||
</listitem>
|
||
|
||
</varlistentry>
|
||
|
||
</xsl:for-each>
|
||
|
||
</variablelist>
|
||
</appendix>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="*" mode="top">
|
||
<xsl:choose>
|
||
<xsl:when test="string[contains(@value, '
')]">
|
||
<programlisting>
|
||
<xsl:text>''
|
||
</xsl:text><xsl:value-of select='str:replace(string/@value, "${", "''${")' /><xsl:text>''</xsl:text></programlisting>
|
||
</xsl:when>
|
||
<xsl:otherwise>
|
||
<literal><xsl:apply-templates /></literal>
|
||
</xsl:otherwise>
|
||
</xsl:choose>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="null">
|
||
<xsl:text>null</xsl:text>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="string">
|
||
<xsl:choose>
|
||
<xsl:when test="(contains(@value, '"') or contains(@value, '\')) and not(contains(@value, '
'))">
|
||
<xsl:text>''</xsl:text><xsl:value-of select='str:replace(@value, "${", "''${")' /><xsl:text>''</xsl:text>
|
||
</xsl:when>
|
||
<xsl:otherwise>
|
||
<xsl:text>"</xsl:text><xsl:value-of select="str:replace(str:replace(str:replace(str:replace(@value, '\', '\\'), '"', '\"'), '
', '\n'), '$', '\$')" /><xsl:text>"</xsl:text>
|
||
</xsl:otherwise>
|
||
</xsl:choose>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="int">
|
||
<xsl:value-of select="@value" />
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="bool[@value = 'true']">
|
||
<xsl:text>true</xsl:text>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="bool[@value = 'false']">
|
||
<xsl:text>false</xsl:text>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="list">
|
||
[
|
||
<xsl:for-each select="*">
|
||
<xsl:apply-templates select="." />
|
||
<xsl:text> </xsl:text>
|
||
</xsl:for-each>
|
||
]
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="attrs[attr[@name = '_type' and string[@value = 'literalExample']]]">
|
||
<xsl:value-of select="attr[@name = 'text']/string/@value" />
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="attrs">
|
||
{
|
||
<xsl:for-each select="attr">
|
||
<xsl:value-of select="@name" />
|
||
<xsl:text> = </xsl:text>
|
||
<xsl:apply-templates select="*" /><xsl:text>; </xsl:text>
|
||
</xsl:for-each>
|
||
}
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="derivation">
|
||
<replaceable>(build of <xsl:value-of select="attr[@name = 'name']/string/@value" />)</replaceable>
|
||
</xsl:template>
|
||
|
||
<xsl:template match="attr[@name = 'declarations' or @name = 'definitions']">
|
||
<simplelist>
|
||
<xsl:for-each select="list/string">
|
||
<member><filename>
|
||
<!-- Hyperlink the filename either to the NixOS Subversion
|
||
repository (if it’s a module and we have a revision number),
|
||
or to the local filesystem. -->
|
||
<xsl:choose>
|
||
<xsl:when test="not(starts-with(@value, '/'))">
|
||
<xsl:choose>
|
||
<xsl:when test="$revision = 'local'">
|
||
<xsl:attribute name="xlink:href">https://github.com/NixOS/nixpkgs/blob/master/<xsl:value-of select="@value"/></xsl:attribute>
|
||
</xsl:when>
|
||
<xsl:otherwise>
|
||
<xsl:attribute name="xlink:href">https://github.com/NixOS/nixpkgs/blob/<xsl:value-of select="$revision"/>/<xsl:value-of select="@value"/></xsl:attribute>
|
||
</xsl:otherwise>
|
||
</xsl:choose>
|
||
</xsl:when>
|
||
<xsl:when test="$revision != 'local' and $program = 'nixops' and contains(@value, '/nix/')">
|
||
<xsl:attribute name="xlink:href">https://github.com/NixOS/nixops/blob/<xsl:value-of select="$revision"/>/nix/<xsl:value-of select="substring-after(@value, '/nix/')"/></xsl:attribute>
|
||
</xsl:when>
|
||
<xsl:otherwise>
|
||
<xsl:attribute name="xlink:href">file://<xsl:value-of select="@value"/></xsl:attribute>
|
||
</xsl:otherwise>
|
||
</xsl:choose>
|
||
<!-- Print the filename and make it user-friendly by replacing the
|
||
/nix/store/<hash> prefix by the default location of nixos
|
||
sources. -->
|
||
<xsl:choose>
|
||
<xsl:when test="not(starts-with(@value, '/'))">
|
||
<nixpkgs/<xsl:value-of select="@value"/>>
|
||
</xsl:when>
|
||
<xsl:when test="contains(@value, 'nixops') and contains(@value, '/nix/')">
|
||
<nixops/<xsl:value-of select="substring-after(@value, '/nix/')"/>>
|
||
</xsl:when>
|
||
<xsl:otherwise>
|
||
<xsl:value-of select="@value" />
|
||
</xsl:otherwise>
|
||
</xsl:choose>
|
||
</filename></member>
|
||
</xsl:for-each>
|
||
</simplelist>
|
||
</xsl:template>
|
||
|
||
|
||
<xsl:template match="function">
|
||
<xsl:text>λ</xsl:text>
|
||
</xsl:template>
|
||
|
||
|
||
</xsl:stylesheet>
|