Merge pull request #3702 from owncloud/updates2-0

updates for 2.0 release

doc/index.rst

@@ -16,5 +16,4 @@ ownCloud Desktop Client Manual
    architecture
    troubleshooting
    faq
-   glossary 
-
+   glossary

doc/installing.rst

@@ -16,7 +16,7 @@ Linux users must follow the instructions on the download page to add the
 appropriate repository for their Linux distribution, install the signing key, 
 and then use their package managers to install the desktop sync client. Linux 
 users will also update their sync clients via package manager, and the client 
-will display a notification when an update is available.
+will display a notification when an update is available. 
 
 Linux users must also have a password manager enabled, such as GNOME Keyring or
 KWallet, so that the sync client can login automatically.
@@ -24,84 +24,92 @@ KWallet, so that the sync client can login automatically.
 Improvements and New Features
 -----------------------------
 
-The 1.8 client has a number of enhancements and performance improvements, 
-including:
+The 2.0 release of the ownCloud desktop sync client has many new features and 
+improvements.
 
-* Graphical selective sync file and folder selector. Select which files and 
-  folders to sync with just a few clicks.
-* Selective sync on account setup. Set up which files and folders you want to 
-  sync when you create a new ownCloud account.
-* File manager integration: share files from Windows Explorer, Mac OS X Finder, 
-  and Nautilus on Linux.
-* Faster uploads and downloads.
+  * Multi-account support
+  * Many UI improvements
+  * Accessibility improvements (high contrast schemes)
+  * Automatic Bandwidth Throttling
+  * Don't show redundant directory entries in activity log
+  * Remove deleted accounts properly from toolbar
+  * File manager integration: Show hidden files as ignored
+  * Show wizard when last account was deleted
+  * Do not sync down new big folders from server without user's consent
+  * Integrate Selective Sync into the default UI
+  * More reliable reconnect after timeout
+  * Use SI units for the file sizes
+  * Improve progress reporting during sync
+  * Sharing: Do not allow sharing the root folder
+  * Sharing: Show thumbnail
+  * Client Updater: Check for updates periodically, not only once per run
+  * Quota: Only refresh from server when UI is shown
+  * SSL Button: Show more information
+  * System proxy: Ask user for credentials if needed
+  * Several fixes and performance improvements in the sync engine
+  * OS X: Show file name in UI if file has invalid UTF-8 in file name 
+  * OS X: Support native finder integration for 10.10 Yosemite  
+  * Network: Try to use SSL session tickets/identifiers
+  * Windows: Support paths >255 characters
+  * Windows, OS X: Allow to not sync hidden files
+  * Windows: Remove misleading option to remove sync data
+  * Windows: Do not provoke Active Directory account locking if password changes
+  * Windows: Fix installer when installing unprivileged
 
-.. note:: When you upgrade from 1.7, restart Windows to ensure that all new 
+.. note:: When you upgrade from 1.8, restart Windows to ensure that all new 
    features are visible.
 
-Installation
-------------
+Installation Wizard
+-------------------
 
 The installation wizard takes you step-by-step through configuration options and 
-account setup. These examples are on Windows 7; note the new "Integration for 
-Windows Explorer Option". This allows Windows users to share files directly 
-from their local ownCloud folder in Windows Explorer, rather than having to 
-open a Web browser and share from the ownCloud Web interface. Mac users get the 
-same option for Finder, and Linux users for Nautilus. 
+account setup. First you need to enter the URL of your ownCloud server.
 
 .. image:: images/client1.png
-
-The next screen selects the installation folder for the client. The default is 
-fine; don't change this without a good reason.
+   :alt: form for entering ownCloud server URL
+   
+Enter your ownCloud login on the next screen.
 
 .. image:: images/client2.png
+   :alt: form for entering your ownCloud login
 
-In the next screen, enter your ownCloud server URL.
+On the Local Folder Option screen you may sync 
+all of your files on the ownCloud server, or select individual folders. The 
+default local sync folder is ``ownCloud``, in your home directory. You may 
+change this as well.
 
 .. image:: images/client3.png
