<html>
<head>
<base href="http://cwiki.apache.org/confluence">
<link rel="stylesheet" href="/confluence/s/1810/9/13/_/styles/combined.css?spaceKey=SM&forWysiwyg=true"
type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="http://cwiki.apache.org/confluence/display/SM/Documentation+project">Documentation
project</a></h2>
<h4>Page <b>edited</b> by <a href="http://cwiki.apache.org/confluence/display/~gertvanthienen">Gert
Vanthienen</a>
</h4>
<br/>
<h4>Changes (2)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >h3. Links <br>For ServiceMix
4.3-SNAPSHOT <br></td></tr>
<tr><td class="diff-changed-lines" >* Programmer's Guide ([One-page
HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/single/index.html]) ([HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/html/index.html])
<span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">([PDF|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/pdf/index.html])</span>
<span class="diff-added-words"style="background-color: #dfd;">([PDF|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/pdf/index.pdf])</span>
<br></td></tr>
<tr><td class="diff-changed-lines" >* JBI Reference Guide ([One-page
HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/single/index.html]) ([HTML|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/html/index.html])
<span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">([PDF|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/pdf/index.html])</span>
<span class="diff-added-words"style="background-color: #dfd;">([PDF|http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/pdf/index.pdf])</span>
<br></td></tr>
<tr><td class="diff-unchanged" > <br>h3. Source code <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<p>The ServiceMix documentation project aims to build a set of manuals for ServiceMix
using DocBook XML.</p>
<h3><a name="Documentationproject-Links"></a>Links</h3>
<p>For ServiceMix 4.3-SNAPSHOT</p>
<ul>
<li>Programmer's Guide (<a href="http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/single/index.html"
class="external-link" rel="nofollow">One-page HTML</a>) (<a href="http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/html/index.html"
class="external-link" rel="nofollow">HTML</a>) (<a href="http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/manual/pdf/index.pdf"
class="external-link" rel="nofollow">PDF</a>)</li>
<li>JBI Reference Guide (<a href="http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/single/index.html"
class="external-link" rel="nofollow">One-page HTML</a>) (<a href="http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/html/index.html"
class="external-link" rel="nofollow">HTML</a>) (<a href="http://servicemix.apache.org/docs/4.3-SNAPSHOT/docs/jbi/pdf/index.pdf"
class="external-link" rel="nofollow">PDF</a>)</li>
</ul>
<h3><a name="Documentationproject-Sourcecode"></a>Source code</h3>
<p>The source code for this project can be found at <a href="https://svn.apache.org/repos/asf/servicemix/documentation/"
class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/servicemix/documentation/</a></p>
<ul>
<li><tt>trunk</tt> refers to the next development version of ServiceMix
(currently 4.3-SNAPSHOT)</li>
</ul>
<p>Content can be added in two formats:</p>
<ul>
<li>pure DocBook XML source files go in the <b><tt>src/docbkx</tt></b>
folder</li>
<li>a Confluence-alike wiki markup can be used in <b><tt>src/confluence</tt></b></li>
</ul>
<h3><a name="Documentationproject-Projectlayout"></a>Project layout</h3>
<ul>
<li><tt>common</tt> : common files (xsl, css, ...)</li>
<li><tt>docs</tt> : common maven plugin setup for underlying projects</li>
<li><tt>docs/manual</tt> : Programmer's Manual</li>
<li><tt>docs/jbi</tt> : JBI Reference Manual</li>
</ul>
<h3><a name="Documentationproject-Buildinganddeploying"></a>Building and
deploying</h3>
<p>The documentation can be built by running <b><tt>mvn clean install</tt></b>
on the documentation project.</p>
<p>You can also deploy the site directly by running <b><tt>mvn site:deploy</tt></b>
afterwards, provided you have set up the correct credentials for <b><tt>people.apache.org</tt></b>
in <b><tt>~/.m2/settings.xml</tt></b>:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script type="syntaxhighlighter" class="toolbar: false; theme: Default; brush: java; gutter:
false"><![CDATA[
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>people.apache.org</id>
<username>gertv</username>
<!-- either one of these authentication methods -->
<privateKey/>
<password/>
</server>
</servers>
</settings>
]]></script>
</div></div>
<h3><a name="Documentationproject-Hudsonbuilds"></a>Hudson builds</h3>
<p>A Hudson build has been set up for trunk in <a href="http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/"
class="external-link" rel="nofollow">http://hudson.zones.apache.org/hudson/job/ServiceMix-Docs/</a></p>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td
valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16"
align="absmiddle" alt="" border="0"></td><td><b>No automatic deployment</b><br
/>At the moment, we're unable to deploy updates to the documentation automatically from
the Hudson builds.</td></tr></table></div>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;">
<a href="http://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
</div>
<a href="http://cwiki.apache.org/confluence/display/SM/Documentation+project">View
Online</a>
|
<a href="http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=20644423&revisedVersion=2&originalVersion=1">View
Changes</a>
|
<a href="http://cwiki.apache.org/confluence/display/SM/Documentation+project?showComments=true&showCommentArea=true#addcomment">Add
Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|