You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by gn...@apache.org on 2010/10/18 14:52:16 UTC
svn commit: r1023776 - in /karaf/trunk/documentation: pom.xml
src/main/webapp/WEB-INF/scalate/layouts/print.ssp
src/main/webapp/karaf-manual.conf
Author: gnodet
Date: Mon Oct 18 12:52:15 2010
New Revision: 1023776
URL: http://svn.apache.org/viewvc?rev=1023776&view=rev
Log:
Improve manual (allow deployment, generate a all-in-page html + pdf)
Added:
karaf/trunk/documentation/src/main/webapp/WEB-INF/scalate/layouts/print.ssp
karaf/trunk/documentation/src/main/webapp/karaf-manual.conf
Modified:
karaf/trunk/documentation/pom.xml
Modified: karaf/trunk/documentation/pom.xml
URL: http://svn.apache.org/viewvc/karaf/trunk/documentation/pom.xml?rev=1023776&r1=1023775&r2=1023776&view=diff
==============================================================================
--- karaf/trunk/documentation/pom.xml (original)
+++ karaf/trunk/documentation/pom.xml Mon Oct 18 12:52:15 2010
@@ -37,11 +37,13 @@
<netbeans.hint.deploy.server>Tomcat60</netbeans.hint.deploy.server>
<jetty-port>8080</jetty-port>
<jetty-war-dir>${project.build.directory}/webapp/</jetty-war-dir>
- <scalate.version>1.3</scalate.version>
+ <scalate.version>1.4-SNAPSHOT</scalate.version>
<wikitext.version>1.1-SNAPSHOT</wikitext.version>
<scalate.editor>${env.SCALATE_EDITOR}</scalate.editor>
<scalate.mode>production</scalate.mode>
<scalate.workdir>${project.build.directory}/scalateWorkDir</scalate.workdir>
+ <karaf.version>${project.version}</karaf.version>
+ <maven.wagon.version>1.0-beta-6</maven.wagon.version>
</properties>
<repositories>
@@ -195,7 +197,16 @@
</configuration>
</execution>
</executions>
- <dependencies>
+ <configuration>
+ <remoteServerId>people.apache.org</remoteServerId>
+ <remoteServerUrl>scp://people.apache.org/www/karaf.apache.org/manual/${karaf.version}</remoteServerUrl>
+ </configuration>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.maven.wagon</groupId>
+ <artifactId>wagon-ssh</artifactId>
+ <version>${maven.wagon.version}</version>
+ </dependency>
<dependency>
<groupId>org.fusesource.wikitext</groupId>
<artifactId>confluence-core</artifactId>
@@ -268,6 +279,7 @@
javax.servlet.http,
org.osgi.framework,
org.osgi.service.packageadmin,
+ javax.swing.tree,
org.apache.commons.logging;provider=paxlogging;resolution:=optional,
org.apache.log4j;provider=paxlogging;resolution:=optional,
org.slf4j;provider=paxlogging;resolution:=optional,
@@ -280,6 +292,57 @@
</instructions>
</configuration>
</plugin>
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <version>1.2</version>
+ <executions>
+ <execution>
+ <id>preprocess</id>
+ <configuration>
+ <tasks>
+ <echo message="Generating PDF using Prince XML (http://www.princexml.com/)"/>
+ <exec executable="prince">
+ <arg value="${project.build.directory}/sitegen/karaf-manual.html" />
+ <arg value="${project.build.directory}/sitegen/karaf-manual.pdf" />
+ <arg value="--log"/>
+ <arg value="${project.build.directory}/prince.log"/>
+ </exec>
+ </tasks>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ <phase>verify</phase>
+ </execution>
+ </executions>
+ </plugin>
+
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
+ <version>1.5</version>
+ <executions>
+ <execution>
+ <id>attach-artifacts</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>attach-artifact</goal>
+ </goals>
+ <configuration>
+ <artifacts>
+ <artifact>
+ <file>${project.build.directory}/sitegen/karaf-manual.pdf</file>
+ <type>pdf</type>
+ </artifact>
+ <artifact>
+ <file>${project.build.directory}/sitegen/karaf-manual.html</file>
+ <type>html</type>
+ </artifact>
+ </artifacts>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
Added: karaf/trunk/documentation/src/main/webapp/WEB-INF/scalate/layouts/print.ssp
URL: http://svn.apache.org/viewvc/karaf/trunk/documentation/src/main/webapp/WEB-INF/scalate/layouts/print.ssp?rev=1023776&view=auto
==============================================================================
--- karaf/trunk/documentation/src/main/webapp/WEB-INF/scalate/layouts/print.ssp (added)
+++ karaf/trunk/documentation/src/main/webapp/WEB-INF/scalate/layouts/print.ssp Mon Oct 18 12:52:15 2010
@@ -0,0 +1,37 @@
+<%--
+Copyright (C) 2009-2010 the original author or authors.
+See the notice.md file distributed with this work for additional
+information regarding copyright ownership.
+
+Licensed 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.
+--%>
+<%@ var body: String %>
+<%@ var title: String = "Apache Karaf ${karaf.version}" %>
+<!DOCTYPE html>
+<html>
+<head>
+ <link href="${uri("/theme/print.css")}" rel="Stylesheet" type="text/css" />
+ <link href="${uri("/theme/pygmentize.css")}" rel="stylesheet" type="text/css" />
+
+ <title>${title}</title>
+</head>
+<body>
+ <div id="titlepage">
+ <div id="title">Apache Karaf</div>
+ <div id="subtitle">Version ${karaf.version}</div>
+ </div>
+ <div id="main">
+ <%= body %>
+ </div>
+</body>
+</html>
Added: karaf/trunk/documentation/src/main/webapp/karaf-manual.conf
URL: http://svn.apache.org/viewvc/karaf/trunk/documentation/src/main/webapp/karaf-manual.conf?rev=1023776&view=auto
==============================================================================
--- karaf/trunk/documentation/src/main/webapp/karaf-manual.conf (added)
+++ karaf/trunk/documentation/src/main/webapp/karaf-manual.conf Mon Oct 18 12:52:15 2010
@@ -0,0 +1,22 @@
+{attributes:layout=/WEB-INF/scalate/layouts/print.ssp}
+
+h1. Overview
+{include:overview.conf}
+
+h1. Quick Start
+{include:quick-start.conf}
+
+h1. Users Guide
+{include:users-guide/installation.conf}
+{include:users-guide/start-stop.conf}
+{include:users-guide/using-console.conf}
+{include:users-guide/web-console.conf}
+{include:users-guide/remote-console.conf}
+{include:users-guide/child-instances.conf}
+{include:users-guide/security.conf}
+{include:users-guide/failover.conf}
+{include:users-guide/logging-system.conf}
+
+h1. Developers Guide
+{include:developers-guide/extending-console.conf}
+{include:developers-guide/security-framework.conf}