GNOME.org
 

[vinagre] Tidy up help and improve instructions

commit db6b202e250bee011123e6fbb6d1611abc5a9167
Author: Ekaterina Gerasimova <kittykat3756 googlemail com>
Date:   Fri Jun 10 20:41:50 2011 +0200

    Tidy up help and improve instructions
    
    Split connect.page into individual tasks pages. Improved style. Added
    introduction page. Grouped related pages together on index.page.

 help/C/bookmarks.page           |    3 +-
 help/C/connect-close.page       |   24 +++++++++
 help/C/connect-file.page        |   41 ++++++++++++++++
 help/C/connect.page             |   99 +++++++++++++++++----------------------
 help/C/fullscreen.page          |    3 +-
 help/C/index.page               |   16 ++----
 help/C/introduction.page        |   31 ++++++++++++
 help/C/preferences.page         |    4 +-
 help/C/reverse-connections.page |   84 +++++++++++++++++++--------------
 help/C/scaling.page             |   11 ++--
 help/C/take-screenshot.page     |    3 +-
 help/C/view-only.page           |    8 ++--
 help/Makefile.am                |    3 +
 13 files changed, 211 insertions(+), 119 deletions(-)
---
diff --git a/help/C/bookmarks.page b/help/C/bookmarks.page
index d94bad7..8883747 100755
--- a/help/C/bookmarks.page
+++ b/help/C/bookmarks.page
@@ -3,8 +3,7 @@
       id="bookmarks">
 
   <info>
-    <link type="guide" xref="index"/>
-    <title type="sort">3</title>
+    <link type="guide" xref="index#options"/>
     <desc>Using bookmarks in Vinagre.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
diff --git a/help/C/connect-close.page b/help/C/connect-close.page
new file mode 100644
index 0000000..0cbf13e
--- /dev/null
+++ b/help/C/connect-close.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="connect-close">
+
+  <info>
+    <link type="guide" xref="index#connections"/>
+    <link type="seealso" xref="connect"/>
+    <title type="sort">4</title>
+    <desc>Terminating a remote connection.</desc>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Closing a connection</title>
+
+  <p>To close a connection, choose <guiseq><gui>Remote</gui>
+  <gui>Close</gui></guiseq> or click the <gui>Close</gui> button.</p>
+
+</page>
diff --git a/help/C/connect-file.page b/help/C/connect-file.page
new file mode 100644
index 0000000..71a666c
--- /dev/null
+++ b/help/C/connect-file.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="connect-file">
+
+  <info>
+    <link type="guide" xref="index#connections"/>
+    <link type="seealso" xref="connect"/>
+    <title type="sort">2</title>
+    <desc>Opening and using a remote connection file.</desc>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Connecting with a .vnc file</title>
+
+  <p>Some hosts distribute remote connection files (generally ending with
+  suffix <file>.vnc</file>) instead of using a host address and port.</p>
+
+  <steps>
+    <item>
+      <p>Choose <guiseq><gui>Remote</gui> <gui>Open</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Select the file you want to open.</p>
+    </item>
+    <item>
+      <p>Click the <gui>Open</gui> button.</p>
+    </item>
+  </steps>
+
+  <note style="tip">
+    <p>You can also double-click on a remote connection file in
+    <app>Nautilus</app> to open it with <app>Vinagre</app>.</p>
+  </note>
+
+</page>
diff --git a/help/C/connect.page b/help/C/connect.page
index 5dfc0b7..3a21e6e 100755
--- a/help/C/connect.page
+++ b/help/C/connect.page
@@ -3,10 +3,10 @@
       id="connect">
 
   <info>
-    <link type="guide" xref="index"/>
+    <link type="guide" xref="index#connections"/>
     <link type="seealso" xref="bookmarks"/>
     <title type="sort">1</title>
-    <desc>Learn about connecting to another computer with Vinagre.</desc>
+    <desc>Establish a connection to another computer on your local network.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
       <email>kittykat3756 googlemail com</email>
@@ -16,66 +16,53 @@
     </license>
   </info>
 
-  <title>Connecting to other computers</title>
+  <title>Establishing a connection</title>
 
