[gnome-boxes: 28/28] Merge branch 'wip/user-help'
- From: Michael Hill <mdhill src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-boxes: 28/28] Merge branch 'wip/user-help'
- Date: Mon, 25 Mar 2013 22:06:00 +0000 (UTC)
commit 1a312d6ab468f47fb8e390d4b42b4a2346049c7b
Merge: a7f9ae6 f7fe6d6
Author: Michael Hill <mdhillca gmail com>
Date: Mon Mar 25 18:04:11 2013 -0400
Merge branch 'wip/user-help'
Conflicts:
help/C/clipboard.page.stub
help/C/collection.page.stub
help/C/command-line.page.stub
help/C/delete.page.stub
help/C/disk-images.page.stub
help/C/favorites.page.stub
help/C/hardware-virtualization.page.stub
help/C/how-many-machines.page.stub
help/C/import-images.page.stub
help/C/index.page
help/C/keyboard-shortcuts.page.stub
help/C/list-of-supported-protocols.page.stub
help/C/networking.page.stub
help/C/properties.page.stub
help/C/search.page
help/C/selection.page.stub
help/C/supported-protocols.page
help/C/system-requirements.page
help/C/unattended.page.stub
help/C/usb-redirection.page
help/C/virtual.page
help/C/what-is-a-virtual-machine.page
help/C/why-do-i-need-virtual-machine.page
help/Makefile.am
help/C/clipboard.page.stub | 2 +
help/C/collection.page.stub | 2 +
help/C/command-line.page.stub | 2 +
help/C/connect.page | 65 ++++++++++++++++++++++
help/C/connect.page.stub | 32 -----------
help/C/create.page | 65 ++++++++++++++++++++++
help/C/create.page.stub | 27 ---------
help/C/delete.page.stub | 2 +
help/C/disk-images.page.stub | 2 +
help/C/favorites.page.stub | 2 +
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/hardware-virtualization.page.stub | 2 +
help/C/how-many-machines.page.stub | 2 +
help/C/import-images.page.stub | 2 +
help/C/index.page | 4 +-
help/C/interface.page | 77 ++++++++++++++++++++++++++
help/C/interface.page.stub | 33 -----------
help/C/keyboard-shortcuts.page.stub | 2 +
help/C/legal.xml | 6 ++
help/C/list-of-supported-protocols.page.stub | 4 +
help/C/networking.page.stub | 2 +
help/C/properties.page.stub | 2 +
help/C/search.page | 4 +-
help/C/selection.page.stub | 2 +
help/C/supported-protocols.page | 6 ++-
help/C/system-requirements.page | 24 ++------
help/C/unattended.page.stub | 2 +
help/C/usb-redirection.page | 9 ++-
help/C/virtual.page | 32 -----------
help/C/what-is-a-virtual-machine.page | 6 ++-
help/C/why-do-i-need-virtual-machine.page | 6 ++-
help/Makefile.am | 12 +++-
36 files changed, 290 insertions(+), 150 deletions(-)
---
diff --cc help/C/connect.page
index 0000000,5c9ba6a..dabe185
mode 000000,100644..100644
--- a/help/C/connect.page
+++ b/help/C/connect.page
@@@ -1,0 -1,65 +1,65 @@@
+ <page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="connect">
+ <info>
- <revision pkgversion="3.8.0" version="0.1" date="2013-03-23" status="review"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-23" status="candidate"/>
+ <link type="guide" xref="index#start"/>
+
+ <credit type="author copyright">
+ <name>Michael Hill</name>
+ <email>mdhillca gmail com</email>
+ <years>2013</years>
+ </credit>
+
+ <desc>Access a box or service over the network.</desc>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ </info>
+
+ <title>Connect to another computer</title>
+
+ <p><app>Boxes</app> can be used to view and access a remote machine or a
+ remote virtual machine.</p>
+
+ <note style="important">
+ <p>The remote machine should already be configured.</p>
+ </note>
+
+ <steps>
+ <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 local or remote <app>Xspice</app>
+ server.</p></item>
+ <item><p>qemu:// to connect to a libvirt instance providing access to
+ all virtual machines it is hosting.</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 --cc help/C/create.page
index 0000000,fa1685c..101d98d
mode 000000,100644..100644
--- a/help/C/create.page
+++ b/help/C/create.page
@@@ -1,0 -1,65 +1,65 @@@
+ <page xmlns="http://projectmallard.org/1.0/";
+ type="topic" style="task"
+ id="create">
+ <info>
- <revision pkgversion="3.8.0" version="0.1" date="2013-03-17" status="review"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-17" status="candidate"/>
+ <link type="guide" xref="index#start"/>
+
+ <credit type="author copyright">
+ <name>Michael Hill</name>
+ <email>mdhillca gmail com</email>
+ <years>2013</years>
+ </credit>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <desc>Click <gui style="button">New</gui> to begin creating a box.</desc>
+ </info>
+
+ <title>Create a box</title>
+
+ <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>
+
+ <steps>
+ <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, 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 from the list of isos found by <app>Boxes</app>.</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, 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>
+
+ </page>
diff --cc help/C/index.page
index 52d2ce0,3f42343..39b44d4
--- a/help/C/index.page
+++ b/help/C/index.page
@@@ -2,7 -2,7 +2,7 @@@
type="guide"
id="index">
<info>
-- <revision version="0.1" date="2012-04-08" status="stub"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
<title role="trail" type="link"><media type="image" mime="image/png"
src="figures/boxes_icon.png">Help</media></title>
<credit type="author copyright">
<name>Baptiste Mille-Mathias</name>
diff --cc help/C/interface.page
index 0000000,c31c919..ada5ce7
mode 000000,100644..100644
--- a/help/C/interface.page
+++ b/help/C/interface.page
@@@ -1,0 -1,77 +1,77 @@@
+ <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"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-23" status="candidate"/>
+ <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>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <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 --cc help/C/search.page
index 6c3a784,93afaad..cfce11d
--- a/help/C/search.page
+++ b/help/C/search.page
@@@ -2,7 -2,7 +2,7 @@@
type="topic" style="task"
id="search">
<info>
-- <revision version="0.1" date="2013-02-18" status="stub"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
<link type="guide" xref="index#start"/>
<credit type="author copyright">
diff --cc help/C/supported-protocols.page
index c98b1e5,6a1869b..62bbd6c
--- a/help/C/supported-protocols.page
+++ b/help/C/supported-protocols.page
@@@ -2,7 -2,7 +2,7 @@@
type="topic" style="task"
id="supported-protocols">
<info>
-- <revision version="0.1" date="2012-04-06" status="stub"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
<link type="guide" xref="index#faq"/>
<credit type="author copyright">
@@@ -16,6 -16,9 +16,10 @@@
<years>2012</years>
</credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <desc></desc>
++
</info>
<title>What is the technology used by Boxes?</title>
diff --cc help/C/system-requirements.page
index 6a5c0d3,b49a8f5..67d1271
--- a/help/C/system-requirements.page
+++ b/help/C/system-requirements.page
@@@ -2,7 -2,7 +2,7 @@@
type="topic" style="task"
id="system-requirements">
<info>
-- <revision version="0.1" date="2012-04-09" status="stub"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
<link type="guide" xref="index#start" group="#first" />
<credit type="author copyright">
@@@ -20,28 -20,21 +20,18 @@@
<title>Set up your system</title>
- <p>To run <app>Boxes</app>, your computer should meet certain requirements:</p>
+ <p>To create and run virtual machines in <app>Boxes</app>, your computer
- should meet certain requirements:</p>
++ must meet certain requirements:</p>
<list>
+ <comment><p>have a page to check cpu extensions</p></comment>
+ <item><p>Have virtualization extensions available in the <sys>CPU</sys> and
+ active in the <sys>BIOS</sys>.</p></item>
+ <item><p>Have the <sys>kvm</sys> linux module loaded. This should be done
+ automatically.</p></item>
<item><p>Have disk space. You'll need at least 8 GB of disk per virtual
machine.</p></item>
<item><p>Have enought memory. You'll need around 1 GB of RAM per virtual
machine active.</p></item>
</list>
- <p>The following are highly recommended (but not required) for decent
- performance of virtual machines:</p>
- <list>
- <comment><p>have a page to check cpu extensions</p></comment>
- <item><p>Have virtualization extensions available in the <sys>CPU</sys> and
- active in the <sys>BIOS</sys>.</p></item>
- <item><p>Have the <sys>kvm</sys> linux module loaded. Normally, this is done
- automatically for you.</p></item>
- </list>
-
-- <note>
- <p><app>Boxes</app> should be able to create and (efficiently) run
- virtual machines in any computer sold since 2010.</p>
- </note>
-
- <p>Any computer sold since 2010 should be able to run <app>Boxes</app>.</p>
- </note>
-
</page>
diff --cc help/C/usb-redirection.page
index d689a12,127ae0f..c01c9c3
--- a/help/C/usb-redirection.page
+++ b/help/C/usb-redirection.page
@@@ -2,7 -2,7 +2,9 @@@
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"/>
++
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-24" status="candidate"/>
++
<link type="guide" xref="index#use"/>
<credit type="author copyright">
@@@ -16,7 -16,12 +18,10 @@@
<years>2013</years>
</credit>
- <desc></desc>
+ <desc>Allow your box to access a USB device.</desc>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
- <desc></desc>
-
</info>
<title>USB Redirection</title>
diff --cc help/C/what-is-a-virtual-machine.page
index 14b3e1a,500aace..f21c019
--- a/help/C/what-is-a-virtual-machine.page
+++ b/help/C/what-is-a-virtual-machine.page
@@@ -2,7 -2,7 +2,7 @@@
type="topic" style="topic"
id="what-is-a-virtual-machine">
<info>
-- <revision version="0.1" date="2012-04-08" status="stub"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
<link type="guide" xref="index#faq"/>
<link type="seealso" xref="why-do-I-need-virtual-machine"/>
@@@ -17,6 -17,9 +17,10 @@@
<years>2013</years>
</credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <desc></desc>
++
</info>
<title>What is a virtual machine?</title>
diff --cc help/C/why-do-i-need-virtual-machine.page
index d96436f,66830db..04cd26e
--- a/help/C/why-do-i-need-virtual-machine.page
+++ b/help/C/why-do-i-need-virtual-machine.page
@@@ -3,7 -3,7 +3,7 @@@
style="task"
id="why-do-I-need-virtual-machine">
<info>
-- <revision version="0.1" date="2012-04-08" status="stub"/>
++ <revision pkgversion="3.8.0" version="0.1" date="2013-03-25" status="candidate"/>
<link type="guide" xref="index#faq"/>
<link type="seealso" xref="what-is-a-virtual-machine"/>
@@@ -18,6 -18,9 +18,10 @@@
<years>2013</years>
</credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <desc></desc>
++
</info>
<title>Why do I need a virtual machine?</title>
diff --cc help/Makefile.am
index b2c566e,7ff1ded..e707bc2
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@@ -9,7 -18,7 +18,6 @@@ HELP_FILES = index.page
supported-protocols.page \
system-requirements.page \
usb-redirection.page \
-- virtual.page \
what-is-a-virtual-machine.page \
why-do-i-need-virtual-machine.page
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
