[jbosstools-commits] JBoss Tools SVN: r42429 - 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:59:48 EDT 2012
Author: irooskov at redhat.com
Date: 2012-07-05 21:59:48 -0400 (Thu, 05 Jul 2012)
New Revision: 42429
Added:
trunk/forge/docs/reference/en-US/General_Commands.xml
trunk/forge/docs/reference/en-US/images/general_commands/
trunk/forge/docs/reference/en-US/images/general_commands/general_commands_01.png
trunk/forge/docs/reference/en-US/images/general_commands/general_commands_02.png
trunk/forge/docs/reference/en-US/images/general_commands/general_commands_03.png
trunk/forge/docs/reference/en-US/images/general_commands/general_commands_04.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/Project_Commands.xml
trunk/forge/docs/reference/en-US/master.xml
Log:
updated with new chapter on general forge commands
Modified: trunk/forge/docs/reference/en-US/Book_Info.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Book_Info.xml 2012-07-06 01:11:05 UTC (rev 42428)
+++ trunk/forge/docs/reference/en-US/Book_Info.xml 2012-07-06 01:59:48 UTC (rev 42429)
@@ -13,7 +13,7 @@
<edition>5.0.1</edition>
- <pubsnumber>2</pubsnumber>
+ <pubsnumber>3</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 01:11:05 UTC (rev 42428)
+++ trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml 2012-07-06 01:59:48 UTC (rev 42429)
@@ -7,6 +7,7 @@
<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="General_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/General_Commands.xml
===================================================================
--- trunk/forge/docs/reference/en-US/General_Commands.xml (rev 0)
+++ trunk/forge/docs/reference/en-US/General_Commands.xml 2012-07-06 01:59:48 UTC (rev 42429)
@@ -0,0 +1,100 @@
+<?xml version='1.0' encoding='utf-8' ?>
+
+ <chapter id="chap-Forge_Reference_Guide-General_commands">
+ <title>General commands</title>
+ <para>
+ Outlined in this chapter are general commands for interacting with the Forge runtime, your projects and the workspace.
+ </para>
+ <section>
+ <title>Opening a file or folder</title>
+ <para>
+ The command <code>open</code> allows you to open a file or folder.
+ </para>
+ <para>
+ The format of the command is:
+ </para>
+<programlisting>
+open foo/pom.xml
+</programlisting>
+ <figure id="general_commands_01">
+ <title>open command execution</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/general_commands/general_commands_01.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Execution of the open command.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Using the command to open a file will open it in an editor. Executing the command on a folder in your workspace will expanded the folder in the Project Explorer view. If the resource is a folder outside the workspace it will be selected and expanded in the Remote Systems view.
+ </para>
+ <figure id="general_commands_02">
+ <title>File opened</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/general_commands/general_commands_02.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Having executed the command on a file, it is opened in its respective editor.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>The pick-up command</title>
+ <para>
+ The command <code>pick-up</code> allows you to view the contents of a directory or navigate to a file and automatically open it.
+ </para>
+ <para>
+ The format of the command for a directory is:
+ </para>
+<programlisting>
+pick-up foo/
+</programlisting>
+ <para>
+ Executing the command on a directory will write the contents of the directory to the screen.
+ </para>
+ <figure id="general_commands_03">
+ <title>open command execution</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/general_commands/general_commands_03.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Execution of the open command.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The format of the command for a file is:
+ </para>
+<programlisting>
+pick-up foo/pom.xml
+</programlisting>
+ <para>
+ Using the command to open a file will open it in an editor.
+ </para>
+ <figure id="general_commands_04">
+ <title>File opened</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/general_commands/general_commands_04.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Having executed the command on a file, it is opened in its respective editor.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
Modified: trunk/forge/docs/reference/en-US/Project_Commands.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Project_Commands.xml 2012-07-06 01:11:05 UTC (rev 42428)
+++ trunk/forge/docs/reference/en-US/Project_Commands.xml 2012-07-06 01:59:48 UTC (rev 42429)
@@ -3,7 +3,7 @@
<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.
+ Outlined in this chapter are the commands you will use most often when developing projects with the Forge runtime.
</para>
<section>
<title>Creating a new project</title>
Added: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_01.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_02.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_02.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_03.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_03.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_04.png
===================================================================
(Binary files differ)
Property changes on: trunk/forge/docs/reference/en-US/images/general_commands/general_commands_04.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 01:11:05 UTC (rev 42428)
+++ trunk/forge/docs/reference/en-US/master.xml 2012-07-06 01:59:48 UTC (rev 42429)
@@ -6,6 +6,7 @@
<!ENTITY Introduction SYSTEM "Introduction.xml">
<!ENTITY UsingForge SYSTEM "Using_Forge.xml">
<!ENTITY ProjectCommands SYSTEM "Project_Commands.xml">
+<!ENTITY GeneralCommands SYSTEM "General_Commands.xml">
<!ENTITY Preferences SYSTEM "Preferences.xml">
]>
@@ -43,6 +44,7 @@
&Introduction;
&UsingForge;
&ProjectCommands;
+ &GeneralCommands;
&Preferences;
</book>
More information about the jbosstools-commits
mailing list