-  <section id="connect">
-    <title>Establishing a connection</title>
-    <p>To connect to a remote computer, choose <guiseq><gui>Remote</gui>
-    <gui>Connect</gui></guiseq>. The connection dialog is displayed. Choose the
-    <gui>Protocol</gui> and the <gui>Host</gui> for the connection and click the
-    <gui>Connect</gui> button. You will be presented with some other options,
-    depending on which protocol you have selected.</p>
-
-    <figure>
-      <title>Connect dialog</title>
-      <media type="image" mime="image/png" src="figures/vinagre-connect-dialog.png"/>
-    </figure>
-
-    <p>You can also use the <gui>Find</gui> button to browse available computers
-    on the local network.</p>
-
-    <note>
-      <p>The availabity of the <gui>Find</gui> button depends on the protocol
-      you have selected. <app>Vinagre</app> relies on <app>Avahi</app> to browse
-      for machines on your local network. Also, note that <app>Vinagre</app> can
-      be compiled without <app>Avahi</app> support. In this case, this button
-      will not be displayed.</p>
-    </note>
-
-    <p>Some machines may require a secure connection: an authentication dialog
-    will be displayed, asking for the credentials. The type of credentials
-    depend on the remote host, it may be a password and a username. If you
-    select <gui>Remember this credential</gui>, <app>Vinagre</app> will store
-    the information using <app>GNOME Keyring</app>.</p>
+  <p>This method can be used to connect to other computers on your network.</p>
 
+  <steps>
+    <item>
+      <p>Choose <guiseq><gui>Remote</gui><gui>Connect</gui></guiseq>.</p>
+      <figure>
+        <title>Connect dialog</title>
+        <media type="image" mime="image/png" src="figures/vinagre-connect-dialog.png"/>
+      </figure>
+    </item>
+    <item>
+      <p>Choose the <gui>Protocol</gui> and the <gui>Host</gui> for the
+      connection.</p>
+      <note>
+        <p>You can see all available hosts on your local network by clicking
+        the <gui>Find</gui> button. The availabity of the <gui>Find</gui> button
+        depends on the protocol you have selected. <app>Vinagre</app> relies on
+        <app>Avahi</app> to browse for machines on your local network. Also,
+        note that <app>Vinagre</app> can be compiled without <app>Avahi</app>
+        support. In this case, this button will not be displayed.</p>
+      </note>
+    </item>
+    <item>
+      <p>Select the options which you want enabled when the connection is
+      established. Options will vary depending on the protocol which is used.</p>
+    </item>
+    <item>
+      <p>Click the <gui>Connect</gui> button. At this point, the host will be
+      need to confirm that they want the connection established.</p>
+      <note>
+        <p>Some machines may require a secure connection: an authentication
+        dialog will be displayed, asking for the credentials. The type of
+        credentials depend on the remote host, it may be a password and a
+        username. If you select <gui>Remember this credential</gui>,
+        <app>Vinagre</app> will store the information using
+        <app>GNOME Keyring</app>.</p>
+      </note>
     <figure>
       <title>Authentication dialog</title>
       <media type="image" mime="image/png" src="figures/vinagre-auth-needed.png"/>
     </figure>
+    </item>
+  </steps>
 
-    <p>If the connection has been used previously, you can also access it
-    through <guiseq><gui>Remote</gui><gui>Recent Connections</gui></guiseq></p>
-  </section>
-
-  <section id="connect-opening-file">
-    <title>Opening a remote connection file</title>
-
-    <p>Some hosts distribute remote connection files (generally ending with
-    suffix <file>.vnc</file>) instead of using a host address and port. To open
-    a remote connection file, choose <guiseq><gui>Remote</gui>
-    <gui>Open</gui></guiseq>. The file choser dialog is displayed. Select the
-    file you want to open, then click the <gui>Open</gui> button.</p>
-
-    <note style="tip">
-      <p>You can also double-click on a remote connection file in
-      <app>Nautilus</app> to open it with <app>Vinagre</app>.</p>
-    </note>
-  </section>
-
-  <section id="close">
-    <title>Closing a connection</title>
-    <p>To close a connection, choose <guiseq><gui>Remote</gui>
-    <gui>Close</gui></guiseq>.</p>
-  </section>
+  <p>If the connection has been used previously, you can also access it
+  through <guiseq><gui>Remote</gui><gui>Recent Connections</gui></guiseq></p>
 
 </page>
diff --git a/help/C/fullscreen.page b/help/C/fullscreen.page
index bc15625..465f6f9 100644
--- a/help/C/fullscreen.page
+++ b/help/C/fullscreen.page
@@ -3,8 +3,7 @@
       id="fullscreen">
 
   <info>
-    <link type="guide" xref="index"/>
-    <title type="sort">8</title>
+    <link type="guide" xref="index#options"/>
     <desc>View the remote desktop in fullscreen mode.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
diff --git a/help/C/index.page b/help/C/index.page
index 7344a02..a7377f5 100755
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -4,16 +4,12 @@
 
   <title>Vinagre Help</title>
 
