GNOME.org
 

[gnome-boxes/wip/user-help] Unstubbed pages and added content

commit bf759ac90e75f389fad692429c1484d74e23516b
Author: Michael Hill <mdhillca gmail com>
Date:   Sun Mar 24 08:30:24 2013 -0400

    Unstubbed pages and added content
    
    https://bugzilla.gnome.org/show_bug.cgi?id=670766

 help/C/connect.page           |   53 ++++++++++++++++++++++------
 help/C/create.page            |   77 +++++++++++++++--------------------------
 help/C/figures/collection.png |  Bin 0 -> 113109 bytes
 help/C/figures/list.png       |  Bin 0 -> 186833 bytes
 help/C/figures/properties.png |  Bin 0 -> 124852 bytes
 help/C/figures/selection.png  |  Bin 0 -> 115202 bytes
 help/C/figures/wizard.png     |  Bin 0 -> 171896 bytes
 help/C/interface.page         |   75 +++++++++++++++++++++++++++++++++++++++
 help/C/interface.page.stub    |   33 -----------------
 help/C/usb-redirection.page   |    4 +-
 help/Makefile.am              |    8 ++++-
 11 files changed, 154 insertions(+), 96 deletions(-)
---
diff --git a/help/C/connect.page b/help/C/connect.page
index f8f90d8..4010e23 100644
--- a/help/C/connect.page
+++ b/help/C/connect.page
@@ -2,7 +2,8 @@
       type="topic" style="task"
       id="connect">
   <info>
-    <revision version="0.1" date="2013-02-18" status="stub"/>
+    <revision pkgversion="3.8.0" version="0.1" date="2013-03-23" status="review"/>
+    <link type="guide" xref="index#start"/>
 
     <credit type="author copyright">
       <name>Michael Hill</name>
@@ -10,23 +11,53 @@
       <years>2013</years>
     </credit>
 
-    <desc></desc>
+    <desc>Access a box or service over the network.</desc>
   </info>
 
   <title>Connect to another computer</title>
 
-  <comment>
-    <cite date="2013-02-18" href="mailto:mdhillca gmail com">Michael Hill</cite>
-    <p>This assumes the reader knows how to.... By the end of this page,
-    the reader will be able to....</p>
-  </comment>
+  <p>When <app>Boxes</app> is launched, the collection view opens, displaying
+  your existing boxes. If you haven't yet created a box, the greeting reads
+  <gui>No boxes found.</gui></p>
 
-  <p>Short introductory text...</p>
+  <note style="important">
+    <p>The remote machine should already be configured.</p>
+  </note>
 
   <steps>
-    <item><p>First step...</p></item>
-    <item><p>Second step...</p></item>
-    <item><p>Third step...</p></item>
+    <item><p>Click <gui style="button">New</gui> in the top left corner to launch
+    the box creation wizard.</p></item>
+    <item><p>An introductory message is displayed. Click
+    <gui style="button">Continue</gui>.</p></item>
+    <item><p>At the wizard's <gui>Source Selection</gui> screen, click
+    <gui style="button">Enter URL</gui>.</p></item>
+
+    <item><p>Enter a URL containing the protocol, IP address and port number of
+    the remote device or service. For example:</p>
+      <code>spice://192.168.122.1?port=5906;</code>
+      <p>The protocol will be:</p>
+      <list>
+        <item><p>spice:// to connect to a remote <app>Xspice</app>
+        server.</p></item>
+        <item><p>qemu:// to connect to a box or qemu instance on a remote
+        machine.</p></item>
+        <item><p>vnc:// to connect to a remote <app>vino</app> or <app>VNC</app>
+        server.</p></item>
+      </list>
+      <note style="info">
+        <p>The address and port number should be available from the
+        configuration of the device or service on the remote machine. For
+        example, the <gui style="menu">Properties</gui> view in <app>Boxes</app>
+        provides the URL you would use to connect to that box.</p>
+      </note>
+    </item>
+    <item><p>Click <gui style="button">Continue</gui> in the top right
+    corner.</p></item>
+    <item><p>Click <gui style="button">Customize</gui> if you wish to rename the
+    box.</p></item>
+    <item><p>Click <gui style="button">Create</gui>.</p></item>
   </steps>
 
