<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<body link="#355491" alink="#4262a1" vlink="#355491" style="background: #e2e2e2; margin: 0; padding: 20px;">
<div>
<table cellpadding="0" bgcolor="#FFFFFF" border="0" cellspacing="0" style="border: 1px solid #dadada; margin-bottom: 30px; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td>
<table border="0" cellpadding="0" cellspacing="0" bgcolor="#FFFFFF" style="border: solid 2px #ccc; background: #dadada; width: 100%; -moz-border-radius: 6px; -webkit-border-radius: 6px;">
<tbody>
<tr>
<td bgcolor="#000000" valign="middle" height="58px" style="border-bottom: 1px solid #ccc; padding: 20px; -moz-border-radius-topleft: 3px; -moz-border-radius-topright: 3px; -webkit-border-top-right-radius: 5px; -webkit-border-top-left-radius: 5px;">
<h1 style="color: #333333; font: bold 22px Arial, Helvetica, sans-serif; margin: 0; display: block !important;">
<!-- To have a header image/logo replace the name below with your img tag -->
<!-- Email clients will render the images when the message is read so any image -->
<!-- must be made available on a public server, so that all recipients can load the image. -->
<a href="http://community.jboss.org/index.jspa" style="text-decoration: none; color: #E1E1E1">Community</a></h1>
</td>
</tr>
<tr>
<td bgcolor="#FFFFFF" style="font: normal 12px Arial, Helvetica, sans-serif; color:#333333; padding: 20px; -moz-border-radius-bottomleft: 4px; -moz-border-radius-bottomright: 4px; -webkit-border-bottom-right-radius: 5px; -webkit-border-bottom-left-radius: 5px;"><h3 style="margin: 10px 0 5px; font-size: 17px; font-weight: normal;">
Building JBoss Tools Documentaion
</h3>
<span style="margin-bottom: 10px;">
modified by <a href="http://community.jboss.org/people/smukhina">Svetlana Mukhina</a> in <i>JBoss Tools</i> - <a href="http://community.jboss.org/docs/DOC-13341">View the full document</a>
</span>
<hr style="margin: 20px 0; border: none; background-color: #dadada; height: 1px;">
<div class="jive-rendered-content"><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;"><span style="Bitstream Vera Sans [bitstream]&quot: ; , sans-serif: ; font-size: 10pt; font-family: &quot; , &quot: ; Helvetica [Adobe]&quot: ; ">You can download a folder with a plug-in either from a <a class="jive-link-external-small" href="http://anonsvn.jboss.org/repos/jbosstools">Anonymous SVN</a> or a <a class="jive-link-external-small" href="https://svn.jboss.org/repos/jbosstools">Committer SVN </a><span style="text-decoration: none;"> </span> ( if you have commiter rights</span><span style="Bitstream Vera Sans [bitstream]&quot: ; , sans-serif: ; font-size: 10pt; font-family: &quot; , &quot: ; Helvetica [Adobe]&quot: ; ">) repsositories </span><span style="font-family: &quot;Bitstream Vera Sans [bitstream]&quot;, &quot;Helvetica [Adobe]&quot;, sans-serif;">. In the plug-in's folder you will find a directory with documentation.<span style="font-size: 10pt;">This instruction explains how you can build the documentation. </span></span></span></p><p><span style="font-family: arial,helvetica,sans-serif;"><br/></span></p><h3><span style="font-family: arial,helvetica,sans-serif;">Prerequisites</span></h3><p><span style="font-family: arial,helvetica,sans-serif;"><br/>1.Maven building tool<br/>2.You need to make sure you have downloaded all required files and folder from the repository:</span></p><p><span style="font-family: arial,helvetica,sans-serif;">    a) Plug-in folder</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;">    b) the <em style="font-style: italic;"><strong style="font-weight: bold;">documentation</strong></em> folder</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;">3.Maven requires a number of plug-ins (jDocBook etc.) to generate JBoss Tools        documentation    and therefore you need to specify where Maven can download those plug-ins. The easiest way is to create a new profile in the Maven configuration file (<strong style="font-weight: bold;"><em style="font-style: italic;">settings.xml</em></strong>). You will find the file in<strong style="font-weight: bold;"> %M2_HOME%/conf/</strong> or <strong style="font-weight: bold;">%USER_HOME%/.m2/</strong>. Open the <strong style="font-weight: bold;"><em style="font-style: italic;">settings.xml </em></strong>and add the following profile:</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;"><br/></span></p><pre class="jive-pre"><code class="jive-code"> <profile>
      <id>documentation</id>
      <repositories>
        <repository>
          <id>maven2-repository.dev.java.net</id>
          <name>Java.net Repository for Maven</name>
          <url>http://download.java.net/maven/1</url>
          <layout>legacy</layout>
        </repository>
        <repository>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
            <updatePolicy>never</updatePolicy>
          </snapshots>
          <id>repository.jboss.com</id>
          <name>Jboss Repository for Maven</name>
          <url>http://repository.jboss.com/maven2/</url>
          <layout>default</layout>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
            <updatePolicy>never</updatePolicy>
          </snapshots>
          <id>repository.jboss.com</id>
          <name>Jboss Repository for Maven</name>
          <url> http://repository.jboss.com/maven2/ </url>
          <layout>default</layout>
        </pluginRepository>
        <pluginRepository>
          <releases>
          <enabled>false</enabled>
             </releases>
                 <snapshots>
            <enabled>true</enabled>
             </snapshots>
              <id>snapshots.jboss.org</id>
             <name>Jboss Snapshots Repository for Maven</name>
          <url>http://snapshots.jboss.org/maven2/</url>
          <layout>default</layout>
     </pluginRepository>
     </pluginRepositories>
    </profile></code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;">Then you need to activate the profile if you want to use it permanently. Find the   <em style="font-style: italic;"><activeProfiles></em> tag and add this line as a child element:</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;"><br/></span></p><pre class="jive-pre"><code class="jive-code">  <activeProfile>documentation</activeProfile></code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p style="margin-bottom: 0in;"><span style="font-family: arial,helvetica,sans-serif;">Otherwise you should explicitly activate the profile with <strong style="font-weight: bold;">-P profile_name </strong>option while building the documentaion.</span></p><h3><span style="font-family: arial,helvetica,sans-serif;">Building Steps</span></h3><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;">So, you checked out the plug-in for which you want to build documentation and the documentation folder. And now you can proceed to building the documentation.</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;"><br/>1.Find the <em style="font-style: italic;"><strong style="font-weight: bold;">pom.xml</strong></em> file, that is responsible for building the documentation,  in the plug-in folder you downloaded. Normally it’s located in “/docs/reference”.</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;"><br/>2.Run <strong style="font-weight: bold;">mvn clean install</strong>  or <strong style="font-weight: bold;">mvn clean install -P profile_name</strong> (if you didn't activate your profile in Maven's <strong style="font-weight: bold;"><em style="font-style: italic;">settings.xml</em></strong>) command in the folder with <strong style="font-weight: bold;"><em style="font-style: italic;">pom.xml </em></strong>to start building the documentation.</span></p><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;"><br/></span></p><pre class="jive-pre"><code class="jive-code">Example:
user@user-desktop:/home/user/trunk/seam/docs/reference$ mvn clean install
</code></pre><p style="margin-bottom: 0in; line-height: 100%;"><span style="font-family: arial,helvetica,sans-serif;">3.If everything is configured correctly you will see a “BUILD SUCCESSFUL” message. You will also see a generated <strong style="font-weight: bold;"><em style="font-style: italic;">target</em></strong> folder that contains the built documentation.</span></p><pre class="jive-pre"><code class="jive-code">Example:
To open the HTML version of the “Seam Dev Tools Reference Guide” guide you need to proceed to
user@user-desktop:/home/user/trunk/seam/docs/seam/docs/reference/target/docbook/publish/en-US/html_single
and open index.html file.</code></pre><h3>Documentation Profiles</h3><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p lang="en-US" style="margin-bottom: 0in;">There are 3 profiles that you can build documentation with:</p><p lang="en-US" style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p lang="en-US" style="margin-bottom: 0in;"><strong style="font-weight: bold;">release</strong> builds release documentation with “new” or “updated” markers next to the corresponding chapters and sections titles</p><p lang="en-US" style="margin-bottom: 0in;"><strong style="font-weight: bold;">releaseJBDS</strong>  builds release documentation with Jboss.com styles for commercial products</p><p lang="en-US" style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><blockquote class="jive-quote"><p><span style="font-family: arial, helvetica, sans-serif;">Do not forget to redeploy "jbosstools-jdocbook-style" and "jbosstools-docbook-xslt" if the have been changed. </span></p><p><span style="font-family: arial, helvetica, sans-serif;"><span>In order to redeploy you should run 'mvn deploy'  from the proper directory. You shoudl also have necessary credentials to deploy to the </span><a class="jive-link-external-small" href="http://snapshots.jboss.org/maven2" target="_blank">http://snapshots.jboss.org/maven2</a></span></p></blockquote><p lang="en-US" style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p lang="en-US" style="margin-bottom: 0in;"><strong style="font-weight: bold;">diffmk</strong> builds  documentation with markers highlighting changes comparing to the previous release version and sets “new” or “updated” markers next to the corresponding chapters and sections titles.<strong style="font-weight: bold;">Note:</strong> Please make sure that you have the master_output.xml file (normally the file can be found in \pluginName\docs\reference\en\) as a new guide may not have such file since there's nothing to compare with.</p><p lang="en-US" style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p lang="en-US" style="margin-bottom: 0in;">This command launches building documentation with a profile.</p><pre class="jive-pre"><code class="jive-code">mvn install -Pprofile_name
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p lang="en-US" style="margin-bottom: 0in;">By default, with no profile specified, Night Build docs are generated.</p><p lang="en-US" style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p lang="en-US" style="margin-bottom: 0in;">In order to build all the guide from one place you need to have JBoss Tools trunk checked out then cd to JBoss_tools_trunk/documentation/jbds-docs/ to build JBDS guides with jboss.com styles or to  JBoss_tools_trunk/documentation/jboss-tools-docs to build JBoss Tools guides.</p><p lang="en-US" style="margin-bottom: 0in;">and run</p><p lang="en-US" style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><pre class="jive-pre"><code class="jive-code">mvn assembly:assembly
</code></pre><p style="min-height: 8pt; height: 8pt; padding: 0px;"> </p><p>You can optionally use a profile in this command.</p><pre class="jive-pre"><code class="jive-code">mvn assembly:assembly -Pprofile_name
</code></pre></div>
<div style="background-color: #f4f4f4; padding: 10px; margin-top: 20px;">
<p style="margin: 0;">Comment by <a href="http://community.jboss.org/docs/DOC-13341">going to Community</a></p>
<p style="margin: 0;">Create a new document in JBoss Tools at <a href="http://community.jboss.org/choose-container!input.jspa?contentType=102&containerType=14&container=2128">Community</a></p>
</div></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>