Author: artdaw
Date: 2008-07-10 12:48:05 -0400 (Thu, 10 Jul 2008)
New Revision: 9516
Modified:
trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml
trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml
Log:
http://jira.jboss.com/jira/browse/RF-3692 - info about 'mvn clean install' command
was added.
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml 2008-07-10 15:59:23 UTC
(rev 9515)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml 2008-07-10 16:48:05 UTC
(rev 9516)
@@ -2,52 +2,51 @@
<section id="ccreate" xreflabel="ccreate">
<?dbhtml filename="ccreate.html"?>
<sectioninfo>
-<keywordset>
-<keyword>create</keyword>
-<keyword>component</keyword>
-<keyword>CDK</keyword>
- <keyword>Guide</keyword>
-</keywordset>
-</sectioninfo>
-<title>Creating and building component skeleton</title>
-<para>
-Let's create a skeleton for the <emphasis
role="bold"><property><inputDate></property></emphasis>
component.
-</para>
-<para> You need to go to the <property>inputDate</property> directory
and then launch the following command: </para>
-<programlisting role="XML"><![CDATA[...
+ <keywordset>
+ <keyword>create</keyword>
+ <keyword>component</keyword>
+ <keyword>CDK</keyword>
+ <keyword>Guide</keyword>
+ </keywordset>
+ </sectioninfo>
+ <title>Creating and building component skeleton</title>
+ <para> Let's create a skeleton for the <emphasis
role="bold">
+ <property><inputDate></property>
+ </emphasis> component. </para>
+ <para> You need to go to the <property>inputDate</property>
directory and then launch the
+ following command: </para>
+ <programlisting role="XML"><![CDATA[...
mvn cdk:create -Dname=inputDate
-...]]>
+...]]>
</programlisting>
-<para>
-As a result three artifacts will be created:
-</para>
-<itemizedlist>
-<listitem>
-<para>
-An XML configuration file for the metadata
-</para>
-</listitem>
-<listitem>
-<para>
-A UI class
-</para>
-</listitem>
-<listitem>
-<para>
-A JSP-like template
-</para>
-</listitem></itemizedlist>
-<para>
-In order to build the component you should stay in the
<property>inputDate</property> directory
-and launch the following command:</para>
-<programlisting role="XML"><![CDATA[...
+ <para> As a result three artifacts will be created: </para>
+ <itemizedlist>
+ <listitem>
+ <para> An XML configuration file for the metadata </para>
+ </listitem>
+ <listitem>
+ <para> A UI class </para>
+ </listitem>
+ <listitem>
+ <para> A JSP-like template </para>
+ </listitem>
+ </itemizedlist>
+ <para> In order to build the component you should stay in the
<property>inputDate</property>
+ directory and launch the following command:</para>
+ <programlisting role="XML"><![CDATA[...
mvn install
-...]]>
+...]]>
</programlisting>
-<para>
-This command generates and compiles the library and then creates a result JAR file.
-A directory named <property>target</property> will be created along with a
<property>src</property> directory.
-If you get a file named
<property>target/inputDate-1.0-SNAPSHOT.jar</property>, everything is set up
successfully. </para>
+ <para> This command generates and compiles the library and then creates a
result JAR file. A
+ directory named <property>target</property> will be created along
with a
+ <property>src</property> directory. If you get a file named
+ <property>target/inputDate-1.0-SNAPSHOT.jar</property>,
everything is set up
+ successfully. </para>
+ <para>
+ If you want to rebuild the component you could use the following command:
+ </para>
+ <programlisting role="XML"><![CDATA[...
+mvn clean install
+...]]>
+ </programlisting>
</section>
-
-
Modified: trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-07-10 15:59:23 UTC (rev
9515)
+++ trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-07-10 16:48:05 UTC (rev
9516)
@@ -5,44 +5,38 @@
<keywordset>
<keyword>setup</keyword>
<keyword>CDK</keyword>
- <keyword>Guide</keyword>
+ <keyword>Guide</keyword>
</keywordset>
</chapterinfo>
<title>Setting up the environment</title>
- <para>
- In order to start working with the <property>Component Development Kit
(CDK)</property>
- and to create your rich component,
- it's necessary to have the following installed:
- </para>
- <itemizedlist>
- <listitem>
+ <para> In order to start working with the <property>Component Development
Kit (CDK)</property>
+ and to create your rich component, it's necessary to have the following
installed: </para>
+ <itemizedlist>
+ <listitem>
<para>
- <ulink
url="http://java.sun.com/javase/downloads/index_jdk5.jsp">The Java SE 5
Development Kit (JDK)</ulink>
- </para>
+ <ulink
url="http://java.sun.com/javase/downloads/index_jdk5.jsp">The Java SE 5
+ Development Kit (JDK)</ulink>
+ </para>
</listitem>
<listitem>
<para>
<ulink
url="http://maven.apache.org/download.html">Apache
Maven 2.0.9</ulink>
- </para>
+ </para>
</listitem>
<listitem>
<para>
<ulink url="http://tomcat.apache.org">Apache Tomcat
6.0</ulink>
- </para>
+ </para>
</listitem>
<listitem>
- <para>
- Browser (on client side)
- </para>
- </listitem>
+ <para> Browser (on client side) </para>
+ </listitem>
</itemizedlist>
- <para>
- After the <property>Maven</property> is installed you should
configure it.
- In this case, please, go to the directory where you've just installed
<property>Maven</property>,
- open a <property>conf/settings.xml</property> file for editing and
add to the <property>profiles</property>
- section this code:
- </para>
+ <para> After the <property>Maven</property> is installed you should
configure it. In this case,
+ please, go to the directory where you've just installed
<property>Maven</property>,
+ open a <property>conf/settings.xml</property> file for editing and
add to the
+ <property>profiles</property> section this code: </para>
<programlisting role="XML"><![CDATA[...
<profile>
<id>cdk</id>
@@ -97,41 +91,35 @@
</profile>
...]]>
</programlisting>
- <para>
- In order to activate new profile, please, add the following after the
<property>profiles</property> section:
- </para>
+ <para> In order to activate new profile, please, add the following after the
+ <property>profiles</property> section: </para>
<programlisting role="XML"><![CDATA[...
<activeProfiles>
<activeProfile>cdk</activeProfile>
</activeProfiles>
-...]]>
+...]]>
</programlisting>
- <note>
+ <note>
<title>Note:</title>
- <para>
- In order to work with <property>Maven</property> from Eclipse,
- it's possible to download and install the
<property>Maven</property> plugin.
- Please, follow the instruction at
- <ulink
url="http://maven.apache.org/eclipse-plugin.html">Eclipse plugins for Maven
page</ulink>
- </para>
+ <para> In order to work with <property>Maven</property> from
Eclipse, it's possible
+ to download and install the <property>Maven</property> plugin.
Please, follow the
+ instruction at <ulink
url="http://maven.apache.org/eclipse-plugin.html">Eclipse plugins
+ for Maven page</ulink>
+ </para>
</note>
- <para>
- The environment is set up now to use the <property>Component Development
Kit (CDK)</property>.
- </para>
- <para>
- We are going to create two components throughout the RichFaces CDK Developer
Guide, but at first
- you need take the following steps in order to set up the
<property>Project</property> and create your library:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Create a new directory where all the components will be stored (for
example <property>Sandbox</property>).
- </para>
+ <para> The environment is set up now to use the <property>Component
Development Kit
+ (CDK)</property>. </para>
+ <para> We are going to create two components throughout the RichFaces CDK
Developer Guide, but
+ at first you need take the following steps in order to set up the
+ <property>Project</property> and create your library: </para>
+ <itemizedlist>
+ <listitem>
+ <para> Create a new directory where all the components will be stored
(for example
+ <property>Sandbox</property>). </para>
</listitem>
<listitem>
- <para>
- Create a file named <property>pom.xml</property> in the
directory with the following content:
- </para>
+ <para> Create a file named <property>pom.xml</property> in
the directory with the
+ following content: </para>
<programlisting role="XML"><![CDATA[...
<?xml version="1.0" encoding="UTF-8"?>
<project
xmlns="http://maven.apache.org/POM/4.0.0"
@@ -195,18 +183,14 @@
</dependency>
</dependencies>
</project>
-...]]>
+...]]>
</programlisting>
- </listitem>
- <listitem>
- <para>
- Close the file
- </para>
- </listitem>
+ </listitem>
+ <listitem>
+ <para> Close the file </para>
+ </listitem>
</itemizedlist>
- <para>
- Here are some of these elements with descriptions:
- </para>
+ <para> Here are some of these elements with descriptions: </para>
<table>
<title>The POM elements</title>
<tgroup cols="2">
@@ -218,30 +202,18 @@
</thead>
<tbody>
<row>
- <entry>
- groupId
- </entry>
- <entry>
- Prefix for the Java package structure of your library
- </entry>
- </row>
+ <entry> groupId </entry>
+ <entry> Prefix for the Java package structure of your library
</entry>
+ </row>
<row>
- <entry>
- url
- </entry>
- <entry>
- Namespace for your library to be used in the TLD file
- </entry>
+ <entry> url </entry>
+ <entry> Namespace for your library to be used in the TLD file
</entry>
</row>
<row>
- <entry>
- version
- </entry>
- <entry>
- Version of your library
- </entry>
+ <entry> version </entry>
+ <entry> Version of your library </entry>
</row>
- </tbody>
- </tgroup>
- </table>
-</chapter>
\ No newline at end of file
+ </tbody>
+ </tgroup>
+ </table>
+</chapter>