+  <p>The remote box will open in the collection view.</p>
+
 </page>
diff --git a/help/C/create.page b/help/C/create.page
index 01073fa..aebed02 100644
--- a/help/C/create.page
+++ b/help/C/create.page
@@ -25,60 +25,39 @@
     the box creation wizard.</p></item>
     <item><p>An introductory message is displayed. Click
     <gui style="button">Continue</gui>.</p></item>
-  </steps>
-  
-  <p>At the wizard's <gui>Source Selection</gui> screen, choose a source to
-  determine the type of box you want to create.</p>
-
-  <section id="remote">
-
-  <title>Remote boxes</title>
-
-  <p>All remote boxes are accessed using a URL. If the remote machine has
-  already been configured, click <gui style="button">Enter URL</gui> and provide
-  an address using one of the following protocols:</p>
-
-  <list>
-    <item><p>spice://</p></item>
-    <item><p>qemu://</p></item>
-    <item><p>vnc://</p></item>
-  </list>
-
-  <p>The remote box will open in the collection view.</p>
-    
-  </section>
-
-  <section id="virtual">
-
-  <title>Virtual boxes</title>
-    
-  <p>Create a local virtual machine using one of the following:</p>
-  
-  <list>
-    <item><p>select an iso from the list gathered by Tracker.</p></item>
-    <item><p>insert installation media in your CD/DVD drive or USB port.</p></item>
-    <item><p>provide a filename or location for an iso file.</p></item>
-    <item><p>provide a URL to connect locally as you would for a remote
-    connection.</p></item>
-  </list>
-
-  <note style="important">
-    <p>If your iso or installation media supports <gui>Express Installation</gui>,
-    the installation will proceed without further input.</p>
-  </note>
-
-  <p>After making your selection, or providing the necessary information:</p>
-
-  <steps>
-    <item><p>Click <gui style="button">Continue</gui>. The <gui>Review</gui>
+    <item><p>At the wizard's <gui>Source Selection</gui> screen, choose a source
+    to determine the type of box you want to create.</p>
+
+      <media type="image" src="figures/list.png"
+         width="500" height="413">
+        <p>Source selection</p>
+      </media>
+    </item>
+
+    <item><p>Create a local virtual machine using one of the following:</p>
+
+      <list>
+        <item><p>select an iso from the list gathered by Tracker.</p></item>
+        <item><p>insert installation media in your CD/DVD drive or USB port.</p></item>
+        <item><p>provide a filename or location for an iso file.</p></item>
+        <item><p>provide a URL to connect locally as you would for a
+        <link xref="connect">remote connection</link>.</p></item>
+      </list>
+
+      <note style="important">
+        <p>If your iso or installation media supports <gui>Express Installation</gui>,
+        the installation will proceed without further input.</p>
+      </note>
+    </item>
+
+    <item><p>After making your selection, or providing the necessary
+    information, click <gui style="button">Continue</gui>. The <gui>Review</gui>
     page opens.</p></item>
     <item><p>Click <gui style="button">Customize</gui> to adjust memory or
-    disk size.</p></item>
+    disk size, or to rename the box.</p></item>
     <item><p>Click <gui style="button">Create</gui>.</p></item>
   </steps>
 
   <p>The collection view returns, and the installation of the box begins.</p>
 
-  </section>
-
 </page>