-
-If your ownCloud server has a self-signed SSL certificate, you will see a scary 
-warning. Check "Trust this certificate" and keep going.
+   :alt: Select which remote folders to sync, and which local folder to store 
+   them in.
+   
+When you have completed selecting your sync folders, click the Connect button 
+at the bottom right. The client will attempt to connect to your ownCloud 
+server, and when it is successful you'll see two buttons: one to connect to 
+your ownCloud Web GUI, and one to open your local folder. It will also start 
+synchronizing your files.
 
 .. image:: images/client4.png
+   :alt: A successful server connection, showing a button to connect to your 
+   Web GUI, and one to open your local ownCloud folder
 
-On the next screen enter your ownCloud login and password.
+Click the Finish button, and you're all done.   
+
+When you are in your local ownCloud folder, you can right-click any file or 
+folder, and then left-click "Share with ownCloud" to create a share link. Note 
+that Windows may also have a Share With option. This is not the ownCloud Share 
+option. Linux users must install the ``owncloud-client-nautilus`` package to 
+enable file sharing from the Nautilus file manager. The ownCloud share dialog 
+looks like the following example on Ubuntu Linux:
 
 .. image:: images/client5.png
-
-Now you can select which folders and files to sync, and the location of your 
-local ownCloud folder.
-
-.. image:: images/client6.png
-
-When you check "Choose what to sync" it opens a file picker. Note the warning 
-at the top that unchecked folders will be removed from your local filesystem. 
-On a new installation, when you have not yet synced with your ownCloud server, 
-no files will be deleted.
-
-.. image:: images/client7.png
-
-In the next screen you may click to open ownCloud in a Web browser, or open 
-your local ownCloud folder. Open your local ownCloud folder so you can see how 
-file manager integration works.
-
-.. image:: images/client8.png
-
-When you are in your local ownCloud folder you can right-click any file or 
-folder, and then left-click "Share with ownCloud" to create a share link. Note that Windows
-may also have a Share With option. This is not the ownCloud Share option. The 
-ownCloud share dialog looks like the following example:
-
-.. image:: images/client9.png
-
-You have the same options for creating a link share as you do when you're 
-logged into the ownCloud Web GUI: you may optionally set a password and 
-expiration date.
-
-.. image:: images/client10.png
+   :alt: the ownCloud file share option is integrated into the normal 
+   right-click file menu in your file manager
 
 You may change your sync options at any time by opening your ownCloud client 
-and clicking the "Choose what to sync" button. This opens the same file picker 
-you saw in the installation wizard. If you un-check any folders or files that 
-you have already synchronized they will be deleted.
+and selecting which folders to sync, or to remove from synchronization.
+you saw in the installation wizard. **If you un-check any folders that 
+you have already synchronized, they will be deleted from your local system.**
 
-.. image:: images/client11.png
+.. image:: images/client6.png
+   :alt: Client dialogue to select different files to sync, or to remove from 
+   syncing

doc/introduction.rst

@@ -1,3 +1,4 @@
+============
 Introduction
 ============
 
@@ -13,4 +14,4 @@ and local PC.
 
 .. note:: Because of various technical issues, desktop sync clients older than 
    1.7 will not allowed to connect and sync with the ownCloud 8.1 server. It is 
-   highly recommended to keep your client updated.
+   highly recommended to keep your client updated.

doc/navigating.rst

@@ -1,3 +1,4 @@
+================================
 Using the Synchronization Client
 ================================
 
@@ -38,243 +39,81 @@ so you should click it to see what it has to tell you.
 The red circle with the white "x" indicates a configuration error, such as an 
 incorrect login or server URL.
 
-Using the Desktop Client Menu
------------------------------
+Using the Right-Click Menu
+--------------------------
 
-A right-click on the icon opens the following menu:
+A right-click on the icon opens a menu for quick access to multiple operations.
 
 .. image:: images/menu.png
-
-**ownCloud Desktop Client menu**
+   :alt: the right-click sync client menu
 
 The Desktop Client menu provides the following options:
 
