I realise I should have mentioned this to the dev list.
Quick guide 1. svn up 2. cd main/trunk/docs/docbook/ 3. mvn site 4. wait for maven to download the internet 5. open main/target/... Both PDF and html are generated. Ari -------- Original Message -------- Subject: svn commit: r1098308 - in /cayenne/main/trunk/docs/docbook: ./ css/ main/ main/src/ main/src/images/ stylesheets/ Date: Sun, 01 May 2011 14:07:03 -0000 From: [email protected] Reply-To: [email protected] To: [email protected] Author: amaniatis Date: Sun May 1 14:07:02 2011 New Revision: 1098308 URL: http://svn.apache.org/viewvc?rev=1098308&view=rev Log: A very rough first cut of the docbook build scripts. This does a few things: 1. Builds the pdf and html docs when you execute "mvn site" 2. Obliterates the ugly and annoying default maven site behaviour 3. Applies style sheets, css, etc 4. Sets up some reasonable defaults for TOC and other styling What isn't done yet is pulling across more than just a few pages of sample docbook. This will take lots of effort And of course, making it more attractive, which can wait until later. I've put in some sample docbook elements which are interesting: lists, sections, link and xref, code snippets. This module has not yet been tied into the main Cayenne pom and it is in a folder location designed to keep out of the way of the existing documentation. When it is complete, we can move it into a better location. Added: cayenne/main/trunk/docs/docbook/ cayenne/main/trunk/docs/docbook/css/ cayenne/main/trunk/docs/docbook/css/cayenne-doc.css cayenne/main/trunk/docs/docbook/main/ cayenne/main/trunk/docs/docbook/main/README cayenne/main/trunk/docs/docbook/main/pom.xml cayenne/main/trunk/docs/docbook/main/src/ cayenne/main/trunk/docs/docbook/main/src/images/ cayenne/main/trunk/docs/docbook/main/src/index.xml cayenne/main/trunk/docs/docbook/main/src/installation.xml cayenne/main/trunk/docs/docbook/main/src/part1-cayenne.xml cayenne/main/trunk/docs/docbook/main/src/part2-rop.xml cayenne/main/trunk/docs/docbook/main/src/part3-modeler.xml cayenne/main/trunk/docs/docbook/main/src/temp.xml cayenne/main/trunk/docs/docbook/pom.xml cayenne/main/trunk/docs/docbook/stylesheets/ cayenne/main/trunk/docs/docbook/stylesheets/common-customizations.xsl cayenne/main/trunk/docs/docbook/stylesheets/html.xsl cayenne/main/trunk/docs/docbook/stylesheets/pdf.xsl Added: cayenne/main/trunk/docs/docbook/css/cayenne-doc.css URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/css/cayenne-doc.css?rev=1098308&view=auto ============================================================================== (empty) Added: cayenne/main/trunk/docs/docbook/main/README URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/README?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/README (added) +++ cayenne/main/trunk/docs/docbook/main/README Sun May 1 14:07:02 2011 @@ -0,0 +1 @@ +Although it would be tempting to arrange the docbook source into various folders to organise them better, this causes havoc to relative image links once the source is transformed into html. \ No newline at end of file Added: cayenne/main/trunk/docs/docbook/main/pom.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/pom.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/pom.xml (added) +++ cayenne/main/trunk/docs/docbook/main/pom.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <parent> + <groupId>org.apache.cayenne.docs</groupId> + <artifactId>cayenne-docbook</artifactId> + <version>3.1-SNAPSHOT</version> + </parent> + <modelVersion>4.0.0</modelVersion> + <groupId>org.apache.cayenne.docs</groupId> + <artifactId>cayenne-docbook-main</artifactId> + <name>Cayenne Docbook Main Documenation</name> + + <build> + <plugins> + <plugin> + <groupId>com.agilejava.docbkx</groupId> + <artifactId>docbkx-maven-plugin</artifactId> + <configuration> + <sourceDirectory>src</sourceDirectory> + </configuration> + </plugin> + </plugins> + </build> +</project> \ No newline at end of file Added: cayenne/main/trunk/docs/docbook/main/src/index.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/src/index.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/src/index.xml (added) +++ cayenne/main/trunk/docs/docbook/main/src/index.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<book xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; version="5.0" xml:id="manual" + xmlns:xi="http://www.w3.org/2001/XInclude";> + <info> + <title>Cayenne User Manual</title> + <copyright> + <year>2011</year> + <holder>Apache Software Foundation</holder> + </copyright> + <authorgroup> + <author> + <personname>Aristedes Maniatis</personname> + </author> + <author> + <personname>...more names...</personname> + </author> + </authorgroup> + <legalnotice> + <title>License</title> + <para>Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0</para> + + <para>Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License.</para> + </legalnotice> + </info> + <xi:include href="part1-cayenne.xml" /> + <xi:include href="part2-rop.xml" /> + <xi:include href="part3-modeler.xml" /> +</book> Added: cayenne/main/trunk/docs/docbook/main/src/installation.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/src/installation.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/src/installation.xml (added) +++ cayenne/main/trunk/docs/docbook/main/src/installation.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,142 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; + version="5.0" xml:id="installation"> + <title>Installation</title> + <section xml:id="installation-systemRequirements"> + <title>System Requirements</title> + <itemizedlist> + <listitem> + <para><emphasis>JDK:</emphasis> Cayenne, including GUI tools, is written in 100% + Java, and runs on any Java-compatible platform. Required JDK version is 1.5 or + higher. (The last version of Cayenne compatible with JDK 1.4 is 2.0.x; JDK 1.3 + requires 1.1.x)</para> + </listitem> + <listitem> + <para><emphasis>JDBC Driver:</emphasis> You will need a JDBC driver to access the + database. Information about various drivers and database-specific configuration + is provided on the <link xlink:href="#database-support">Database Support</link> + page.</para> + </listitem> + <listitem> + <para><emphasis>Third-party Libraries:</emphasis> Depending on the application + nature, Cayenne may optionally require a few third-party open source packages. See <xref xlink:href="#installation-dependencies"/></para> + </listitem> + </itemizedlist> + </section> + <section xml:id="installation-obtainingCayenne"> + <title>Obtaining Cayenne</title> + <para>Installing Cayenne is simple - just download and unpack the distribution. <link + xlink:href="http://cayenne.apache.org/download.html";>Select a distribution</link> + for your development platform (cross-platform version, as the name implies, works on any + OS that has Java).</para> + <para>Once you've done that, you can <link xlink:href="#modeler-running">start the + Modeler</link> and use appropriate jar files in your application. See <link + xlink:href="../../../Documentation/Cayenne Guide/Installation/JAR Files and Dependencies/index.html" + >JAR Files and Dependencies</link> for more information. </para> + <para>If you are using Maven2, the runtime dependencies can be obtained in a standard Maven + way (i.e. <link + xlink:href="../../../Documentation/Cayenne Guide/Installation/Cayenne and Maven/index.html" + >by declaring them in the POM</link>), still you likely want to download the + distribution, as it includes the Modeler.</para> + </section> + <section xml:id="installation-maven"> + <title>Using Cayenne in a maven project</title> + <para>Cayenne publishes Maven artifacts to the central Maven repository, so they can be + declared as dependencies in the user application pom.xml.</para> + <para><programlisting> +<dependency> + <groupId>org.apache.cayenne</groupId> + <artifactId>cayenne-server</artifactId> + <version><?eval ${project.version}?></version> +</dependency> +... +<dependency> + <groupId>org.apache.cayenne</groupId> + <artifactId>cayenne-client</artifactId> + <version><?eval ${project.version}?></version> +</dependency> + </programlisting></para> + </section> + <section xml:id="installation-dependencies"> + <title>Cayenne dependencies</title> + <para>If you aren't using Maven or Ivy to manage your dependencies, you might want to + install the jars by hand. This section explains where all the relevant jar files are + located. The following runtime jars are included in Cayenne distribution + <literal>lib</literal> directory:</para> + <itemizedlist> + <listitem> + <para><literal>cayenne-server-<?eval ${project.version}?>.jar</literal> contains + full Cayenne runtime WITHOUT dependencies. Most applications will use only this + file.</para> + </listitem> + <listitem> + <para><literal>cayenne-client-<?eval ${project.version}?>.jar</literal> - a subset of + cayenne-server.jar trimmed for use on the client in an <link xlink:href="#part2" + >ROP application</link>.</para> + </listitem> + <listitem> + <para><literal>cayenne-tools-<?eval ${project.version}?>.jar</literal> - Ant tasks</para> + </listitem> + </itemizedlist> + <para>When using <literal>cayenne-server-<?eval ${project.version}?>.jar</literal> you'll need a few third + party jars (all included in <literal>lib/third-party</literal> directory of the + distribution):</para> + <itemizedlist> + <listitem> + <para><link xlink:href="http://jakarta.apache.org/velocity/";>Apache Velocity + Template Engine</link>, version 1.6.x (and all its dependencies bundled + with velocity-dep)</para> + </listitem> + <listitem> + <para><link xlink:href="http://jakarta.apache.org/commons/collections";>Apache + Commons Collections</link>, version 3.1</para> + </listitem> + <listitem> + <para><link xlink:href="http://jakarta.apache.org/commons/logging/";>Apache Commons + Logging</link>, version 1.1</para> + </listitem> + </itemizedlist> + <para>ROP client dependencies are explained <link xlink:href="#rop-installation" + >here</link>.</para> + </section> + <section xml:id="installation-optionalDependencies"> + <title>Cayenne optional dependencies</title> + <para>One or more of the following libraries may be needed depending on how you use + Cayenne:</para> + <itemizedlist> + <listitem> + <para><link xlink:href="http://ant.apache.org/";>Apache Ant</link>, version 1.6 or + newer. Needed for <link xlink:href="#antTasks">Cayenne Ant Tasks</link>.</para> + </listitem> + <listitem> + <para><link xlink:href="http://jakarta.apache.org/commons/pool/";>Apache Commons + Pool</link> , version 1.2 and <link + xlink:href="http://jakarta.apache.org/commons/dbcp/";>Apache Commons + DBCP</link>, version 1.2.1. Needed if you use DBCPDataSourceFactory for one + of the DataNodes.</para> + </listitem> + <listitem> + <para><link xlink:href="http://www.jgroups.org/";>JGroups</link>, version 2.2.7 or + newer. Needed if you plan to use remote notifications via JGroups + transport.</para> + </listitem> + <listitem> + <para><link xlink:href="http://java.sun.com/products/jms/";>Java Messaging Service + (JMS)</link>. Needed if you plan to use remote notifications via JMS + transport.</para> + </listitem> + <listitem> + <para><link xlink:href="http://vpp.sourceforge.net/";>Foundry Logic VPP + Library</link> , version 2.2.1 (included in + <literal>lib/third-party</literal> directory of the distribution). Needed + for <link xlink:href="#antTasks-cgen">class generation options</link> with + Ant.</para> + </listitem> + <listitem> + <para><link xlink:href="http://www.opensymphony.com/oscache/";>OSCache</link> version + 2.3.2 or newer. Needed if you plan to use OSCache as your <link + xlink:href="#caching-query">query results cache provider</link>.</para> + </listitem> + </itemizedlist> + </section> +</chapter> Added: cayenne/main/trunk/docs/docbook/main/src/part1-cayenne.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/src/part1-cayenne.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/src/part1-cayenne.xml (added) +++ cayenne/main/trunk/docs/docbook/main/src/part1-cayenne.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<part xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; version="5.0" + xml:id="part1" xmlns:xi="http://www.w3.org/2001/XInclude";> + <title>Installation</title> + <xi:include href="installation.xml"/> +</part> Added: cayenne/main/trunk/docs/docbook/main/src/part2-rop.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/src/part2-rop.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/src/part2-rop.xml (added) +++ cayenne/main/trunk/docs/docbook/main/src/part2-rop.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<part xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; version="5.0" + xml:id="part2" xmlns:xi="http://www.w3.org/2001/XInclude";> + <title>Remote object persistence</title> + +</part> Added: cayenne/main/trunk/docs/docbook/main/src/part3-modeler.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/src/part3-modeler.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/src/part3-modeler.xml (added) +++ cayenne/main/trunk/docs/docbook/main/src/part3-modeler.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?> +<part xmlns="http://docbook.org/ns/docbook"; xmlns:xlink="http://www.w3.org/1999/xlink"; version="5.0" + xml:id="part3" xmlns:xi="http://www.w3.org/2001/XInclude";> + <title>Cayenne modeler</title> +</part> Added: cayenne/main/trunk/docs/docbook/main/src/temp.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/main/src/temp.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/main/src/temp.xml (added) +++ cayenne/main/trunk/docs/docbook/main/src/temp.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article version="5.0" xmlns="http://docbook.org/ns/docbook"; xmlns:xl="http://www.w3.org/1999/xlink";> + <info> + <title>Apache Cayenne Documentation - Cayenne and Maven</title> + </info> + <para><link xl:href="http://cayenne.apache.org/";><inlinemediaobject><imageobject role="html"> + <imagedata fileref="./../../../../images/logo.gif" scalefit="1"/> + </imageobject> +<imageobject role="fo"> + <imagedata contentdepth="100%" contentwidth="" depth="" fileref="./../../../../images/logo.gif" scalefit="1" width="100%"/> + </imageobject> +</inlinemediaobject></link></para> + <para><link xl:href="../../../../index.html">Cayenne User Documentation</link></para> + <para>Cayenne and Maven</para> + <anchor xml:id="cayenne_toc"/> + <itemizedlist><listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Introduction/index.html">Introduction</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Installation/index.html">Installation</link><itemizedlist><listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Installation/Upgrade/index.html">Upgrade</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Installation/JAR Files and Dependencies/index.html">JAR Files and Dependencies</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Installation/Cayenne and Maven/index.html">Cayenne and Maven</link><itemizedlist><listitem> + <para/> + </listitem> +</itemizedlist></para> + </listitem> +</itemizedlist></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Tutorial/index.html">Tutorial</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Design/index.html">Design</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/DataContext/index.html">DataContext</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Queries/index.html">Queries</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/DataObjects/index.html">DataObjects</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Stored Procedures/index.html">Stored Procedures</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Expressions/index.html">Expressions</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Lifecycle Callbacks/index.html">Lifecycle Callbacks</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Performance Tuning/index.html">Performance Tuning</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Caching and Fresh Data/index.html">Caching and Fresh Data</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Deployment/index.html">Deployment</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Ant Tasks/index.html">Ant Tasks</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Maven2 Plugins/index.html">Maven2 Plugins</link></para> + </listitem> +<listitem> + <para><link xl:href="../../../../Documentation/Cayenne Guide/Customization/index.html">Customization</link></para> + </listitem> +</itemizedlist> + <anchor xml:id="ConfluenceContent"/> + <section remap="h2"> + <title><anchor xml:id="CayenneandMaven-CayenneandMaven" xreflabel=""/>Cayenne and Maven</title> + <para>Cayenne publishes Maven2 artifacts to the central Maven repository, so they can be declared as dependencies in the user application <literal>pom.xml</literal>:</para> + <screen><dependency> + <groupId>org.apache.cayenne</groupId> + <artifactId>cayenne-server</artifactId> + <version>X.Y</version> +</dependency> +... +<dependency> + <groupId>org.apache.cayenne</groupId> + <artifactId>cayenne-client</artifactId> + <version>X.Y</version> +</dependency> +</screen> + <para>. Copyright ©2001-2010 Apache Software Foundation </para> + </section> +</article> Added: cayenne/main/trunk/docs/docbook/pom.xml URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/pom.xml?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/pom.xml (added) +++ cayenne/main/trunk/docs/docbook/pom.xml Sun May 1 14:07:02 2011 @@ -0,0 +1,172 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.cayenne.parents</groupId> + <artifactId>cayenne-docs-parent</artifactId> + <version>3.1-SNAPSHOT</version> + </parent> + + <modules> + <module>main</module> + </modules> + + <groupId>org.apache.cayenne.docs</groupId> + <artifactId>cayenne-docbook</artifactId> + <name>Cayenne Docbook Documenation</name> + <packaging>pom</packaging> + + <distributionManagement> + <site> + <id>website</id> + <url>scp://people.apache.org/www/cayenne/docbook/</url> + </site> + </distributionManagement> + + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>com.agilejava.docbkx</groupId> + <artifactId>docbkx-maven-plugin</artifactId> + <version>2.0.11</version> + <dependencies> + <dependency> + <groupId>org.docbook</groupId> + <artifactId>docbook-xml</artifactId> + <version>4.4</version> + <scope>runtime</scope> + </dependency> + </dependencies> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-antrun-plugin</artifactId> + <version>1.6</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>2.2</version> + </plugin> + </plugins> + </pluginManagement> + + + <plugins> + <plugin> + <groupId>com.agilejava.docbkx</groupId> + <artifactId>docbkx-maven-plugin</artifactId> + <configuration> + <xincludeSupported>true</xincludeSupported> + <highlightSource>true</highlightSource> + <targetDirectory>${basedir}/target/site/</targetDirectory> + <sourceDirectory>disabled-for-parent-pom</sourceDirectory> + <includes>index.xml</includes> + </configuration> + <executions> + <execution> + <id>builcd-pdf</id> + <configuration> + <foCustomization>${project.parent.basedir}/stylesheets/pdf.xsl</foCustomization> + <postProcess> + <delete failonerror="false"> + <fileset dir="target/site/" includes="*.fo"/> + </delete> + <move file="target/site/index.pdf" tofile="target/site/${project.artifactId}.pdf"/> + </postProcess> + </configuration> + <phase>site</phase> + <goals> + <goal>generate-pdf</goal> + </goals> + </execution> + <execution> + <id>build-html</id> + <configuration> + <htmlCustomization>${project.parent.basedir}/stylesheets/html.xsl</htmlCustomization> + <chunkedOutput>true</chunkedOutput> + <postProcess> + <copy todir="${basedir}/target/site/css"> + <fileset dir="${project.parent.basedir}/css"/> + </copy> + <copy todir="${basedir}/target/site/images"> + <fileset dir="${basedir}/src/images"/> + </copy> + </postProcess> + </configuration> + <phase>site</phase> + <goals> + <goal>generate-html</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <configuration> + <generateReports>false</generateReports> + <sourceDirectory>src</sourceDirectory> + <includes>index.xml</includes> + </configuration> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-antrun-plugin</artifactId> + <executions> + <execution> + <id>cleanup-maven</id> + <phase>site</phase> + <goals> + <goal>run</goal> + </goals> + <configuration> + <target> + <delete failonerror="false"> + <filelist dir="target/site/css" files="maven-base.css,maven-theme.css,print.css,site.css"/> + <!-- collapsed.gifx is deliberately mispelt since we want to leave one image behind to avoid a maven problem with deploying a completely empty site --> + <filelist dir="target/site/images" files="collapsed.gifx,external.png,icon_info_sml.gif,icon_warning_sml.gif,newwindow.png,expanded.gif,icon_error_sml.gif,icon_success_sml.gif"/> + </delete> + <delete dir="target/site/images/logos" failonerror="false"/> + </target> + </configuration> + + </execution> + </executions> + </plugin> + </plugins> + + + <extensions> + <extension> + <groupId>org.apache.maven.wagon</groupId> + <artifactId>wagon-ssh</artifactId> + <version>1.0-beta-7</version> + </extension> + </extensions> + </build> +</project> Added: cayenne/main/trunk/docs/docbook/stylesheets/common-customizations.xsl URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/stylesheets/common-customizations.xsl?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/stylesheets/common-customizations.xsl (added) +++ cayenne/main/trunk/docs/docbook/stylesheets/common-customizations.xsl Sun May 1 14:07:02 2011 @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; version="1.0"> + + <!-- The next line is needed to work with maven injecting the docbook stylesheets --> + <xsl:import href="urn:docbkx:stylesheet" /> + + <xsl:param name="keep.relative.image.uris" select="1"/> + <xsl:param name="toc.section.depth">1</xsl:param> + + <!-- disable TOC for each part --> + <xsl:template name="generate.part.toc"></xsl:template> + +</xsl:stylesheet> Added: cayenne/main/trunk/docs/docbook/stylesheets/html.xsl URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/stylesheets/html.xsl?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/stylesheets/html.xsl (added) +++ cayenne/main/trunk/docs/docbook/stylesheets/html.xsl Sun May 1 14:07:02 2011 @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; version="1.0"> + + <xsl:include href="common-customizations.xsl"/> + + <xsl:param name="html.stylesheet" select="'css/cayenne-doc.css'"/> + <xsl:param name="chunker.output.encoding">UTF-8</xsl:param> + + <!-- Only chapters start a new page --> + <xsl:param name="chunk.section.depth">0</xsl:param> + + <!-- Don't add any embedded styles --> + <xsl:param name="css.decoration">0</xsl:param> + + <xsl:param name="ignore.image.scaling">1</xsl:param> + + <xsl:param name="use.id.as.filename">1</xsl:param> +</xsl:stylesheet> Added: cayenne/main/trunk/docs/docbook/stylesheets/pdf.xsl URL: http://svn.apache.org/viewvc/cayenne/main/trunk/docs/docbook/stylesheets/pdf.xsl?rev=1098308&view=auto ============================================================================== --- cayenne/main/trunk/docs/docbook/stylesheets/pdf.xsl (added) +++ cayenne/main/trunk/docs/docbook/stylesheets/pdf.xsl Sun May 1 14:07:02 2011 @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; version="1.0"> + + <xsl:include href="common-customizations.xsl"/> + + <xsl:param name="paper.type">A4</xsl:param> + + <!-- don't indent the body text --> + <xsl:param name="body.start.indent">0pt</xsl:param> + + <!-- print headers and footers mirrored so double sided printing works --> + <xsl:param name="fop1.extensions" select="1"/> + <xsl:param name="double.sided" select="1"/> + + <xsl:param name="admon.graphics" select="0"/> + <xsl:param name="admon.graphics.extension">.png</xsl:param> + <xsl:param name="admon.graphics.path">stylesheets/docbook-xsl-ns/images/</xsl:param> + <xsl:param name="admon.textlabel" select="1"/> + + <xsl:param name="callout.graphics" select="1"/> + <xsl:param name="callout.graphics.extension">.png</xsl:param> + <xsl:param name="callout.graphics.path">stylesheets/docbook-xsl-ns/images/callouts/</xsl:param> + + <xsl:param name="footer.rule">0</xsl:param> + + <!-- Separation between glossary terms and descriptions when glossaries are presented using lists. --> + <xsl:param name="glossterm.separation">2em</xsl:param> + + <!-- This parameter specifies the width reserved for glossary terms when a list presentation is used. --> + <xsl:param name="glossterm.width">10em</xsl:param> + + <!-- Specifies the longest term in variablelists. In variablelists, the listitem is indented to leave room for the term elements. The indent may be computed if it is not specified with a termlength attribute on the variablelist element. The computation counts characters in the term elements in the list to find the longest term. However, some terms are very long and would produce extreme indents. This parameter lets you set a maximum character count. Any terms longer than the maximum would line wrap. The default value is 24. The character counts are converted to physical widths by multiplying by 0.50em. There is some variability in how many characters fit in the space since some characters are wider than others. --> + <xsl:param name="variablelist.max.termlength">18</xsl:param> + + <!-- Custom font settings - preferred truetype font --> + <xsl:param name="title.font.family">Lucinda Grande,sans-serif</xsl:param> + <xsl:param name="body.font.family">Times,serif</xsl:param> + <xsl:param name="sans.font.family">Lucinda Grande,sans-serif</xsl:param> + <xsl:param name="dingbat.font.family">Lucinda Grande,serif</xsl:param> + <xsl:param name="monospace.font.family">monospace</xsl:param> + + <!-- Specify the default text alignment. The default text alignment is used for most body text. --> + <xsl:param name="alignment">left</xsl:param> + + + <!-- Specifies the default point size for body text. The body font size is specified in two parameters (body.font.master and body.font.size) so that math can be performed on the font size by XSLT. --> + <xsl:param name="body.font.master">11</xsl:param> + + <xsl:param name="hyphenate">false</xsl:param> + + <!-- "normal" is 1.6. This value is multiplied by the font size --> + <xsl:param name="line-height">1.5</xsl:param> + + <!-- Specify the spacing required between normal paragraphs. --> + <xsl:attribute-set name="normal.para.spacing"> + <xsl:attribute name="space-before.optimum">0.8em</xsl:attribute> + <xsl:attribute name="space-before.minimum">0.6em</xsl:attribute> + <xsl:attribute name="space-before.maximum">1.0em</xsl:attribute> + </xsl:attribute-set> + + <!-- Tables, examples, figures, and equations don't need to be forced onto onto one page without page breaks. --> + <xsl:attribute-set name="formal.object.properties"> + <xsl:attribute name="keep-together.within-column">auto</xsl:attribute> + </xsl:attribute-set> + + <!-- The body bottom margin is the distance from the last line of text in the page body to the bottom of the region-after. --> + <xsl:param name="body.margin.bottom">20mm</xsl:param> + + <!-- The body top margin is the distance from the top of the region-before to the first line of text in the page body. --> + <xsl:param name="body.margin.top">20mm</xsl:param> + + <!-- The top page margin is the distance from the physical top of the page to the top of the region-before. --> + <xsl:param name="page.margin.top">10mm</xsl:param> + + <!-- The bottom page margin is the distance from the bottom of the region-after to the physical bottom of the page. --> + <xsl:param name="page.margin.bottom">10mm</xsl:param> + + <!-- The inner page margin. The inner page margin is the distance from binding edge of the page to the first column of text. In the left-to-right, top-to-bottom writing direction, this is the left margin of recto pages. The inner and outer margins are usually the same unless the output is double-sided. --> + <xsl:param name="page.margin.inner">25mm</xsl:param> + + <!-- The outer page margin. The outer page margin is the distance from non-binding edge of the page to the last column of text. In the left-to-right, top-to-bottom writing direction, this is the right margin of recto pages. The inner and outer margins are usually the same unless the output is double-sided. --> + <xsl:param name="page.margin.outer">15mm</xsl:param> + + <!-- Make hyperlinks blue and don't display the underlying URL --> + <xsl:param name="ulink.show" select="0" /> + + <xsl:attribute-set name="xref.properties"> + <xsl:attribute name="color">blue</xsl:attribute> + </xsl:attribute-set> + + +</xsl:stylesheet>