diff --git a/help/C/figures/collection.png b/help/C/figures/collection.png
new file mode 100644
index 0000000..ceb3af0
Binary files /dev/null and b/help/C/figures/collection.png differ
diff --git a/help/C/figures/list.png b/help/C/figures/list.png
new file mode 100644
index 0000000..ba6b70c
Binary files /dev/null and b/help/C/figures/list.png differ
diff --git a/help/C/figures/properties.png b/help/C/figures/properties.png
new file mode 100644
index 0000000..0094675
Binary files /dev/null and b/help/C/figures/properties.png differ
diff --git a/help/C/figures/selection.png b/help/C/figures/selection.png
new file mode 100644
index 0000000..577312f
Binary files /dev/null and b/help/C/figures/selection.png differ
diff --git a/help/C/figures/wizard.png b/help/C/figures/wizard.png
new file mode 100644
index 0000000..f9e4624
Binary files /dev/null and b/help/C/figures/wizard.png differ
diff --git a/help/C/interface.page b/help/C/interface.page
new file mode 100644
index 0000000..ce0f5ab
--- /dev/null
+++ b/help/C/interface.page
@@ -0,0 +1,75 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="interface">
+  <info>
+    <revision pkgversion="3.8.0" version="0.1" date="2013-03-23" status="review"/>
+    <link type="guide" xref="index#use" group="#first" />
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhillca gmail com</email>
+      <years>2013</years>
+    </credit>
+
+    <desc>Get around the application.</desc>
+  </info>
+
+  <title>The Boxes interface</title>
+
+  <section id="collection">
+  <title>Collection view</title>
+
+  <p>When you first launch <app>Boxes</app>, the greeting tells you to click the
+  <gui style="button">New</gui> button. On subsequent visits, <app>Boxes</app>
+  opens in the <em>collection view</em>, displaying thumbnails of your boxes.
+  Favourites or frequently-used boxes appear at the top of the list.</p>
+
+  <media type="image" src="figures/collection.png"
+       width="500" height="316">
+    <p>Collection view</p>
+  </media>
+
+  </section>
+
+  <section id="wizard">
+  <title>The wizard</title>
+
+  <p>Clicking <gui style="button">New</gui> launches the <em>wizard</em>, which guides
+  you through the process of box creation.</p>
+
+  <media type="image" src="figures/wizard.png"
+       width="500" height="312">
+    <p>The wizard</p>
+  </media>
+
+  </section>
+
+  <section id="selection">
+  <title>Selection mode</title>
+
+  <p>In collection view, clicking the checkmark button or right-clicking a
+  thumbnail puts you in <em>selection mode</em>, where various operations can be
+  performed on boxes, individually or in groups.</p>
+
+  <media type="image" src="figures/selection.png"
+       width="500" height="316">
+    <p>Selection mode</p>
+  </media>
+
+  </section>
+
+  <section id="properties">
+  <title>Properties view</title>
+
+  <p>Clicking the <gui style="button">Properties</gui> button in selection mode
+  opens the <em>properties view</em>, where details of a box can be
+  configured.</p>
+
+  <media type="image" src="figures/properties.png"
+       width="500" height="316">
+    <p>Properties view</p>
+  </media>
+
+  </section>
+
+</page>
diff --git a/help/C/usb-redirection.page b/help/C/usb-redirection.page
index d689a12..20e44f6 100644
--- a/help/C/usb-redirection.page
+++ b/help/C/usb-redirection.page
@@ -2,7 +2,7 @@
       type="topic" style="task"
       id="usb-redirection">
   <info>
-    <revision version="0.1" date="2012-04-09" status="stub"/>
+    <revision pkgversion="3.8.0" version="0.1" date="2013-03-24" status="review"/>
     <link type="guide" xref="index#use"/>
 
     <credit type="author copyright">
@@ -16,7 +16,7 @@
       <years>2013</years>
     </credit>
 
-    <desc></desc>
+    <desc>Allow your box to access a USB device.</desc>
   </info>
 
   <title>USB Redirection</title>
diff --git a/help/Makefile.am b/help/Makefile.am
index c1c53b4..3f3c762 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -2,11 +2,17 @@
 
 HELP_ID = gnome-boxes
 
-HELP_MEDIA = figures/boxes_icon.png
+HELP_MEDIA = figures/boxes_icon.png    \
+       collection.png                  \
+       list.png                        \
+       properties.png                  \
+       selection.png                   \
+       wizard.png
 
 HELP_FILES = index.page                        \
        connect.page                    \
        create.page                     \
+       interface.page                  \
        search.page                     \
        supported-protocols.page        \
        system-requirements.page        \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]