-* ``Open ownCloud in browser``: Launches the ownCloud Web interface.
-* ``Open folder 'ownCloud'``: Opens your local ownCloud 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, and shows the 
-  current synchronization status listing all changes since the last restart of the 
-  ownCloud client.
-* ``Settings...``: The settings menu.
-* ``Help``: Opens a browser to display ownCloud Desktop Client Guide.
-* ``Sign out``: Stops synchronization.
-* ``Quit ownCloud``: Quits the ownCloud Client, ending any currently running
-  synchronizations.
+* Open ownCloud in browser
+* Managed folder
+* Open folder [your local sync folder]
+* Up to date
+* Recent changes
+* Settings
+* Help
+* Sign out
+* Quit ownCloud
 
 Using the Account Settings Window
 ---------------------------------
 
 .. index:: account settings, user, password, Server URL
 
-The ``Account`` window provides a summary of your ownCloud account settings.  
-You can manage which folders and files you want to synchronize, change your 
-account settings, and pause and resume synchronization.
+Click **Settings** in the right-click menu to see a summary of your ownCloud 
+account settings. This shows which ownCloud account you are connected to (or accounts, if you have more than one) your 
+quota status, and a window for managing your synchronization settings.
 
-To access and modify the account settings:
+.. image:: images/client6.png
+   :alt: Account settings window
 
-.. image:: images/settings_account.png
-   :scale: 50 %
+At the top of the window are tabs for each configured sync account, and three others for Activity, General and Network settings.
 
-The fields and options in this window include:
+The Activity window contains the log of your recent activities, including files 
+downloaded and deleted.
 
-* ``Connected to <ownCloud instance> as <user>`` field:  Your user account on an ownCloud 
-  server.
+The General window has configuration options such as Launch on **System 
+Startup**, **Use Monochrome Icons**, and **Show Desktop Notifications**. This 
+is where you will find the **Edit Ignored Files** button, to launch the ignored 
+files editor, and two new features: **Ask confirmation before downloading 
+folders larger than [folder size]**, and **Add an Account**. 
 
-* ``Add Folder...`` button: Add another folder to the 
-  synchronization process (see ``Adding a Folder``).
+Multi-Account Support
+---------------------
 
-* ``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. 
-
-* ``Storage Usage`` field: Displays how much space your files are using on the 
-  ownCloud server.
-
-* ``Edit Ignored Files`` button: Launches the Ignored Files Editor.
-
-* ``Modify Account`` button: Use this to change your ownCloud server settings 
-  by launching the account setup wizard (see :doc:`accountsetup`).
-
-Adding a Folder
-^^^^^^^^^^^^^^^
-
-The ``Add Folder ...`` button enables you to add a new local folder to the 
-synchronization process.
-
-To add a new folder:
-
-1. Click the ``Add Folder ...`` button in the Account window.
-
-  The ``Add Folder...`` window opens
-
-.. image:: images/folderwizard_local.png
-
-2. Type a *unique* path and alias name to the folder, or use the ``Choose...`` 
-   button to open a graphical file picker.
-
-.. note:: Nested synchronizations are not supported.  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 synchronizes your entire ownCloud account to the root
-    folder of the ownCloud server. If you wish to sync certain specific folders and not 
-    the entire root, you must first remove the root folder.
-
-3. Click 'Next' to continue.
-
-  A window opens prompting you to select a remote destination folder on the
-  ownCloud server to synchronize.
-
-.. image:: images/folderwizard_remote.png
-
-4. Select a folder on the ownCloud server to which you want to synchronize your 
-   newly added local 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.
+You may now configure multiple ownCloud accounts in your desktop sync client. 
+Simply click the **Add an Account** button on the General tab, and follow the 
+account creation wizard. The new account will appear as a new tab in the settings dialog, where you can adjust its settings at any time.
 
 Editing Ignored Files
-^^^^^^^^^^^^^^^^^^^^^
+---------------------
 
-The :guilabel:`Ignored Files Editor` provides a list of  files that are ignored 
+The Ignored Files Editor can be opened by clicking on the button in the General tab of the settings dialog. The settings apply to all configured accounts. The :guilabel:`Ignored Files Editor` provides a list of  files that are ignored 
 (that is, not synchronized) by the client and server during synchronizations. 
 You may add additional files or directories that you want to exclude from the 
 synchronization process. 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 indicate a single 
-character).
+character). 
 
 For additional information see `Using the Ignored Files 
 Editor`_
 
