Merge pull request #3490 from nextcloud/bugfix/update-documentation

Update documentation and replace old screenshots
This commit is contained in:
Felix Weilbach 2021-06-25 22:11:16 +02:00 committed by GitHub
commit fd7666100a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 80 additions and 114 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 283 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 167 KiB

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 267 KiB

After

Width:  |  Height:  |  Size: 43 KiB

BIN
doc/images/main_dialog.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 283 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
doc/images/share_dialog.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

BIN
doc/images/traymenu.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.6 KiB

View File

@ -32,13 +32,8 @@ System Requirements
----------------------------------
- Windows 10+
- macOS 10.12+ (**64-bit only**)
- macOS 10.10 & 10.11 (**64-bit and up to client legacy version 2.6.5 only**)
- CentOS 6 & 7 (64-bit only)
- Debian 8.0 & 9.0
- Fedora 25 & 26 & 27
- Ubuntu 16.04 & 17.04 & 17.10
- openSUSE Leap 42.2 & 42.3
- macOS 10.12+ (64-bit only)
- Linux
- FreeBSD
.. note::

View File

@ -52,51 +52,53 @@ Systray Icon
A right-click on the systray icon opens a menu for quick access to multiple
operations.
.. figure:: images/menu.png
.. figure:: images/traymenu.png
:alt: the right-click sync client menu
This menu provides the following options:
* Quick access to your accounts
* Sync status
* Recent Changes, showing latest activities
* Open main dialog
* Paus sync/Resume sync
* Settings
* Help menu
* Pause synchronizations
* An option to log in or log out of all of your accounts at once
* Quit Nextcloud, logging out and closing the client
* Exit Nextcloud, logging out and closing the client
A left-click on your systray icon opens the desktop client to the account
settings window.
A left-click on your systray icon opens the main dialog of the desktop client.
.. figure:: images/client-6.png
:alt: Account settings window
.. figure:: images/main_dialog.png
:alt: Main dialog
The main dialogs show recent activities, errors and server notifications.
When clicking on the main dialog and then clicking on the avatar of the user, the Settings can be opened.
Configuring Nextcloud Account Settings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. index:: account settings, user, password, Server URL
At the top of the window are tabs for each configured sync account, and three
others for Activity, General and Network settings. On your account tabs you
.. figure:: images/settingsdialog.png
:alt: Main dialog
At the top of the window are tabs for each configured sync account, and two
others for General and Network settings. On your account tabs you
have the following features:
* Connection status, showing which Nextcloud server you are connected to, and
your Nextcloud username.
* An **Account** button, which contains a dropdown menu with **Add New**,
**Log Out**, and **Remove**.
* Used and available space on the server.
* Current synchronization status.
* **Add Folder Sync Connection** button.
The little button with three dots (the overflow menu) that sits to the right of
the sync status bar offers four additional options:
the sync status bar offers additional options:
* Open Folder
* Choose What to Sync (This appears only when your file tree is collapsed, and
expands the file tree)
* Pause Sync / Resume Sync
* Remove folder sync connection
* Availability (Only available if virtual files support is enabled)
* Enable virtual file support/Disable virtual file support
**Open Folder** opens your local Nextcloud sync folder.
@ -105,7 +107,7 @@ account. It will continue to update file and folder lists, without
downloading or updating files. To stop all sync activity use **Remove
Folder Sync Connection**.
.. figure:: images/client-7.png
.. figure:: images/general_settings_folder_context_menu.png
:alt: Extra options for sync operations
.. note:: Nextcloud does not preserve the mtime (modification time) of
@ -168,54 +170,18 @@ Nextcloud users the same way as in your Nextcloud Web interface.
.. figure:: images/mac-share.png
:alt: Sync client integration in Windows Explorer.
Right-click your systray icon, hover over the account you want to use, and
left-click "Open folder [folder name] to quickly enter your local Nextcloud
folder. Right-click the file or folder you want to share to expose the share
dialog, and click **Share with Nextcloud**.
In you file explorer, click on a file and in the context menu go to
**Nextcloud** and then lick on **Share options** to bring up the Share
dialog.
.. figure:: images/share-1.png
.. figure:: images/share_context_menu.png
:alt: Sharing from Windows Explorer.
The share dialog has all the same options as your Nextcloud Web interface.
From this dialog you can share a file.
.. figure:: images/share-2.png
:alt: Share dialog in Windows Explorer.
.. figure:: images/share_dialog.png
:alt: Share dialog
Use **Share with Nextcloud** to see who you have shared with, and to modify
their permissions, or to delete the share.
Activity Window
---------------
The Activity window contains the log of your recent activities, organized over
three tabs: **Server Activities**, which includes new shares and files
downloaded and deleted, **Sync Protocol**, which displays local activities such
as which local folders your files went into, and **Not Synced** shows errors
such as files not synced. Double clicking an entry pointing to an existing
file in **Server Activities** or **Sync Protocol** will open the folder containing
the file and highlight it.
.. figure:: images/client-8.png
:alt: Activity windows logs all server and client activities.
Server Notifications
--------------------
Starting with version 2.2.0, the client will display notifications from your
Nextcloud server that require manual interaction by you. For example, when a
user on a remote Nextcloud creates a new Federated share for you, you can accept
it from your desktop client.
The desktop client automatically checks for available notifications
automatically on a regular basis. Notifications are displayed in the Server
Activity tab, and if you have **Show Desktop Notifications** enabled (General
tab) you'll also see a systray notification.
.. figure:: images/client-12.png
:alt: Activity window with notification.
This also displays notifications sent to users by the Nextcloud admin via the
Announcements app.
General Window
--------------
@ -226,7 +192,7 @@ is where you will find the **Edit Ignored Files** button, to launch the ignored
files editor, and **Ask confirmation before downloading
folders larger than [folder size]**.
.. figure:: images/client-9.png
.. figure:: images/settings_general.png
:alt: General window contains configuration options.
Using the Network Window

View File

@ -12,29 +12,39 @@ as an icon in the system tray (Windows, KDE), status bar
.. image:: images/icon.png
Main dialog
~~~~~~~~~~~
.. index:: activity, recent changes, sync activity, main dialog, adding account, account, add account, remove account
The main dialog, which can be invoked from the tray icon in the
taskbar, will show files information about the activities of the sync
client and Nextcloud. If there are any synchronization issues, they
will show up here. The dialog also gives information about other
activities or notifications like Talk mentions or file changes. It
does also show the status of the user.
.. image:: images/main_dialog.png
When clicking on the avatar a menu opens where it is possible to add a
new account or removing an existing account.
Menu
----
.. image:: images/menu.png
.. image:: images/traymenu.png
A right click on the icon (left click on Ubuntu and macOS)
provides the following menu:
A right click on the icon provides the following menu:
* ``Open Nextcloud in browser``: Opens the Nextcloud web interface
* ``Open folder 'Nextcloud'``: Opens the local folder. If multiple
sync targets have been defined, an entry will exist for each local folder.
* **Disk space indicator**: Shows how much space is used on the server.
* Operation indicator: Shows the status of the current sync process, or
``Up to date`` if server and client are in sync.
* **Recent Changes**: shows the last six files modified by sync operations,
and provides access to the Sync status, which lists all changes
since the last restart of Nextcloud Client.
* ``Settings...``: provides access to the settings menu.
* ``Help``: Opens a browser to display this help.
* ``Log out``: Logs the client out of the server.
* ``Quit Nextcloud``: Quits Nextcloud Client, ending a currently running
* ``Open main dialog``: Opens the main dialog.
* ``Pause sync``: Pauses the synchronization.
* ``Settings``: Provides access to the settings menu.
* ``Exit Nextcloud``: Quits Nextcloud Client, ending a currently running
sync run.
.. NOTE::
This menu is not available on macOS.
Settings
--------
@ -51,28 +61,41 @@ Where:
* ``Connected to <Nextcloud instance> as <user>``: Indicates the Nextcloud server
which the client is syncing with and the user account on that server.
* ``Add Folder Sync Connection...``: Provides the ability to add another folder to the sync
* If the End-to-End encryption app is installed, then the current used
passphrase can be shown with clicking on ``Display mnemonic``.
Clicking on the tree dot menu or doing a right click on the folder
opens up a context menu with the following options:
* ``Open folder``: Opens the folder in the file explorer which the
operating system provides. In example on Windows it will open the Windows Explorer.
* ``Create new folder``: Creates a new folder.
* ``Force sync now``: Forces a synchronization run.
* ``Availability``: This entry is only available if the folder uses the
virtual files feature. The files in the folder can be either made
available offline with ``Make always available locally`` or if disk
space needs to be saved, they can be turned into placeholder files
with ``Free up local space``. ``Free up local space`` will not
delete any files.
* ``Add folder sync connection``: Provides the ability to add another folder to the sync
(see ``Adding a folder sync connection``).
* ``Pause/Resume``: Will pause the current sync or prevent the client from
* ``Pause sync/Resume sync``: Will pause the current sync or prevent the client from
starting a new sync. Resume will resume the sync process.
* ``Remove``: Will remove the selected folder from being synced. This is used,
* ``Remove folder sync connection``: Will remove the selected folder from being synced. This is used,
for instance, when there is a desire to sync only a few folders and not the
root. First, remove the root from sync, then add the folders to sync as
desired.
* ``Storage Usage``: Provides further details on the storage utilization on the
Nextcloud server.
* ``Edit Ignored Files``: Provides a list of files which will be ignored, i.e.,
will not sync between the client and server. The ignored files editor allows
adding patterns for files or directories that should be excluded from the
sync process. Besides normal characters, wild cards may be used, an asterisk
* indicating multiple characters, or a question mark ? indicating a single
character.
* ``Enable virtual file support/Disable virtual file support``: Enable
or disable virtual file support for this folder.
* ``Modify Account``: Allows the user to change the Nextcloud server being synced
to. It brings up the Setting up an Account (see above) windows.
.. image:: images/settings_account.png
:scale: 50 %
.. image:: images/settingsdialog.png
Adding a Folder Sync Connection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -81,32 +104,15 @@ Adding a new sync is initiated by clicking ``Add Folder Sync Connection`` in
the ``Account`` settings.
.. image:: images/folderwizard_local.png
:scale: 50 %
The Directory and alias name must be unique.
.. image:: images/folderwizard_remote.png
:scale: 50 %
Select the folder on the server to sync with. It is important to note that, a
Then select the folder on the server to sync with. It is important to note that, a
server folder can only sync to the client one time. So, in the above example,
the sync is to the server root directory and thus it is not possible to select
another folder under the root to sync.
Activity
~~~~~~~~
.. index:: activity, recent changes, sync activity
The Activity window, which can be invoked either from the main menu (``Recent
Changes -> View more activity…``) or the Activity tab on the left side of the settings
window, provides an in-depth account of the recent sync activity. It will show
files that have not been synced because they are on the ignored files list, or
because they cannot be synced in a cross-platform manner due to containing
special characters that cannot be stored on certain file systems.
.. image:: images/settings_activity.png
:scale: 50 %
.. image:: images/folderwizard_remote.png
General
~~~~~~~
@ -116,7 +122,6 @@ General
The tab provides several useful options:
.. image:: images/settings_general.png
:scale: 50 %
* ``Launch on System Startup``: This option is automatically activated
once a user has conimaged his account. Un-checking the box will cause