diff options
| -rw-r--r-- | configure.ac | 27 | ||||
| -rw-r--r-- | doc/Makefile.am | 23 | ||||
| -rw-r--r-- | doc/experiment-player.xml | 31 | ||||
| -rw-r--r-- | doc/html_custom.xsl | 6 | ||||
| -rw-r--r-- | doc/html_titlepage.spec.xml | 688 | 
5 files changed, 770 insertions, 5 deletions
diff --git a/configure.ac b/configure.ac index 887a46e..56f6d70 100644 --- a/configure.ac +++ b/configure.ac @@ -2,11 +2,12 @@  # Process this file with autoconf to produce a configure script.  AC_PREREQ(2.65) -AC_INIT([Experiment Player], [dev], [robin.haberkorn@st.ovgu.de]) +AC_INIT([Experiment Player], [dev], [robin.haberkorn@st.ovgu.de], +	[experiment-player])  AC_CONFIG_AUX_DIR(config)  AM_INIT_AUTOMAKE -AC_CONFIG_SRCDIR(src/player.c) +AC_CONFIG_SRCDIR(src/main.c)  AC_CONFIG_HEADER(config.h)  AC_CANONICAL_BUILD @@ -29,9 +30,10 @@ if [[ x$PKG_CONFIG = x ]]; then  	AC_MSG_ERROR([Couldn't find pkg-config])  fi -# FIXME: this should be configurable  AC_CHECK_PROG(DOXYGEN, doxygen, doxygen) -AM_CONDITIONAL(USE_DOXYGEN, test x$DOXYGEN != x) +AC_CHECK_PROG(XSLTPROC, xsltproc, xsltproc) +XSLT_FLAGS="--xinclude" +AC_SUBST(XSLT_FLAGS)  #  # Checks for libraries. @@ -91,6 +93,23 @@ AC_FUNC_REALLOC  #  # Config options  # +AC_ARG_ENABLE(doxygen-doc, +	AS_HELP_STRING([--enable-doxygen-doc], +		       [Generate Doxygen documentation [default=no]]), +	[doxygen_doc=$enableval], [doxygen_doc=no]) +if [[ $doxygen_doc = yes -a x$DOXYGEN = x ]]; then +        AC_MSG_ERROR([Enabled generating Doxygen documentation, but Doxygen not found! Try --disable-doxygen-doc.]) +fi +AM_CONDITIONAL(BUILD_DOXYGEN, test $doxygen_doc = yes) + +AC_ARG_ENABLE(html-doc, +	AS_HELP_STRING([--enable-html-doc], +		       [Generate HTML documentation [default=yes]]), +	[html_doc=$enableval], [html_doc=yes]) +if [[ $html_doc = yes -a x$XSLTPROC = x ]]; then +        AC_MSG_ERROR([Enabled generating HTML documentation, but XSLTProc not found! Try --disable-html-doc.]) +fi +AM_CONDITIONAL(BUILD_HTML, test $html_doc = yes)  # FIXME  AC_DEFINE(USE_BUILDER, , [foo]) diff --git a/doc/Makefile.am b/doc/Makefile.am index 63be7c7..422b87c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,5 +1,26 @@ -if USE_DOXYGEN +# +# Docbook processing +# TODO: might also generate a man page +# +DB_URI = http://docbook.sourceforge.net/release/xsl/current + +if BUILD_HTML +dist_html_DATA = experiment-player.html +endif +CLEANFILES = experiment-player.html html_titlepage.xsl +EXTRA_DIST = experiment-player.xml html_custom.xsl html_titlepage.spec.xml + +experiment-player.html : experiment-player.xml html_custom.xsl html_titlepage.xsl +	@XSLTPROC@ @XSLT_FLAGS@ -o $@ html_custom.xsl $< + +html_titlepage.xsl : html_titlepage.spec.xml +	@XSLTPROC@ @XSLT_FLAGS@ -o $@ $(DB_URI)/template/titlepage.xsl $< + +# +# Doxygen processing (do not install or distribute) +# +if BUILD_DOXYGEN  noinst_DATA = doxygen/  endif diff --git a/doc/experiment-player.xml b/doc/experiment-player.xml new file mode 100644 index 0000000..bfe5ac1 --- /dev/null +++ b/doc/experiment-player.xml @@ -0,0 +1,31 @@ +<?xml version="1.0"?> + +<book xmlns="http://docbook.org/ns/docbook" +      xmlns:xlink="http://www.w3.org/1999/xlink"> +	<info> +		<title>Experiment Player</title> +		<subtitle>A tool for analyzing experiments...</subtitle> + +		<author> +			<personname><firstname>Jens</firstname> <surname>Lammert</surname></personname> +			<email>jens.lammert@st.ovgu.de</email> +		</author> +		<copyright> +			<year>2012</year><holder>Otto-von-Guericke Universität Magdeburg</holder> +		</copyright> + +		<abstract><para> +			The following document describes how to use the experiment player... +			<!-- TODO --> +		</para></abstract> +	</info> + +	<preface> +		<title>Introduction</title> + +		<para> +			Bla Bla... +			<!-- TODO --> +		</para> +	</preface> +</book> diff --git a/doc/html_custom.xsl b/doc/html_custom.xsl new file mode 100644 index 0000000..af94064 --- /dev/null +++ b/doc/html_custom.xsl @@ -0,0 +1,6 @@ +<?xml version='1.0'?> + +<stylesheet xmlns="http://www.w3.org/1999/XSL/Transform" version="1.0"> +	<import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/> +	<import href="html_titlepage.xsl"/> +</stylesheet> diff --git a/doc/html_titlepage.spec.xml b/doc/html_titlepage.spec.xml new file mode 100644 index 0000000..ea44036 --- /dev/null +++ b/doc/html_titlepage.spec.xml @@ -0,0 +1,688 @@ +<t:templates xmlns:t="http://nwalsh.com/docbook/xsl/template/1.0" +	     xmlns:param="http://nwalsh.com/docbook/xsl/template/1.0/param" +             xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + +<!-- ==================================================================== --> + +<t:titlepage t:element="article" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <mediaobject/> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <hr/> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="set" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <hr/> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="book" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <mediaobject/> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <hr/> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="part" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="division.title" +	   param:node="ancestor-or-self::part[1]"/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="partintro" t:wrapper="div"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="reference" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <hr/> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="refentry" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +<!-- uncomment this if you want refentry titlepages +    <title t:force="1" +	   t:named-template="refentry.title" +	   param:node="ancestor-or-self::refentry[1]"/> +--> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator/> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +  <t:titlepage t:element="dedication" t:wrapper="div" class="titlepage"> +    <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="component.title" +	   param:node="ancestor-or-self::dedication[1]"/> +    <subtitle/> +    </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="acknowledgements" t:wrapper="div" class="titlepage"> +    <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="component.title" +	   param:node="ancestor-or-self::acknowledgements[1]"/> +    <subtitle/> +    </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="preface" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="chapter" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="appendix" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="section" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="sect1" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="sect2" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="sect3" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="sect4" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="sect5" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<t:titlepage t:element="simplesect" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title/> +    <subtitle/> +    <corpauthor/> +    <authorgroup/> +    <author/> +    <othercredit/> +    <releaseinfo/> +    <copyright/> +    <legalnotice/> +    <pubdate/> +    <revision/> +    <revhistory/> +    <abstract/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +    <xsl:if test="count(parent::*)='0'"><hr/></xsl:if> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="bibliography" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="component.title" +	   param:node="ancestor-or-self::bibliography[1]"/> +    <subtitle/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="glossary" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="component.title" +	   param:node="ancestor-or-self::glossary[1]"/> +    <subtitle/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="index" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="component.title" +	   param:node="ancestor-or-self::index[1]"/> +    <subtitle/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +<t:titlepage t:element="setindex" t:wrapper="div" class="titlepage"> +  <t:titlepage-content t:side="recto"> +    <title +	   t:force="1" +	   t:named-template="component.title" +	   param:node="ancestor-or-self::setindex[1]"/> +    <subtitle/> +  </t:titlepage-content> + +  <t:titlepage-content t:side="verso"> +  </t:titlepage-content> + +  <t:titlepage-separator> +  </t:titlepage-separator> + +  <t:titlepage-before t:side="recto"> +  </t:titlepage-before> + +  <t:titlepage-before t:side="verso"> +  </t:titlepage-before> +</t:titlepage> + +<!-- ==================================================================== --> + +</t:templates>  | 
