Author: artdaw
Date: 2008-07-09 12:54:10 -0400 (Wed, 09 Jul 2008)
New Revision: 9494
Added:
trunk/docs/cdkguide/en/src/main/resources/images/tree.png
Removed:
trunk/docs/cdkguide/en/src/main/docbook/modules/pcreate.xml
Modified:
trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml
trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml
trunk/docs/cdkguide/en/src/main/docbook/master.xml
trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml
Log:
http://jira.jboss.com/jira/browse/RF-3692 - Creating project for component, Creating and
building component sections were added
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml 2008-07-09 15:55:52 UTC
(rev 9493)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/ccreate.xml 2008-07-09 16:54:10 UTC
(rev 9494)
@@ -11,8 +11,48 @@
</sectioninfo>
<title>Creating and building component</title>
<para>
- Simple component (panel maybe) TBD
+ 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[...
+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/mylib-1.0-SNAPSHOT.jar</property>, everything is set up
successfully.
+ </para>
</section>
Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml 2008-07-09 15:55:52 UTC
(rev 9493)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/pcreate.xml 2008-07-09 16:54:10 UTC
(rev 9494)
@@ -11,9 +11,73 @@
</sectioninfo>
<title>Creating project for component</title>
<para>
- Web Resources
+ At first we need to create a project for the component itself. In the library
directory
+ <property>Sandbox</property> you just created launch the following
command (all in one line):
</para>
-
+ <programlisting role="XML"><![CDATA[...
+mvn archetype:create -DarchetypeGroupId=org.richfaces.cdk
-DarchetypeArtifactId=maven-archetype-jsf-component -DarchetypeVersion=3.2.1.GA
-DartifactId=inputDate
+...]]>
+ </programlisting>
+ <para>
+ As is easy to see a new directory with the name
<property>inputDate</property> will be created.
+ It does not have any components in it yet, but it has this predefined structure:
+ </para>
+ <figure>
+ <title>The project structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/tree.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Here are main directories with descriptions:
+ </para>
+ <table>
+ <title>The project structure</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Directory</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ src/main/config
+ </entry>
+ <entry>
+ Contains the metadata for the components
+ </entry>
+ </row>
+ <row>
+ <entry>
+ src/main/java
+ </entry>
+ <entry>
+ Contains Java code (both pre-generated and created by you)
+ </entry>
+ </row>
+ <row>
+ <entry>
+ src/main/resources
+ </entry>
+ <entry>
+ Used to store resource files, such as pictures, JavaScript and
CSS files
+ </entry>
+ </row>
+ <row>
+ <entry>
+ src/main/templates
+ </entry>
+ <entry>
+ Used to contain the JSP-like templates that define the component
layout
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</section>
Modified: trunk/docs/cdkguide/en/src/main/docbook/master.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/master.xml 2008-07-09 15:55:52 UTC (rev 9493)
+++ trunk/docs/cdkguide/en/src/main/docbook/master.xml 2008-07-09 16:54:10 UTC (rev 9494)
@@ -43,7 +43,6 @@
<!--
- &pcreate;
&ccreate;
&compdev;
-->
@@ -64,10 +63,16 @@
</chapterinfo>
<title>inputDate component development</title>
<para>
- Some info
+ We a going to create the <emphasis
role="bold"><property><inputDate></property></emphasis>
+ component that can take a value, process that value, and then push it
+ back to the underlying model as a strongly typed
<property>Date</property> object.
</para>
-
-
+ <para>
+ The <emphasis
role="bold"><property><inputDate></property></emphasis>
component allows to attach
+ a converter in order to set the desired date format such as
<property>mm/dd/yyyy</property>. So the component
+ could convert and validate the date entered by user.
+ </para>
+
&pcreate;
&ccreate;
&protoui;
Deleted: trunk/docs/cdkguide/en/src/main/docbook/modules/pcreate.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/modules/pcreate.xml 2008-07-09 15:55:52 UTC
(rev 9493)
+++ trunk/docs/cdkguide/en/src/main/docbook/modules/pcreate.xml 2008-07-09 16:54:10 UTC
(rev 9494)
@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="pcreate" xreflabel="pcreate">
- <?dbhtml filename="pcreate.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>project</keyword>
- <keyword>component</keyword>
- <keyword>CDK</keyword>
- <keyword>Guide</keyword>
- </keywordset>
- </chapterinfo>
- <title>Creating project for component</title>
- <para>
- Web Resources
- </para>
-
-</chapter>
-
-
Modified: trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml
===================================================================
--- trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-07-09 15:55:52 UTC (rev
9493)
+++ trunk/docs/cdkguide/en/src/main/docbook/modules/setup.xml 2008-07-09 16:54:10 UTC (rev
9494)
@@ -134,7 +134,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.mycompany</groupId>
- <artifactId>mylib-parent</artifactId>
+ <artifactId>sandbox</artifactId>
<url>http://mycompany.org</url>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
@@ -154,7 +154,7 @@
<dependency>
<groupId>org.richfaces.ui</groupId>
<artifactId>richfaces-ui</artifactId>
- <version>3.1.0</version>
+ <version>3.2.1</version>
</dependency>
</dependencies>
</project>
@@ -162,7 +162,44 @@
</programlisting>
</listitem>
</itemizedlist>
-
-
-
+ <para>
+ Here are some of these elements with descriptions:
+ </para>
+ <table>
+ <title>The POM elements</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Element</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <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>
+ </row>
+ <row>
+ <entry>
+ version
+ </entry>
+ <entry>
+ Version of your library
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</chapter>
\ No newline at end of file
Added: trunk/docs/cdkguide/en/src/main/resources/images/tree.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/cdkguide/en/src/main/resources/images/tree.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream