6:35 p.m.
Author: irooskov(a)redhat.com
Date: 2012-07-05 19:35:06 -0400 (Thu, 05 Jul 2012)
New Revision: 42425
Added:
trunk/forge/docs/reference/en-US/Using_Forge.xml
trunk/forge/docs/reference/en-US/images/using_forge/
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_01.png
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_02.png
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_03.png
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_04.png
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_05.png
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_06.png
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_07.png
Modified:
trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml
trunk/forge/docs/reference/en-US/master.xml
Log:
updated with new content
Modified: trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml 2012-07-05 23:32:51 UTC
(rev 42424)
+++ trunk/forge/docs/reference/en-US/Forge_Reference_Guide.xml 2012-07-05 23:35:06 UTC
(rev 42425)
@@ -5,6 +5,7 @@
<xi:include href="Book_Info.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<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="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/Using_Forge.xml
===================================================================
--- trunk/forge/docs/reference/en-US/Using_Forge.xml (rev 0)
+++ trunk/forge/docs/reference/en-US/Using_Forge.xml 2012-07-05 23:35:06 UTC (rev 42425)
@@ -0,0 +1,121 @@
+<?xml version='1.0' encoding='utf-8' ?>
+
+<chapter id="chap-Forge_Reference_Guide-Using_Forge">
+ <title>Using Forge</title>
+ <para>
+ To begin using Forge, launch the <guilabel>Forge Console</guilabel> view by
navigating to
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Forge</guimenuitem><guimenuitem>Forge
Console</guimenuitem></menuchoice>.
+ </para>
+ <figure id="using_forge_01">
+ <title>Forge Console selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_01.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Selecting the Forge Console from the Views menu.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The <guilabel>Forge Console</guilabel> will launch in an inactive state.
How and when Forge starts can be changed, see <xref
linkend="chap-Forge_Reference_Guide-Preferences"/>.
+ </para>
+ <figure id="using_forge_02">
+ <title>The Forge Console</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_02.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Forge in an inactive state.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ To start Forge, click the green arrow in the <guilabel>Forge
Console</guilabel>.
+ </para>
+ <figure id="using_forge_03">
+ <title>Starting Forge</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_03.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Starting Forge.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Once Forge starts you will notice the name <emphasis>Forge</emphasis>
appear in the <guilabel>Forge Console</guilabel> view and a command line
currently in your root workspace directory, without a project selected.
+ </para>
+ <figure id="using_forge_04">
+ <title>Started Forge</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_04.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Started Forge.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ From the <guilabel>Forge Console</guilabel> command line you can type the
command <code>cd</code> (change directory) followed by the directory to change
to, and if a navigator view is opened, the navigator view will also change to the
specified directory. If the resource is not in the local workspace and the
<guilabel>Remote Systems</guilabel> view is open, the directory will be
selected in the <guilabel>Remote Systems</guilabel> explorer.
+ </para>
+ <figure id="using_forge_05">
+ <title>Remote Systems view with the Forge Console</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_05.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Showing that the Remote Systems view is linked to what occurs in the Forge Console
view.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ Through the <guilabel>Forge Console</guilabel> you can also link the
console output to the currently open editor by clicking on the <guibutton>Link with
Editor</guibutton> button.
+ </para>
+ <figure id="using_forge_06">
+ <title>Link with Editor button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_06.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ The button to link the Forge Console output with the currently open Editor.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ If you close the <guilabel>Forge Console</guilabel> view, Forge will
continue to run in the background. Re-opeing the <guilabel>Forge
Console</guilabel> view will display the latest Forge state.
+ </para>
+ <para>
+ To stop Forge, click on the red square in the <guilabel>Forge
Console</guilabel>.
+ </para>
+ <figure id="using_forge_07">
+ <title>Stopping Forge</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/using_forge/using_forge_07.png"
format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>
+ Stopping the Forge runtime.
+ </phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+</chapter>
+
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_01.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_01.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_02.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_02.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_03.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_03.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_04.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_04.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_05.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_05.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_06.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_06.png
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: trunk/forge/docs/reference/en-US/images/using_forge/using_forge_07.png
===================================================================
(Binary files differ)
Property changes on:
trunk/forge/docs/reference/en-US/images/using_forge/using_forge_07.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-05 23:32:51 UTC (rev 42424)
+++ trunk/forge/docs/reference/en-US/master.xml 2012-07-05 23:35:06 UTC (rev 42425)
@@ -4,6 +4,8 @@
[
<!ENTITY Introduction SYSTEM "Introduction.xml">
+<!ENTITY UsingForge SYSTEM "Using_Forge.xml">
+<!ENTITY Preferences SYSTEM "Preferences.xml">
]>
<book>
@@ -38,5 +40,7 @@
<toc/>
&Introduction;
+ &UsingForge;
+ &Preferences;
</book>