[PATCH 1/2: xorg-sgml-doctools] Provide common CSS & XSL stylesheets for DocBook docs

[Dan Nicholson]

On Tue, Jun 15, 2010 at 10:27 PM, Alan Coopersmith
<alan.coopersmith at oracle.com> wrote:
> These have been copied into & expanded in several modules already,
> might as well make a common copy to share so that our docs end up
> with a common style.
>
> Signed-off-by: Alan Coopersmith <alan.coopersmith at oracle.com>
> ---
>  Makefile.am |    4 +-
>  xorg.css    |   86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  xorg.xsl    |   40 +++++++++++++++++++++++++++
>  3 files changed, 128 insertions(+), 2 deletions(-)
>  create mode 100644 xorg.css
>  create mode 100644 xorg.xsl
>
> diff --git a/Makefile.am b/Makefile.am
> index 11ea95a..049abac 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -19,9 +19,9 @@
>  #  TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
>  #  PERFORMANCE OF THIS SOFTWARE.
>
> -sgmlentdir = $(prefix)/share/sgml/X11
> +sgmldir = $(prefix)/share/sgml/X11
>
> -dist_sgmlent_DATA = defs.ent
> +dist_sgml_DATA = defs.ent xorg.css xorg.xsl

It's a stretch to put the css files in this directory. The ent and xsl
files make sense since xsltproc will search for them here and include
them. Not so for the css file.

I'm not sure what a better alternative would be, though. Just for a datapoint:

$ find /usr/share/sgml -name '*.css' | wc -l
0

Maybe pkgdatadir would be more appropriate, but I guess I'm OK
overloading this path.

>  pkgconfigdir = $(datadir)/pkgconfig
>  pkgconfig_DATA = xorg-sgml-doctools.pc
> diff --git a/xorg.css b/xorg.css
> new file mode 100644
> index 0000000..178fc38
> --- /dev/null
> +++ b/xorg.css
> @@ -0,0 +1,86 @@
> +/*
> + * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> + * copy of this software and associated documentation files (the "Software"),
> + * to deal in the Software without restriction, including without limitation
> + * the rights to use, copy, modify, merge, publish, distribute, sublicense,
> + * and/or sell copies of the Software, and to permit persons to whom the
> + * Software is furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice (including the next
> + * paragraph) shall be included in all copies or substantial portions of the
> + * Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> + * DEALINGS IN THE SOFTWARE.
> + */
> +
> +/* Shared stylesheet for X.Org documentation translated to HTML format */
> +
> +body {
> +  font-family: sans-serif;
> +  background: white;
> +  color: black;
> +}
> +
> +div.sect1 {
> +  border-top: 1px solid #2b5e82;
> +}
> +
> +.structname, .property, .errorname, .function, .parameter, .filename,
> +.type, .symbol, .funcsynopsis, .synopsis {
> +  font-family: monospace;
> +}
> +
> +.funcsynopsis, .synopsis {
> +  background: #e6e6fa;
> +  border: 1px solid #aaaaaa;
> +  padding: 0.5em;
> +  clear: both;
> +}
> +
> +.programlisting {
> +  background: #ffefd5;
> +  margin: 0 1.0em;
> +  padding-top: 0.5em;
> +}
> +
> +.funcsynopsis p, table p, .synopsis p, .figure p {
> +  margin: 0;
> +}
> +
> +.variablelist {
> +  padding-left: 0.5em;
> +}
> +
> +td {
> +  padding-left: 0.5em;
> +}
> +
> +h1, .author, .pubdate, .abstract {
> +  text-align: center;
> +}
> +
> +.legalnotice {
> +  text-align: justify;
> +  font-size: small;
> +  font-style: italic;
> +}
> +
> +.warning {
> +  border: 1px solid red;
> +  background: yellow;
> +  padding-left: 0.5em;
> +}
> +
> +.figure-float {
> +  float: right;
> +  margin-left: 0.5em;
> +}
> +
> diff --git a/xorg.xsl b/xorg.xsl
> new file mode 100644
> index 0000000..eaa05dc
> --- /dev/null
> +++ b/xorg.xsl
> @@ -0,0 +1,40 @@
> +<?xml version="1.0" encoding="utf-8"?>
> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
> +                version="1.0">
> +  <!--
> +Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
> +
> +Permission is hereby granted, free of charge, to any person obtaining a
> +copy of this software and associated documentation files (the "Software"),
> +to deal in the Software without restriction, including without limitation
> +the rights to use, copy, modify, merge, publish, distribute, sublicense,
> +and/or sell copies of the Software, and to permit persons to whom the
> +Software is furnished to do so, subject to the following conditions:
> +
> +The above copyright notice and this permission notice (including the next
> +paragraph) shall be included in all copies or substantial portions of the
> +Software.
> +
> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> +DEALINGS IN THE SOFTWARE.
> +   -->
> +
> +  <!--
> +    Shared stylesheet for X.Org documentation formatted in DocBook/XML
> +    -->
> +  <xsl:param name="html.cleanup" select="1"/>
> +  <xsl:param name="html.stylesheet" select="'xorg.css'"/>
> +  <xsl:param name="chunker.output.indent">yes</xsl:param>
> +  <xsl:param name="html.extra.head.links" select="1"/>
> +  <xsl:param name="saxon.character.representation" select="'entity;decimal'"/>

This setting isn't really useful for xorg since we use xsltproc and
not saxon. However, this appears to be the default value anyway:

http://docbook.sourceforge.net/release/xsl/current/doc/html/saxon.character.representation.html

> +  <xsl:param name="function.parens" select="1"/>
> +  <xsl:param name="funcsynopsis.style" select="ansi"/>
> +  <xsl:param name="abstract.notitle.enabled" select="1"/>
> +  <xsl:param name="variablelist.as.table" select="1"/>
> +  <xsl:param name="use.svg" select="1"/>
> +</xsl:stylesheet>

Looks pretty good, though, and these are mostly nitpicks.

Reviewed-by: Dan Nicholson <dbn.lists at gmail.com>