GNOME.org
 

[vinagre] Improve structure of help pages

commit f32f8436c6fa21f456675dfb1cf554fb2e70de87
Author: Ekaterina Gerasimova <kittykat3756 googlemail com>
Date:   Mon Jun 6 21:35:51 2011 +0200

    Improve structure of help pages
    
    Split using.page into topic-oriented pages. Minor updates to style and
    indentation. Other small fixes.

 help/C/bookmarks.page       |  110 ++++++++++++++++++++++--------------------
 help/C/connect.page         |  108 ++++++++++++++++++++++-------------------
 help/C/fullscreen.page      |   29 +++++++++++
 help/C/index.page           |   21 +++++----
 help/C/preferences.page     |   53 ++++++++++++---------
 help/C/scaling.page         |   38 +++++++++++++++
 help/C/take-screenshot.page |   39 +++++++++++++++
 help/C/using.page           |   69 ---------------------------
 help/C/view-only.page       |   24 +++++++++
 help/Makefile.am            |    5 ++-
 10 files changed, 293 insertions(+), 203 deletions(-)
---
diff --git a/help/C/bookmarks.page b/help/C/bookmarks.page
index ec5be00..d94bad7 100755
--- a/help/C/bookmarks.page
+++ b/help/C/bookmarks.page
@@ -1,5 +1,4 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      xmlns:e="http://projectmallard.org/experimental/";
       type="guide"
       id="bookmarks">
 
@@ -16,60 +15,67 @@
     </license>
   </info>
 
-<title>Bookmarks</title>
+  <title>Bookmarks</title>
 
-<section id="bookmarks-using">
-  <title>Using bookmarks</title>
-<p>Bookmarks are shortcuts to machines which you access frequently. They are
-visible in the side pane or in the <gui>Bookmarks</gui> menu.</p>
-<figure>
-  <title>Bookmarks in the side pane</title>
-  <media type="image" mime="image/png" src="figures/vinagre-bookmarks-side-pane.png"/>
-</figure>
-<p>As you hover the mouse over a bookmark, a tooltip will show you the hostname
-for the connection. To connect to a machine, double click on an entry.</p>
-</section>
+  <p>Bookmarks are shortcuts to machines which you access frequently. They are
+  visible in the side pane or in the <gui>Bookmarks</gui> menu.</p>
 
-<section id="bookmarks-add">
-  <title>Create a new bookmark</title>
-<p>To bookmark the currently viewed connection, choose
-<guiseq><gui>Bookmarks</gui><gui>Add Bookmark</gui></guiseq>. The
-<gui>Bookmark</gui> dialog is displayed. Enter the name for the connection, and
-choose any other options you may want to use, then click <gui>Save</gui>.</p>
-<figure>
-  <title>The <gui>Bookmark</gui> dialog</title>
-  <media type="image" mime="image/png" src="figures/vinagre-saving-bookmarks.png"/>
-</figure>
-<note>
-<p>You can use folders to organize your bookmarks. To create a folder, right
-click on the side pane and choose the option <gui>New Folder</gui> in the
-context menu.</p>
-</note>
-</section>
+  <figure>
+    <title>Bookmarks in the side pane</title>
+    <media type="image" mime="image/png" src="figures/vinagre-bookmarks-side-pane.png"/>
+  </figure>
 
-<section id="bookmarks-edit">
-  <title>Edit bookmark properties</title>
-<p>To edit a bookmark's properties, such as its name and host, right click on
-the bookmark in the side pane and choose <gui>Edit Bookmark</gui> from the
-context menu.</p>
-<figure>
-  <title>Context menu options</title>
-  <media type="image" mime="image/png" src="figures/vinagre-editing-bookmarks.png"/>
-</figure>
-<note>
-<p>You can also edit a folder in the same way.</p>
-</note>
-</section>
+  <p>As you hover the mouse over a bookmark, a tooltip will show you the
+  hostname for the connection. To connect to a machine, double click on an
+  entry.</p>
 
-<section id="bookmarks-remove">
-  <title>Remove a bookmark</title>
-<p>Right click on the bookmark in the side pane, and choose
-<gui>Remove From Bookmarks</gui> in the context menu to remove a bookmark.</p>
-<note>
-<p>You can also remove a folder in the same way. Note that removing a folder
-will remove all the folders and bookmarks inside it. A confirmation dialog will
-be shown.</p>
-</note>
-</section>
+  <section id="bookmarks-add">
+    <title>Create a new bookmark</title>
+
+    <p>To bookmark the currently viewed connection, choose
+    <guiseq><gui>Bookmarks</gui><gui>Add Bookmark</gui></guiseq>. The
+    <gui>Bookmark</gui> dialog is displayed. Enter the name for the connection,
+    and choose any other options you may want to use, then click
+    <gui>Save</gui>.</p>
+
+    <figure>
+      <title>The <gui>Bookmark</gui> dialog</title>
+      <media type="image" mime="image/png" src="figures/vinagre-saving-bookmarks.png"/>
+    </figure>
+
+    <note>
+      <p>You can use folders to organize your bookmarks. To create a folder,
+      right click on the side pane and choose the option <gui>New Folder</gui>
+      in the context menu.</p>
+    </note>
+  </section>
+
+  <section id="bookmarks-edit">
+    <title>Edit bookmark properties</title>
+    <p>To edit a bookmark's properties, such as its name and host, right click
+    on the bookmark in the side pane and choose <gui>Edit Bookmark</gui> from
+    the context menu.</p>
+
+    <figure>
+      <title>Context menu options</title>
+      <media type="image" mime="image/png" src="figures/vinagre-editing-bookmarks.png"/>
+    </figure>
+
+    <note>
+      <p>You can also edit a folder in the same way.</p>
+    </note>
+  </section>
+
+  <section id="bookmarks-remove">
+    <title>Remove a bookmark</title>
+    <p>Right click on the bookmark in the side pane, and choose
+    <gui>Remove From Bookmarks</gui> in the context menu to remove a bookmark.</p>
+
+    <note>
+      <p>You can also remove a folder in the same way. Note that removing a
+      folder will remove all the folders and bookmarks inside it. A confirmation
+      dialog will be shown.</p>
+    </note>
+  </section>
 
 </page>
diff --git a/help/C/connect.page b/help/C/connect.page
index d6def72..5dfc0b7 100755
--- a/help/C/connect.page
+++ b/help/C/connect.page
@@ -5,7 +5,6 @@
   <info>
     <link type="guide" xref="index"/>
     <link type="seealso" xref="bookmarks"/>
-    <link type="seealso" xref="using"/>
     <title type="sort">1</title>
     <desc>Learn about connecting to another computer with Vinagre.</desc>
     <credit type="author">
@@ -17,57 +16,66 @@
     </license>
   </info>
 
-<title>Connecting to other computers</title>
+  <title>Connecting to other computers</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>
-<figure>
-  <title>Authentication dialog</title>
-  <media type="image" mime="image/png" src="figures/vinagre-auth-needed.png"/>
-</figure>
-<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">
+    <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>
 
-<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>
+    <figure>
+      <title>Connect dialog</title>
+      <media type="image" mime="image/png" src="figures/vinagre-connect-dialog.png"/>
+    </figure>
 
-<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>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>
+
+    <figure>
+      <title>Authentication dialog</title>
+      <media type="image" mime="image/png" src="figures/vinagre-auth-needed.png"/>
+    </figure>
+
+    <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>
 
 </page>
diff --git a/help/C/fullscreen.page b/help/C/fullscreen.page
new file mode 100644
index 0000000..bc15625
--- /dev/null
+++ b/help/C/fullscreen.page
@@ -0,0 +1,29 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="fullscreen">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <title type="sort">8</title>
+    <desc>View the remote desktop in fullscreen mode.</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>Fullscreen mode</title>
+
+  <p>Choose <guiseq><gui>View</gui><gui>Fullscreen</gui></guiseq>, or press the
+  corresponding toolbar button, to view the display area in fullscreen mode.</p>
+
+  <note>
+    <p>While in fullscreen mode, move the mouse to the top-center of the screen
+    to display a hidden toolbar, which has a <gui>Leave Fullscreen</gui> button,
+    <gui>Disconnect</gui> and other options.</p>
+  </note>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 3762613..7344a02 100755
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -1,16 +1,19 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      xmlns:e="http://projectmallard.org/experimental/";
       type="guide"
       id="index">
 
-<title>Vinagre Help</title>
+  <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>
-<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>
+  <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 e06ef00..f171a50 100755
--- a/help/C/preferences.page
+++ b/help/C/preferences.page
@@ -1,5 +1,4 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      xmlns:e="http://projectmallard.org/experimental/";
       type="guide"
       id="preferences">
 
@@ -7,7 +6,8 @@
     <link type="guide" xref="index"/>
     <link type="seealso" xref="using"/>
     <title type="sort">4</title>
-    <desc>Configuration options in Vinagre.</desc>
+    <desc>Configuration options in Vinagre, including tab visibility and
+    keyboard shortcuts.</desc>
     <credit type="author">
       <name>Ekaterina Gerasimova</name>
       <email>kittykat3756 googlemail com</email>
@@ -17,25 +17,34 @@
     </license>
   </info>
 
-<title>Preferences</title>
-<p>To configure <app>Vinagre</app>, choose <guiseq><gui>Edit</gui>
-<gui>Preferences</gui></guiseq>. The <gui>Preferences</gui> dialog contains the
-following items:</p>
-<terms>
-  <item>
-    <title><gui>Always show tabs</gui></title>
-    <p>Select this option to make the display area tabs always visible, even
-when only one connection is active.</p>
-  </item>
-  <item>
-    <title><gui>Allow keyboard shortcuts</gui></title>
-    <p>Select this option to enable keyboard shortcuts, like
-<keyseq><key>Ctrl</key><key>D</key></keyseq>, menu accelerators and mnemonics,
-like <keyseq><key>Alt</key><key>M</key></keyseq>. This means that
-<app>Vinagre</app> will catch those key combinations, instead of sending them to
-the remote machine. This option is disabled by default because most
-of the time, you will be working on a remote machine.</p>
-  </item>
-</terms>
+  <title>Preferences</title>
+  <p>To configure <app>Vinagre</app>, choose <guiseq><gui>Edit</gui>
+  <gui>Preferences</gui></guiseq>. The <gui>Preferences</gui> dialog contains
+  the following items:</p>
+
+  <terms>
+    <item>
+      <title><gui>Always show tabs</gui></title>
+      <p>Select this option to make the display area tabs always visible, even
+      when only one connection is active.</p>
+    </item>
+    <item>
+      <title><gui>Allow keyboard shortcuts</gui></title>
+      <p>Select this option to enable keyboard shortcuts, like
+      <keyseq><key>Ctrl</key><key>D</key></keyseq>, menu accelerators and
+      mnemonics, like <keyseq><key>Alt</key><key>M</key></keyseq>. This means
+      that <app>Vinagre</app> will catch those key combinations, instead of
+      sending them to the remote machine. This option is disabled by default
+      because most of the time, you will be working on a remote machine.</p>
+      <note>
+        <p>When the <gui>Allow keyboard shortcuts</gui> option is disabled in
+        the preferences, <keyseq><key>Ctrl</key><key>Alt</key>
+        <key>Delete</key></keyseq> is the only key combination which will not be
+        sent to the remote desktop. Choose <guiseq><gui>Remote</gui>
+        <gui>Send Ctrl-Alt-Delete</gui></guiseq>, or use the corresponding
+        toolbar button, to send this key combination.</p>
+      </note>
+    </item>
+  </terms>
 
 </page>
diff --git a/help/C/scaling.page b/help/C/scaling.page
new file mode 100644
index 0000000..7718c0e
--- /dev/null
+++ b/help/C/scaling.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="scaling">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <title type="sort">10</title>
+    <desc>Scaling the remote desktop to fit the display area.</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>Scaling the remote desktop</title>
+
+  <p>Some protocols have an option to scale the remote desktop to fit your
+  display area.</p>
+
+  <steps>
+    <item>
+      <p>Choose <guiseq><gui>View</gui><gui>Scaling</gui></guiseq>, or click the
+      <gui>Scaling</gui> toolbar button.</p>
+    </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
+      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>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/C/take-screenshot.page b/help/C/take-screenshot.page
new file mode 100644
index 0000000..3fdcad6
--- /dev/null
+++ b/help/C/take-screenshot.page
@@ -0,0 +1,39 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="take-screenshot">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <title type="sort">7</title>
+    <desc>Take a screenshot of a remote desktop.</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>Take a screenshot</title>
+
+  <steps>
+    <item>
+      <p>Choose <guiseq><gui>Remote</gui><gui>Take screenshot</gui></guiseq>, or
+      click the <gui>Take Screenshot</gui> button in the toolbar.</p>
+    </item>
+    <item>
+      <p>In the <gui>Name</gui> field, enter the name you want the screenshot to
+      be saved under.</p>
+    </item>
+    <item>
+      <p>From the <gui>Save in folder</gui> drop down list, select the folder
+      you want the screenshot to be saved in. You can also click <gui>Browse for
+      other folder</gui> to select one which is not in the drop down list.</p>
+    </item>
+    <item>
+      <p>Click <gui>Save</gui> to save the screenshot.</p>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/C/view-only.page b/help/C/view-only.page
new file mode 100644
index 0000000..8b55502
--- /dev/null
+++ b/help/C/view-only.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="view-only">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <title type="sort">9</title>
+    <desc>Disable interaction with the remote desktop.</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>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
+  corresponding toolbar button to enable this mode.</p>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 415d0eb..1e7983f 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -16,7 +16,10 @@ DOC_FIGURES = \
 DOC_PAGES = \
 	bookmarks.page \
 	connect.page \
+	fullscreen.page \
 	index.page \
 	preferences.page \
 	reverse-connections.page \
-	using.page
+	scaling.page \
+	take-screenshot.page \
+	view-only.page
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]