diff --git a/doc/_shared_assets/themes/bootstrap/README.rst b/doc/_shared_assets/themes/bootstrap/README.rst deleted file mode 100644 index b43a04c14..000000000 --- a/doc/_shared_assets/themes/bootstrap/README.rst +++ /dev/null @@ -1,89 +0,0 @@ -======================== - Sphinx Bootstrap Theme -======================== - -This repository integrates the Twitter Bootstrap_ CSS / JavaScript framework -as a Sphinx_ theme_. A live demo_ is available to preview the theme. - -.. _Bootstrap: http://twitter.github.com/bootstrap/ -.. _Sphinx: http://sphinx.pocoo.org/ -.. _theme: http://sphinx.pocoo.org/theming.html -.. _demo: http://ryan-roemer.github.com/sphinx-bootstrap-theme - - -Installation -============ -To install the theme, download the theme directory and update your -configuration - -1. Create a "_themes" directory in your project source root. -2. Get the "bootstrap" themes either as raw files or as a zipfile from - the repository. - - a. Most current way is to just clone this repo or download the full - repo source and move the "bootstrap" directory to "_themes". - b. Alternatively, there are some prepackaged theme zip files (containing - only the theme files), which can be read directly by Sphinx. See the - repo downloads_ page for available packages. Then download - "bootstrap.zip":: - - $ cd /path/to/_themes - $ wget https://github.com/downloads/ryan-roemer/sphinx-bootstrap-theme/bootstrap.zip - - In addition to the "current" release, the GitHub zipfiles have either git - hash releases (for development builds) or tags for official tagged - releases. E.g.:: - - bootstrap.zip - bootstrap-v0.0.2.zip - bootstrap-f51d73491e9bae68eb1b1c57059d9e0ece03d125.zip - -3. Edit your configuration file to point to the bootstrap theme:: - - # Activate the theme. - sys.path.append(os.path.abspath('_themes')) - html_theme_path = ['_themes'] - html_theme = 'bootstrap' - - # (Optional) Use a shorter name to conserve nav. bar space. - html_short_title = "Demo" - - # (Optional) Logo. Should be exactly 32x32 px to fit the nav. bar. - # Path should be relative to the html_static_path setting (e.g., - # "_static") in source. - html_logo = "my_logo.png" - -.. _downloads: https://github.com/ryan-roemer/sphinx-bootstrap-theme/downloads - -Theme Notes -=========== -Sphinx ------- -The theme places the global TOC, local TOC, navigation (prev, next) and -source links all in the top Bootstrap navigation bar, along with the Sphinx -search bar on the left side. - -The global (site-wide) table of contents is the "Site" navigation dropdown, -which is a multi-level deep rendering of the ``toctree`` for the entire site. -The local (page-level) table of contents is the "Page" navigation dropdown, -which is a multi-level rendering of the current page's ``toc``. - -Generally speaking, this is a quick and dirty hack to get the basic theme -going, so there are likely some oversights and lurking issues. Help and -bug filings for the project are most welcome. - - -Bootstrap ---------- -The theme uses Twitter Bootstrap v2.0. You can override any static JS/CSS files -by dropping different versions in your Sphinx "_static" directory. - - -Licenses -======== -Sphinx Bootstrap Theme is licensed under the MIT_ license. - -Twitter Bootstrap is licensed under the Apache_ license. - -.. _MIT: https://github.com/ryan-roemer/sphinx-bootstrap-theme/blob/master/LICENSE.txt -.. _Apache: https://github.com/twitter/bootstrap/blob/master/LICENSE diff --git a/doc/_shared_assets/themes/nextcloud_com/static/img/social/ownCloud7launch.png b/doc/_shared_assets/themes/nextcloud_com/static/img/social/ownCloud7launch.png deleted file mode 100644 index f2fc07600..000000000 Binary files a/doc/_shared_assets/themes/nextcloud_com/static/img/social/ownCloud7launch.png and /dev/null differ diff --git a/doc/_shared_assets/themes/nextcloud_release/README.rst b/doc/_shared_assets/themes/nextcloud_release/README.rst deleted file mode 100644 index b43a04c14..000000000 --- a/doc/_shared_assets/themes/nextcloud_release/README.rst +++ /dev/null @@ -1,89 +0,0 @@ -======================== - Sphinx Bootstrap Theme -======================== - -This repository integrates the Twitter Bootstrap_ CSS / JavaScript framework -as a Sphinx_ theme_. A live demo_ is available to preview the theme. - -.. _Bootstrap: http://twitter.github.com/bootstrap/ -.. _Sphinx: http://sphinx.pocoo.org/ -.. _theme: http://sphinx.pocoo.org/theming.html -.. _demo: http://ryan-roemer.github.com/sphinx-bootstrap-theme - - -Installation -============ -To install the theme, download the theme directory and update your -configuration - -1. Create a "_themes" directory in your project source root. -2. Get the "bootstrap" themes either as raw files or as a zipfile from - the repository. - - a. Most current way is to just clone this repo or download the full - repo source and move the "bootstrap" directory to "_themes". - b. Alternatively, there are some prepackaged theme zip files (containing - only the theme files), which can be read directly by Sphinx. See the - repo downloads_ page for available packages. Then download - "bootstrap.zip":: - - $ cd /path/to/_themes - $ wget https://github.com/downloads/ryan-roemer/sphinx-bootstrap-theme/bootstrap.zip - - In addition to the "current" release, the GitHub zipfiles have either git - hash releases (for development builds) or tags for official tagged - releases. E.g.:: - - bootstrap.zip - bootstrap-v0.0.2.zip - bootstrap-f51d73491e9bae68eb1b1c57059d9e0ece03d125.zip - -3. Edit your configuration file to point to the bootstrap theme:: - - # Activate the theme. - sys.path.append(os.path.abspath('_themes')) - html_theme_path = ['_themes'] - html_theme = 'bootstrap' - - # (Optional) Use a shorter name to conserve nav. bar space. - html_short_title = "Demo" - - # (Optional) Logo. Should be exactly 32x32 px to fit the nav. bar. - # Path should be relative to the html_static_path setting (e.g., - # "_static") in source. - html_logo = "my_logo.png" - -.. _downloads: https://github.com/ryan-roemer/sphinx-bootstrap-theme/downloads - -Theme Notes -=========== -Sphinx ------- -The theme places the global TOC, local TOC, navigation (prev, next) and -source links all in the top Bootstrap navigation bar, along with the Sphinx -search bar on the left side. - -The global (site-wide) table of contents is the "Site" navigation dropdown, -which is a multi-level deep rendering of the ``toctree`` for the entire site. -The local (page-level) table of contents is the "Page" navigation dropdown, -which is a multi-level rendering of the current page's ``toc``. - -Generally speaking, this is a quick and dirty hack to get the basic theme -going, so there are likely some oversights and lurking issues. Help and -bug filings for the project are most welcome. - - -Bootstrap ---------- -The theme uses Twitter Bootstrap v2.0. You can override any static JS/CSS files -by dropping different versions in your Sphinx "_static" directory. - - -Licenses -======== -Sphinx Bootstrap Theme is licensed under the MIT_ license. - -Twitter Bootstrap is licensed under the Apache_ license. - -.. _MIT: https://github.com/ryan-roemer/sphinx-bootstrap-theme/blob/master/LICENSE.txt -.. _Apache: https://github.com/twitter/bootstrap/blob/master/LICENSE diff --git a/doc/_shared_assets/themes/nextcloud_release/static/img/logo_owncloud.svg b/doc/_shared_assets/themes/nextcloud_release/static/img/logo_owncloud.svg deleted file mode 100644 index cfb20b60e..000000000 --- a/doc/_shared_assets/themes/nextcloud_release/static/img/logo_owncloud.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/doc/_shared_assets/themes/nextcloud_release/static/img/social/ownCloud7launch.png b/doc/_shared_assets/themes/nextcloud_release/static/img/social/ownCloud7launch.png deleted file mode 100644 index f2fc07600..000000000 Binary files a/doc/_shared_assets/themes/nextcloud_release/static/img/social/ownCloud7launch.png and /dev/null differ diff --git a/doc/faq.rst b/doc/faq.rst index 02f0de811..3b7a66b8e 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -31,20 +31,20 @@ Specifically, you have to: 1. Remove the existing connection which syncs to the wrong directory 2. Add a new connection which syncs to the desired directory -.. figure:: images/setup/ownCloud-remove_existing_connection.png +.. figure:: images/setup/remove.png :alt: Remove an existing connection To do so, in the client UI, which you can see above, click the "**Account**" drop-down menu and then click "Remove". This will display a "**Confirm Account Removal**" dialog window. -.. figure:: images/setup/ownCloud-remove_existing_connection_confirmation_dialog.png +.. figure:: images/setup/confirm.png :alt: Remove existing connection confirmation dialog If you're sure, click "**Remove connection**". Then, click the Account drop-down menu again, and this time click "**Add new**". -.. figure:: images/setup/ownCloud-replacement_connection_wizard.png +.. figure:: images/setup/wizard.png :alt: Replacement connection wizard This opens the Nextcloud Connection Wizard, which you can see above, *but* with an extra option. diff --git a/doc/images/client-1.png b/doc/images/client-1.png new file mode 100644 index 000000000..d5ea08e4e Binary files /dev/null and b/doc/images/client-1.png differ diff --git a/doc/images/client-12.png b/doc/images/client-12.png new file mode 100644 index 000000000..9755e532d Binary files /dev/null and b/doc/images/client-12.png differ diff --git a/doc/images/client-2.png b/doc/images/client-2.png new file mode 100644 index 000000000..b7f3d413b Binary files /dev/null and b/doc/images/client-2.png differ diff --git a/doc/images/client-3.png b/doc/images/client-3.png new file mode 100644 index 000000000..98cbf9617 Binary files /dev/null and b/doc/images/client-3.png differ diff --git a/doc/images/client-4.png b/doc/images/client-4.png new file mode 100644 index 000000000..4f2e3c463 Binary files /dev/null and b/doc/images/client-4.png differ diff --git a/doc/images/client6.png b/doc/images/client-6.png similarity index 100% rename from doc/images/client6.png rename to doc/images/client-6.png diff --git a/doc/images/client12.png b/doc/images/client12.png deleted file mode 100644 index e65df63c5..000000000 Binary files a/doc/images/client12.png and /dev/null differ diff --git a/doc/images/folderwizard_local.png b/doc/images/folderwizard_local.png index 68bd7bf6c..097a9e1ac 100644 Binary files a/doc/images/folderwizard_local.png and b/doc/images/folderwizard_local.png differ diff --git a/doc/images/folderwizard_remote.png b/doc/images/folderwizard_remote.png index 1e70bd213..7ef456c63 100644 Binary files a/doc/images/folderwizard_remote.png and b/doc/images/folderwizard_remote.png differ diff --git a/doc/images/icon-error.png b/doc/images/icon-error.png index 6eb5e3e40..6260bba2a 100644 Binary files a/doc/images/icon-error.png and b/doc/images/icon-error.png differ diff --git a/doc/images/icon-information.png b/doc/images/icon-information.png index f1ce1eb62..01e57e75d 100644 Binary files a/doc/images/icon-information.png and b/doc/images/icon-information.png differ diff --git a/doc/images/icon-offline.png b/doc/images/icon-offline.png index 40a4c7882..ab80cb1b6 100644 Binary files a/doc/images/icon-offline.png and b/doc/images/icon-offline.png differ diff --git a/doc/images/icon-paused.png b/doc/images/icon-paused.png index eada780f9..c077666d5 100644 Binary files a/doc/images/icon-paused.png and b/doc/images/icon-paused.png differ diff --git a/doc/images/icon-syncing.png b/doc/images/icon-syncing.png index 4b0f2515d..85abef780 100644 Binary files a/doc/images/icon-syncing.png and b/doc/images/icon-syncing.png differ diff --git a/doc/images/icon.png b/doc/images/icon.png index 29888b6cf..d8f6830d4 100644 Binary files a/doc/images/icon.png and b/doc/images/icon.png differ diff --git a/doc/images/log_output_window.png b/doc/images/log_output_window.png index 29aaf9ed5..689f99591 100644 Binary files a/doc/images/log_output_window.png and b/doc/images/log_output_window.png differ diff --git a/doc/images/menu.png b/doc/images/menu.png index 88085ba22..430bc676f 100644 Binary files a/doc/images/menu.png and b/doc/images/menu.png differ diff --git a/doc/images/oc_connection_wizard_credentials.png b/doc/images/oc_connection_wizard_credentials.png deleted file mode 100644 index 54056a25c..000000000 Binary files a/doc/images/oc_connection_wizard_credentials.png and /dev/null differ diff --git a/doc/images/oc_connection_wizard_finish.png b/doc/images/oc_connection_wizard_finish.png deleted file mode 100644 index 8682e870c..000000000 Binary files a/doc/images/oc_connection_wizard_finish.png and /dev/null differ diff --git a/doc/images/oc_connection_wizard_localfolder.png b/doc/images/oc_connection_wizard_localfolder.png deleted file mode 100644 index 3a0cbf9ff..000000000 Binary files a/doc/images/oc_connection_wizard_localfolder.png and /dev/null differ diff --git a/doc/images/oc_connection_wizard_server.png b/doc/images/oc_connection_wizard_server.png deleted file mode 100644 index 87bb4723d..000000000 Binary files a/doc/images/oc_connection_wizard_server.png and /dev/null differ diff --git a/doc/images/save_log_file.png b/doc/images/save_log_file.png index 9f3abee01..f10264b49 100644 Binary files a/doc/images/save_log_file.png and b/doc/images/save_log_file.png differ diff --git a/doc/images/security_warning_windows.png b/doc/images/security_warning_windows.png deleted file mode 100644 index 45200b71b..000000000 Binary files a/doc/images/security_warning_windows.png and /dev/null differ diff --git a/doc/images/settings_account.png b/doc/images/settings_account.png index 7478b0b36..6ee1d08db 100644 Binary files a/doc/images/settings_account.png and b/doc/images/settings_account.png differ diff --git a/doc/images/settings_activity.png b/doc/images/settings_activity.png index e93f5b340..a383cd0a2 100644 Binary files a/doc/images/settings_activity.png and b/doc/images/settings_activity.png differ diff --git a/doc/images/settings_general.png b/doc/images/settings_general.png index 60a340a2c..6574d6826 100644 Binary files a/doc/images/settings_general.png and b/doc/images/settings_general.png differ diff --git a/doc/images/setup/confirm.png b/doc/images/setup/confirm.png new file mode 100644 index 000000000..1213f530b Binary files /dev/null and b/doc/images/setup/confirm.png differ diff --git a/doc/images/setup/ownCloud-remove_existing_connection.png b/doc/images/setup/ownCloud-remove_existing_connection.png deleted file mode 100644 index eef14f860..000000000 Binary files a/doc/images/setup/ownCloud-remove_existing_connection.png and /dev/null differ diff --git a/doc/images/setup/ownCloud-remove_existing_connection_confirmation_dialog.png b/doc/images/setup/ownCloud-remove_existing_connection_confirmation_dialog.png deleted file mode 100644 index c320d665b..000000000 Binary files a/doc/images/setup/ownCloud-remove_existing_connection_confirmation_dialog.png and /dev/null differ diff --git a/doc/images/setup/ownCloud-replacement_connection_wizard.png b/doc/images/setup/ownCloud-replacement_connection_wizard.png deleted file mode 100755 index 19b3096bf..000000000 Binary files a/doc/images/setup/ownCloud-replacement_connection_wizard.png and /dev/null differ diff --git a/doc/images/setup/remove.png b/doc/images/setup/remove.png new file mode 100644 index 000000000..1480c668a Binary files /dev/null and b/doc/images/setup/remove.png differ diff --git a/doc/images/setup/wizard.png b/doc/images/setup/wizard.png new file mode 100644 index 000000000..98cbf9617 Binary files /dev/null and b/doc/images/setup/wizard.png differ diff --git a/doc/index.rst b/doc/index.rst index cbf98807d..f0a8ff4f0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,7 @@ Nextcloud Desktop Client Manual introduction installing + visualtour navigating advancedusage autoupdate diff --git a/doc/navigating.rst b/doc/navigating.rst index bf6a2f9e2..8d690eab2 100644 --- a/doc/navigating.rst +++ b/doc/navigating.rst @@ -9,39 +9,39 @@ in the system tray (Windows, KDE), status bar (Mac OS X), or notification area (Linux). .. figure:: images/icon.png - :alt: Status icon, little cloud with green circle and white checkmark + :alt: Status icon, green circle and white checkmark The status indicator uses 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 Nextcloud server. .. figure:: images/icon-syncing.png - :alt: Status icon, little cloud with blue circle and white semi-circles + :alt: Status icon, blue circle and white semi-circles The blue icon with the white semi-circles means synchronization is in progress. .. figure:: images/icon-paused.png - :alt: Status icon, little cloud with yellow circle and vertical parallel + :alt: Status icon, yellow circle and vertical parallel lines The yellow icon with the parallel lines tells you your synchronization has been paused. (Most likely by you.) .. figure:: images/icon-offline.png - :alt: Status icon, little gray cloud with gray circle and three horizontal + :alt: Status icon, gray circle and three horizontal white dots The gray icon with three white dots means your sync client has lost its connection with your Nextcloud server. .. figure:: images/icon-information.png - :alt: Status icon, little cloud with letter "i" in white circle + :alt: Status icon, sign "!" in yellow circle -When you see a white circle with the letter "i" that is the informational icon, +When you see a yellow circle with the sign "!" that is the informational icon, so you should click it to see what it has to tell you. .. figure:: images/icon-error.png - :alt: Status icon, little cloud with red circle and white x + :alt: Status icon, red circle and white x The red circle with the white "x" indicates a configuration error, such as an incorrect login or server URL. @@ -69,7 +69,7 @@ This menu provides the following options: A left-click on your systray icon opens the desktop client to the account settings window. -.. figure:: images/client6.png +.. figure:: images/client-6.png :alt: Account settings window Configuring Nextcloud Account Settings @@ -209,7 +209,7 @@ 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/client12.png +.. figure:: images/client-12.png :alt: Activity window with notification. This also displays notifications sent to users by the Nextcloud admin via the