[jbosstools-commits] JBoss Tools SVN: r42428 - in trunk/forge/docs/reference/en-US: images and 1 other directories.
jbosstools-commits at lists.jboss.org
jbosstools-commits at lists.jboss.org
Thu Jul 5 21:11:06 EDT 2012
Author: irooskov at redhat.com
Date: 2012-07-05 21:11:05 -0400 (Thu, 05 Jul 2012)
New Revision: 42428
Added:
trunk/forge/docs/reference/en-US/Project_Commands.xml
trunk/forge/docs/reference/en-US/images/project_commands/
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_01.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_02.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_03.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_04.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_05.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_06.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_07.png
trunk/forge/docs/reference/en-US/images/project_commands/project_commands_08.png
Modified:
trunk/forge/docs/reference/en-US/Book_Info.xml
trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml
trunk/forge/docs/reference/en-US/master.xml
Log:
updated to include new chapter on commands for projects
Modified: trunk/forge/docs/reference/en-US/Book_Info.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Book_Info.xml 2012-07-06 00:22:57 UTC (rev 42427)
+++ trunk/forge/docs/reference/en-US/Book_Info.xml 2012-07-06 01:11:05 UTC (rev 42428)
@@ -13,7 +13,7 @@
<edition>5.0.1</edition>
- <pubsnumber>1</pubsnumber>
+ <pubsnumber>2</pubsnumber>
<abstract>
<para>
Modified: trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml 2012-07-06 00:22:57 UTC (rev 42427)
+++ trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml 2012-07-06 01:11:05 UTC (rev 42428)
@@ -6,6 +6,7 @@
<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Using_Forge.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Project_Commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Preferences.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
Added: trunk/forge/docs/reference/en-US/Project_Commands.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Project_Commands.xml (rev 0)
+++ trunk/forge/docs/reference/en-US/Project_Commands.xml 2012-07-06 01:11:05 UTC (rev 42428)
@@ -0,0 +1,173 @@
+<?xml version='1.0' encoding='utf-8' ?>
+
+ <chapter id="chap-Forge_Reference_Guide-Project_commands">
+ <title>Project commands</title>
+ <para>
+ Outlined in this chapter are the commands you will use most often when interacting with the Forge runtime.
+ </para>
+ <section>
+ <title>Creating a new project</title>
+ <para>
+ The command <code>new-project</code> allows you to create a new project and have it automatically imported into your workspace.
+ </para>
+ <para>
+ The format of the command is:
+ </para>
+<programlisting>
+new-project --named example --topLevelPackage com.example
+</programlisting>
+ <figure id="project_commands_01">
+ <title>new-project command execution</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_01.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Execution of the new-project command.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Once the command has been executed, the new project will appear in your <guilabel>Project Explorer</guilabel>.
+ </para>
+ <figure id="project_commands_02">
+ <title>New project in Project Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_02.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Your new project has automatically appeared in the Project Explorer.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Adding persistence</title>
+ <para>
+ Persistence can be added to a project through the use of the command <code>persistence setup</code>.
+ </para>
+ <para>
+ The format of the command is:
+ </para>
+<programlisting>
+persistence setup --provider HIBERNATE --container JBOSS_AS6
+</programlisting>
+ <figure id="project_commands_03">
+ <title>persistence setup command execution</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_03.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Execution of the persistence setup command.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Once the command has been executed a new file will have been created called <filename>persistence.xml</filename>. The file will appear under your project in the <guilabel>Project Explorer</guilabel>, and will automatically open in an editor.
+ </para>
+ <figure id="project_commands_04">
+ <title>persistence.xml file open in an editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_04.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Your new persistence file has automatically been opened for editing.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Creating a new entity</title>
+ <para>
+ A new entity can be created for a project by using the command <code>entity</code>.
+ </para>
+ <para>
+ The format of the command is:
+ </para>
+<programlisting>
+entity --named Customer
+</programlisting>
+ <figure id="project_commands_05">
+ <title>entity command execution</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_05.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Execution of the entity command.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Once the command has been executed a new entity will have been created. The entity will appear under your project's domain in the <guilabel>Project Explorer</guilabel>, and the Java file will automatically open in an editor.
+ </para>
+ <figure id="project_commands_06">
+ <title>Entity Java file open in an editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_06.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Your new entity has automatically been opened for editing.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Creating a new field</title>
+ <para>
+ A new field can be created for an entity by using the command <code>field string</code>.
+ </para>
+ <para>
+ The format of the command is:
+ </para>
+<programlisting>
+field string --named firstName
+</programlisting>
+ <figure id="project_commands_07">
+ <title>field string command execution</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_07.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Execution of the field string command.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Once the command has been executed a new field will have been created in the selected entity. The field will appear in the Java editor and in the <guilabel>Outline</guilabel> view.
+ </para>
+ <figure id="project_commands_08">
+ <title>Field entry displayed in the entity file, within the Java editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/project_commands/project_commands_08.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Your new field has been added to your entity file.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_01.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_02.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_02.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_03.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_03.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_04.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_04.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_05.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_05.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_06.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_06.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_07.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_07.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_08.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/project_commands/project_commands_08.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: trunk/forge/docs/reference/en-US/master.xml
===================================================================
--- trunk/forge/docs/reference/en-US/master.xml 2012-07-06 00:22:57 UTC (rev 42427)
+++ trunk/forge/docs/reference/en-US/master.xml 2012-07-06 01:11:05 UTC (rev 42428)
@@ -5,6 +5,7 @@
[
<!ENTITY Introduction SYSTEM "Introduction.xml">
<!ENTITY UsingForge SYSTEM "Using_Forge.xml">
+<!ENTITY ProjectCommands SYSTEM "Project_Commands.xml">
<!ENTITY Preferences SYSTEM "Preferences.xml">
]>
@@ -41,6 +42,7 @@
<toc/>
&Introduction;
&UsingForge;
+ &ProjectCommands;
&Preferences;
</book>
More information about the jbosstools-commits
mailing list