Merge pull request #2370 from owncloud/icons-overlay-doc

Add section on Overlay Icons to 'Using the Synchronization Client'

7 files changed, 100 insertions, 56 deletions

diff --git a/doc/images/icon-error.png b/doc/images/icon-error.png
new file mode 100644
index 000000000..6eb5e3e40
--- /dev/null
+++ b/doc/images/icon-error.png
diff --git a/doc/images/icon-information.png b/doc/images/icon-information.png
new file mode 100644
index 000000000..f1ce1eb62
--- /dev/null
+++ b/doc/images/icon-information.png
diff --git a/doc/images/icon-offline.png b/doc/images/icon-offline.png
new file mode 100644
index 000000000..40a4c7882
--- /dev/null
+++ b/doc/images/icon-offline.png
diff --git a/doc/images/icon-paused.png b/doc/images/icon-paused.png
new file mode 100644
index 000000000..eada780f9
--- /dev/null
+++ b/doc/images/icon-paused.png
diff --git a/doc/images/icon-syncing.png b/doc/images/icon-syncing.png
new file mode 100644
index 000000000..4b0f2515d
--- /dev/null
+++ b/doc/images/icon-syncing.png
diff --git a/doc/images/icon.png b/doc/images/icon.png
index 28dee23cc..29888b6cf 100644
--- a/doc/images/icon.png
+++ b/doc/images/icon.png
diff --git a/doc/navigating.rst b/doc/navigating.rst
index 9e6bfeca9..6fa12b225 100644
--- a/doc/navigating.rst
+++ b/doc/navigating.rst
@@ -9,7 +9,35 @@ system tray (Windows, KDE), status bar (MAC OS X), or notification area
 
 .. image:: images/icon.png
 
-**ownCloud Desktop Client icon**
+This is a status indicator which uses overlay icons to indicate the 
+current status of your synchronization. The green circle with the white checkmark 
+tells you that your synchronization is current and you are connected to your 
+ownCloud server.
+
+.. image:: images/icon-syncing.png
+
+The blue icon with the white semi-circles means synchronization is in progress.
+
+.. image:: images/icon-paused.png
+
+The yellow overlay icon with the parallel lines tells you your synchronization 
+has been paused. (Most likely by you, by opening the client and clicking 
+Account > Pause.)
+
+.. image:: images/icon-offline.png
+
+The gray icon with three white dots means your sync client has lost its 
+connection with your ownCloud server.
+
+.. image:: images/icon-information.png
+
+When you see a white circle with the letter "i" that is the informational icon, 
+so you should click it to see what it has to tell you.
+
+.. image:: images/icon-error.png
+
+The red circle with the white "x" indicates a configuration error, such as an 
+incorrect login or server URL.
 
 Using the Desktop Client Menu
 -----------------------------
@@ -24,10 +52,17 @@ following menu:
 The Desktop Client menu provides the following options:
 
 * ``Open ownCloud in browser``: Launches the ownCloud WEB interface.
-* ``Open folder 'ownCloud'``: Opens the ownCloud local folder.  If you have defined multiple synchronization targets, the window displays each local folder.
-* **Disk space indicator**: Indicates the amount of space currently used on the server.
-* Operation indicator: Displays the status of the current synchronization process or indicates ``Up to date`` if the server and client are in sync.
-* **Recent Changes**: Displays the last six files modified by the synchronization operations and provides access to the current synchronization status listing all changes since the last restart of the ownCloud client.
+* ``Open folder 'ownCloud'``: Opens the ownCloud local folder. If you have 
+  defined multiple synchronization targets, the window displays each local 
+  folder.
+* **Disk space indicator**: Indicates the amount of space currently used on the 
+  server.
+* Operation indicator: Displays the status of the current synchronization 
+  process or indicates ``Up to date`` if the server and client are in sync.
+* **Recent Changes**: Displays the last six files modified by the 
+  synchronization operations and provides access to the current 
+  synchronization status listing all changes since the last restart of the 
+  ownCloud client.
 * ``Settings...``: Provides access to the settings menu.
 * ``Help``: Opens a browser to display ownCloud Desktop Client Guide.
 * ``Sign out``: Disables the client from continued synchronizations.
@@ -39,7 +74,9 @@ Using the Account Settings Window
 
 .. index:: account settings, user, password, Server URL
 
-The ``Account`` window provides a summary for general settings associated with the ownCloud account.  This window enalbes you to manage any synchronized folders in the account and enables you to modify them.
+The ``Account`` window provides a summary for general settings associated with 
+the ownCloud account.  This window enalbes you to manage any synchronized 
+folders in the account and enables you to modify them.
 
 To access and modify the account settings:
 
@@ -48,25 +85,37 @@ To access and modify the account settings:
 
 The fields and options in this window include:
 
-* ``Connected to <ownCloud instance> as <user>`` field:  Indicates the ownCloud server to which the client is synchronizing and the user account on that server.
+* ``Connected to <ownCloud instance> as <user>`` field:  Indicates the ownCloud 
+  server to which the client is synchronizing and the user account on that 
+  server.
 
-* ``Add Folder...`` button: Provides the ability to add another folder to the synchronization process (see ``Adding a Folder``).
+* ``Add Folder...`` button: Provides the ability to add another folder to the 
+  synchronization process (see ``Adding a Folder``).
 
-* ``Pause/Resume`` button: Pauses the current sync (or prevents the client from starting a new sync) or resumes the sync process.
+* ``Pause/Resume`` button: Pauses the current sync (or prevents the client from 
+  starting a new sync) or resumes the sync process.
 
-* ``Remove`` button: Removes the selected folder from the sync process.  This button is used when you want to synchronize only a few folders and not the root folder.  If only the root folder is available, you must first remove the root from the synchronization and then add individual folders that you want to synchronize as desired.
+* ``Remove`` button: Removes the selected folder from the sync process.  This 
+  button is used when you want to synchronize only a few folders and not the 
+  root folder.  If only the root folder is available, you must first remove the 
+  root from the synchronization and then add individual folders that you want 
+  to synchronize as desired.
 
-* ``Storage Usage`` field: Indicates the storage utilization on the ownCloud server.
+* ``Storage Usage`` field: Indicates the storage utilization on the ownCloud 
+  server.
 
 * ``Edit Ignored Files`` button: Launches the Ignored Files Editor.
 
-* ``Modify Account`` button: Enables you to change the ownCloud server to which you are synchronizing. This option launches the ``Setting up an Account`` windows (See ??).
+* ``Modify Account`` button: Enables you to change the ownCloud server to which 
+  you are synchronizing. This option launches the ``Setting up an Account`` 
+  dialog (see :doc:`accountsetup`).
 
 
 Adding a Folder
 ^^^^^^^^^^^^^^^
 
-The ``Add a Folder ...`` button enables you to add a new folder to the syncrhonization process.
+The ``Add a Folder ...`` button enables you to add a new folder to the 
+syncrhonization process.
 
 To add a new folder:
 
@@ -74,37 +123,35 @@ To add a new folder:
 
   The ``Add Folder...`` window opens
 
-  .. image:: images/folderwizard_local.png
-   :scale: 50 %
+.. image:: images/folderwizard_local.png
 
-   **``Add Folder...`` window (local folder)**
+2. Specify a *unique* path and alias name to the folder or use the ``Choose...`` 
+   button to locate the new folder on your system to which you want to 
+   synchronize.
 
-2. Specify a *unique* path and alias name to the folder or use the ``Choose...`` button to locate the new folder on your system to which you want to synchronize.
-
-  ..note:: Nested synchronizations are not supported.  In other words, you
+.. note:: Nested synchronizations are not supported.  In other words, you
     cannot add a folder that is already contained within another synchronized
     folder. In addition, you cannot add a higher level (parent) folder that
     contains a folder to which you are already synchronizing.  By default, the
     ownCloud Set Up Wizard syncrhonizes your entire ownCloud account to the root
-    folder of the ownCloud server. Due to this default setup, you must first remove
-    the top-level folder prior to specifying new synchronizations.
+    folder of the ownCloud server. Due to this default setup, you must first 
+    remove the top-level folder prior to specifying new synchronizations.
 
 3. Click 'Next' to continue.
 
   A window opens prompting you to select a remote destination folder on the
   ownCloud server to which you want to synchronize.
 
-   .. image:: images/folderwizard_remote.png
-   :scale: 50 %
-
-   **``Add Folder...`` window (remote destination)**
+.. image:: images/folderwizard_remote.png
 
-4. Select a folder on the ownCloud server to which you want to synchronize your newly added folder.
+4. Select a folder on the ownCloud server to which you want to synchronize your 
+newly added folder.
 
-  ..note:: A server folder can only be synchronized with a particular client once.
-    If you attempt to sync the root directory, you cannot sync with other folders
-    on the server. Similarly, if you sync with folder ``/a``, you cannot create
-    another sync with ``/a/b``, since ``b`` is already being synched.
+..note:: A server folder can only be synchronized with a particular client 
+  once. If you attempt to sync the root directory, you cannot sync with 
+  other folders on the server. Similarly, if you sync with folder ``/a``, you 
+  cannot create another sync with ``/a/b``, since ``b`` is already being 
+  synched.
 
 Editing Ignored Files
 ^^^^^^^^^^^^^^^^^^^^^
@@ -117,7 +164,8 @@ In addition to using standard characters, the Ignored Files Editor enables you
 to use wild cards (for example, using an asterisk ‘*’ to indicate multiple
 characters or a question mark ‘?’ to incidate a single character).
 
-For additional information about this editor, see `Using the Ignored Files Editor`_
+For additional information about this editor, see `Using the Ignored Files 
+Editor`_
 
 Using the Activity Settings Window
 ----------------------------------
@@ -131,9 +179,6 @@ manner due to containing special characters that cannot be stored on certain
 file systems.
 
 .. image:: images/settings_activity.png
-   :scale: 50 %
-
-   **Activity settings window**
 
 You can open the Activity window in one of the following ways:
 
@@ -152,9 +197,6 @@ ownCloud Desktop Client and provides information about the software version,
 its creator, and the existance of any updates.
 
 .. image:: images/settings_general.png
-   :scale: 50 %
-
-   **General settings window**
 
 The settings and information contained in this window are as follows:
 
@@ -170,12 +212,13 @@ The settings and information contained in this window are as follows:
 * ``Use Monochrome Icons`` checkbox: Provides the option to check (enable) or
    uncheck (disable) the use of monochrome (visually less obtrusive) icons.
 
-  .. note:: This option can be useful on MAC OSX platforms.
+.. note:: This option can be useful on MAC OSX platforms.
 
 * ``About`` field: Provides information about the software authors along with
   pertinent build conditions.
 
-  .. note:: Information in this field can be valuable when submitting a support request.
+.. note:: Information in this field can be valuable when submitting a support 
+   request.
 
 * ``Updates`` field: Provides information about any available updates for the
   ownCloud Desktop Client.
@@ -190,9 +233,6 @@ well as limit the download and upload bandwidth utilization of file
 synchronizations.
 
 .. image:: images/settings_network.png
-   :scale: 50 %
-
-   **Network settings window**
 
 Specifying Proxy Settings
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -202,20 +242,27 @@ that functions as an intermediary contact for requests from clients that are
 seeking resources from other servers.  For the ownCloud Desktop Client, you can
 define the following proxy settings:
 
-* ``No Proxy`` option: Specifies that the ownCloud Client circumvent the default proxy configured on the system.
+* ``No Proxy`` option: Specifies that the ownCloud Client circumvent the default 
+  proxy configured on the system.
 * ``Use system proxy`` option: Default setting. Follows the systems proxy
   settings. On Linux systems, this setting uses the value of the variable
   ``http_proxy``.
 * ``Specify proxy manually as`` option: Enables you to specify
   the following custom proxy settings:
-  - ``HTTP(S)``: Used when you are required to use an HTTP(S) proxy server (for example, Squid or Microsoft Forefront TMG). 
-  - ``SOCKSv5``: Typically used in special company LAN setups, or in combination with the OpenSSH
+  - ``HTTP(S)``: Used when you are required to use an HTTP(S) proxy server (for 
+  example, Squid or Microsoft Forefront TMG). 
+  - ``SOCKSv5``: Typically used in special company LAN setups, or in combination 
+  with the OpenSSH
   dynamic application level forwarding feature (see ``ssh -D``).
-  - ``Host``: Host name or IP address of the proxy server along with the port number. HTTP proxies
-    typically listen over Ports 8080 (default) or 3128. SOCKS servers typically listen over port 1080.
-* ``Proxy Server requires authentication`` checkbox: Provides the option to check (enable/require) or
-  uncheck (disable/not require) proxy server authentication. When not checked, the proxy server must
-  be configured to allow anonymous usage. When checked, a proxy server username and password is required.
+  - ``Host``: Host name or IP address of the proxy server along with the port 
+  number. HTTP proxies typically listen over Ports 8080 (default) or 3128. 
+  SOCKS servers typically listen over port 1080.
+* ``Proxy Server requires authentication`` checkbox: Provides the option to 
+  check (enable/require) or
+  uncheck (disable/not require) proxy server authentication. When not checked, 
+  the proxy server must
+  be configured to allow anonymous usage. When checked, a proxy server username 
+  and password is required.
 
 Bandwidth Limiting
 ^^^^^^^^^^^^^^^^^^
@@ -265,13 +312,10 @@ can use the *Ignored Files Editor* that is embedded in the ownCloud Desktop
 Client.
 
 .. image:: images/ignored_files_editor.png
-   :scale: 50%
-
-   Ignored Files Editor window
 
-The :guilabel:`Ignored Files Editor` enables you to define customized patterns that the
-ownCloud Client uses to identify files and directories that you want to exclude
-from the synchronization process. For your convenience, the editor is
+The ``Ignored Files Editor`` enables you to define customized patterns 
+that the ownCloud Client uses to identify files and directories that you want 
+to exclude from the synchronization process. For your convenience, the editor is
 pre-populated with a default list of typically ignore patterns. These patterns
 are contained in a system file (typically ``sync-exclude.lst``) located in the
 ownCloud Client application directory. You cannot modify these pre-populated