-  <p><app>Vinagre</app> is a remote desktop viewer application for the GNOME
-  desktop which uses Virtual Network Computing (VNC), and possibly other
-  protocols, to remotely control another computer.</p>
+  <section id="connections" style="2column">
+    <title>Connecting to other computers</title>
+  </section>
 
-  <p><app>Vinagre</app> provides the following features:</p>
-  <list>
-    <item><p>connect to several machines at the same time</p></item>
-    <item><p>store recent connections and allows them to be bookmarked</p>
-    </item>
-    <item><p>browse local network for machines</p></item>
-  </list>
+  <section id="options" style="2column">
+    <title>Using Vinagre's options and features</title>
+  </section>
 
 </page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..5b60f41
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="introduction">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>Introduction to the <app>Vinagre</app> remote desktop viewer.</desc>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Introduction</title>
+
+  <p><app>Vinagre</app> is a remote desktop viewer application for the GNOME
+  desktop which uses Virtual Network Computing (VNC), and possibly other
+  protocols, to remotely control another computer.</p>
+
+  <p><app>Vinagre</app> provides the following features:</p>
+  <list>
+    <item><p>connect to several machines at the same time</p></item>
+    <item><p>store recent connections and allows them to be bookmarked</p>
+    </item>
+    <item><p>browse local network for machines</p></item>
+  </list>
+
+</page>
diff --git a/help/C/preferences.page b/help/C/preferences.page
index f171a50..eff01c4 100755
--- a/help/C/preferences.page
+++ b/help/C/preferences.page
@@ -3,9 +3,7 @@
       id="preferences">
 
   <info>
-    <link type="guide" xref="index"/>
-    <link type="seealso" xref="using"/>
-    <title type="sort">4</title>
+    <link type="guide" xref="index#options"/>
     <desc>Configuration options in Vinagre, including tab visibility and
     keyboard shortcuts.</desc>
     <credit type="author">
diff --git a/help/C/reverse-connections.page b/help/C/reverse-connections.page
index a1a3e68..974c3b8 100644
--- a/help/C/reverse-connections.page
+++ b/help/C/reverse-connections.page
@@ -3,11 +3,11 @@
       id="reverse-connections">
 
   <info>
-    <link type="guide" xref="index"/>
-    <link type="seealso" xref="using"/>
+    <link type="guide" xref="index#connections"/>
     <link type="seealso" xref="connect"/>
-    <title type="sort">5</title>
-    <desc>Bypassing firewall restrictions on remote host.</desc>
+    <title type="sort">3</title>
+    <desc>Connecting to computers not on your local network: bypassing firewall
+    restrictions on remote host.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
       <email>kittykat3756 googlemail com</email>
@@ -17,43 +17,57 @@
     </license>
   </info>
 
-<title>Reverse Connectionsâ?¦</title>
+  <title>Reverse Connectionsâ?¦</title>
 
-<p>A reverse connection is usually used to bypass firewall restrictions on open
-ports. A firewall usually blocks open ports, but does not block outgoing
-traffic. In a normal forward connection, a client connects to a server through
-the server's open port, but in the case of a reverse connection, the client
-opens the port that the server connects to.</p>
+  <p>A reverse connection is usually used to bypass firewall restrictions on
+  open ports. A firewall usually blocks open ports, but does not block outgoing
+  traffic. In a normal forward connection, a client connects to a server through
+  the server's open port, but in the case of a reverse connection, the client
+  opens the port that the server connects to.</p>
+
+  <section id="enable-reverse-connections">
+    <title>Enabling reverse connections</title>
+
+    <steps>
+      <item>
+        <p>Open <guiseq><gui>Remote</gui><gui>Reverse Connections...</gui>
+        </guiseq>.</p>
+      </item>
+      <item>
+        <p>Select <gui>Enable Reverse Connections</gui>.</p>
+      </item>
+    </steps>
 
-<section id="enable-reverse-connections">
-  <title>Enabling reverse connections</title>
-<p>Open <guiseq><gui>Remote</gui><gui>Reverse Connections...</gui></guiseq> and
-select <gui>Enable Reverse Connections</gui>.</p>
 <!-- TODO: add screenshot
 <figure>
   <title>Reverse Connections dialog</title>
   <media type="image" mime="image/png" src="figures/reverse-connections-dialog.png"/>
 </figure>-->
-</section>
-
-<section id="accessing-behind-firewall">
-  <title>Accessing a remote desktop behind a firewall</title>
-<p>The remote machine needs to connect to your machine using your IP address and
-port number, which are in the <gui>Reverse Connections...</gui> dialog, under
-<gui>Connectivity</gui>.</p>
-<note>
-<p>Currently, <app>Vino</app>, the GNOME VNC server, does not support reverse
-connections (also known as "listen mode"). Some other applications, such as
-<app>UltraVNC</app>, <app>RealVNC</app> and <app>TightVNC</app>, do have support
-for reverse connections.</p>
-</note>
-<p>Once a remote machine connects to your machine, <app>Vinagre</app> will
-establish the reverse connection.</p>
-<note>
-<p>When connecting to a machine which is not on your local network, you will
-will need to provide your externally visible IP address and port number to the
-remote server.</p>
-</note>
-</section>
+
+  </section>
+
+  <section id="accessing-behind-firewall">
+    <title>Accessing a remote desktop behind a firewall</title>
+
+    <p>The remote machine needs to connect to your machine using your IP address
+    and port number, which are in the <gui>Reverse Connections...</gui> dialog,
+    under <gui>Connectivity</gui>.</p>
+
+    <note>
+      <p>Currently, <app>Vino</app>, the GNOME VNC server, does not support
+      reverse connections (also known as "listen mode"). Some other
+      applications, such as <app>UltraVNC</app>, <app>RealVNC</app> and
+      <app>TightVNC</app>, do have support for reverse connections.</p>
+    </note>
+
+    <p>Once a remote machine connects to your machine, <app>Vinagre</app> will
+    establish the reverse connection.</p>
+
+    <note>
+      <p>When connecting to a machine which is not on your local network, you
+      will need to provide your externally visible IP address and port number to
+      the remote server.</p>
+    </note>
+  </section>
 
 </page>
diff --git a/help/C/scaling.page b/help/C/scaling.page
index 7718c0e..88ae732 100644
--- a/help/C/scaling.page
+++ b/help/C/scaling.page
@@ -3,8 +3,7 @@
       id="scaling">
 
   <info>
-    <link type="guide" xref="index"/>
-    <title type="sort">10</title>
+    <link type="guide" xref="index#options"/>
     <desc>Scaling the remote desktop to fit the display area.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
@@ -27,11 +26,13 @@
     </item>
     <item>
       <p>Select <guiseq><gui>View</gui><gui>Keep Aspect Ratio</gui></guiseq> if
-      you want to contrain the aspect ratio of the remote desktop inside the
+      you want to constrain the aspect ratio of the remote desktop inside the
       display area, or deselect the option to stretch the remote desktop to fill
       the available space.</p>
-      <note>This option can be toggled only if <gui>Scaling</gui> has already
-      been enabled.</note>
+      <note>
+        <p>This option can be toggled only if <gui>Scaling</gui> has already
+        been enabled.</p>
+      </note>
     </item>
   </steps>
 
diff --git a/help/C/take-screenshot.page b/help/C/take-screenshot.page
index 3fdcad6..e5a4910 100644
--- a/help/C/take-screenshot.page
+++ b/help/C/take-screenshot.page
@@ -3,8 +3,7 @@
       id="take-screenshot">
 
   <info>
-    <link type="guide" xref="index"/>
-    <title type="sort">7</title>
+    <link type="guide" xref="index#options"/>
     <desc>Take a screenshot of a remote desktop.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
diff --git a/help/C/view-only.page b/help/C/view-only.page
index 8b55502..2b24285 100644
--- a/help/C/view-only.page
+++ b/help/C/view-only.page
@@ -3,8 +3,7 @@
       id="view-only">
 
   <info>
-    <link type="guide" xref="index"/>
-    <title type="sort">9</title>
+    <link type="guide" xref="index#options"/>
     <desc>Disable interaction with the remote desktop.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
@@ -17,8 +16,9 @@
 
   <title>View only mode</title>
 
-  <p>Some protocols allow you to enable a <gui>View Only</gui> mode. Choose
-  <guiseq><gui>View</gui><gui>View Only</gui></guiseq> or click the
+  <p>Some protocols allow you to enable a <gui>View Only</gui> mode. This mode
+  allows you to block all interaction with the remote.</p>
+  <p>Choose <guiseq><gui>View</gui><gui>View Only</gui></guiseq> or click the
   corresponding toolbar button to enable this mode.</p>
 
 </page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 1e7983f..2db684f 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -16,8 +16,11 @@ DOC_FIGURES = \
 DOC_PAGES = \
 	bookmarks.page \
 	connect.page \
+	connect-close.page \
+	connect-file.page \
 	fullscreen.page \
 	index.page \
+	introduction.page \
 	preferences.page \
 	reverse-connections.page \
 	scaling.page \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]