-Using the Activity Settings Window
-----------------------------------
-
-.. index:: activity, recent changes, sync activity
-
-The Activity window provides an in-depth account of recent synchronization activity.  It 
-shows files that have not been synchronized because they are on the ignored files list, 
-or 
-because they cannot be synced due to containing special characters that cannot be stored 
-on certain file systems.
-
-.. image:: images/settings_activity.png
-
-You can open the Activity window in one of the following ways:
-
-- Click 'Activity' in the left frame of the ownCloud Settings window.
-
-- Invoke the window from the ownCloud Desktop Client menu by selecting ``Recent
-  Changes`` > ``Details...``.  (See Using the Desktop Client Menu.) 
-
-Using the General Settings Window
----------------------------------
-
-.. index:: general settings, auto start, startup, desktop notifications
-
-The General settings window has options for launching the client at system 
-startup, notifications, and using monochrome icons.
-
-.. image:: images/settings_general.png
-
-* ``Launch on System Startup`` checkbox: Provides the option to check (enable)
-  or uncheck (disable) whether the ownCloud Desktop Client launches at system
-  startup.  By default, this option is enabled (checked) after you have configured
-  your account.
-
-* ``Show Desktop Notifications`` checkbox: Provides the option to check (enable)
-  or uncheck (disable) notifications about sync activity.
-
-* ``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 OS X 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.
-
-* ``Updates`` field: Notifies you of any available updates for the ownCloud Desktop 
-  Client.
-
-Using the Network Settings Window
----------------------------------
+Using the Network Window
+------------------------
 
 .. index:: proxy settings, SOCKS, bandwith, throttling, limiting
 
-The Network settings window enables you to define network proxy settings, and also to 
-limit download and upload bandwidth.
+The Network settings window enables you to define network proxy settings, and 
+also to limit download and upload bandwidth. New to version 2.0 is the option 
+for automatic bandwidth limits.
 
 .. image:: images/settings_network.png
 
-Specifying Proxy Settings
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* ``No Proxy`` option: Do not use a proxy.
-
-* ``Use system proxy`` option: Default setting. Follows the systems proxy
-  settings.
-
-* ``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 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.
-
-Bandwidth Limiting
-^^^^^^^^^^^^^^^^^^
-
-Synchronization of files between a client and server can use a lot of
-bandwidth, so you can limit how much your ownCloud sync client uses.
-
-- ``No limit`` option: The default setting for the client; specifies that there
-  are no limit settings on the bandwidth used by data downloaded from the server. 
-
-- ``Limit to <value> KBytes/s`` option: Limits (throttles) the bandwidth to
-  a customized value (in KBytes/second).
-
-The Upload Bandwidth field (for data flowing from the ownCloud client to the
-server) provides the following options:
-
-- ``No limit`` option: The default setting for the client; specifies that there
-  are no limit settings on the bandwidth used by data uploaded to the server. 
-
-- ``Limit automatically``: When enabled, the ownCloud client surrenders
-  available bandwidth to other applications.  Use this option if there are
-  issues with real time communication (for example, the use of IP phone or live
-  streaming) in conjunction with the ownCloud Client.
-
-- ``Limit to <value> KBytes/s`` option: Limits (throttles) the bandwidth to a
-  customized value (in KBytes/second).
-
-
 .. _ignoredFilesEditor-label:
 
 Using the Ignored Files Editor
@@ -288,13 +127,13 @@ can use the *Ignored Files Editor*.
 
 .. image:: images/ignored_files_editor.png
 
-For your convenience, the editor is
-pre-populated with a default list of typical 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
-patterns directly from the editor. However, if necessary, you can hover over
-any pattern in the list to show the path and filename associated with that
-pattern, locate the file, and edit the ``sync-exclude.lst`` file.
+For your convenience, the editor is pre-populated with a default list of typical 
+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 patterns directly from the editor. However, if 
+necessary, you can hover over any pattern in the list to show the path and 
+filename associated with that pattern, locate the file, and edit the 
+``sync-exclude.lst`` file.
 
 .. note:: Modifying the global exclude definition file might render the client
    unusable or result in undesired behavior.