Kaynağa Gözat

Documentation. Fix incorrect syntax warnings and incorrect indentation before image elements.

Signed-off-by: allexzander <blackslayer4@gmail.com>
allexzander 4 yıl önce
ebeveyn
işleme
21d39dea87
5 değiştirilmiş dosya ile 16 ekleme ve 14 silme
  1. 3 0
      doc/architecture.rst
  2. 4 4
      doc/building.rst
  3. 8 8
      doc/installing.rst
  4. 1 1
      doc/nextcloudcmd.rst
  5. 0 1
      doc/options.rst

+ 3 - 0
doc/architecture.rst

@@ -418,11 +418,13 @@ The VFS does not occupy much space on the user's storage. It just creates placeh
 
 One will see a hydration (in other words - file download) process when double-clicking on a file that must become available. There will be a progress-bar popup displayed if the file is large enough. So, the hydration process can be observed and it makes it easy to then find out, how long, it would take to fetch the actual file from the server.
 The "Hydration" can be thought of as "downloading" or "fetching" the file contents. As soon as hydration is complete, the file will then be opened normally as now it is a real file on the user's storage. It won't disappear, and, from now on, will always be available, unless it is manually dehydrated.
+
 .. image:: images/vfs_hydration_progress_bar.png
    :alt: VFS hydration progress bar
 
 As long as the VFS is enabled, a user can choose to remove files that are no longer needed from the local storage. This can be achieved by right-clicking the file/folder in the explorer, and then, choosing "Free up local space" from the context menu.
 Alternatively, space can be freed up by right-clicking the sync folder in the Settings dialog. It is also possible to make files always hydrated, or, in other words, always available locally. A user just needs to choose the "Make always available locally" option in the aforementioned context menus.
+
 .. image:: images/vfs_context_menu_options.png
    :alt: VFS context menu options
 
@@ -438,5 +440,6 @@ User Status
 
 Starting from 3.2.0, user status is displayed in the Nextcloud desktop client's tray window. The icon and a text message are displayed as long as those are set in the user's account menu in the Web UI (server's website). At the moment, setting the status from the desktop client is not available.
 The status is updated almost immediately after it is set in the Web UI. Default user status is always "Online" if no other status is available from the server-side.
+
 .. image:: images/status_feature_example.png
    :alt: User Status feature in the tray window

+ 4 - 4
doc/building.rst

@@ -184,9 +184,9 @@ Then, in Terminal:
       
    .. code-block:: bash
 
-        % echo 'export CMAKE_INSTALL_PREFIX=~/Builds' >> ~/.nextcloud_build_variables
+      % echo 'export CMAKE_INSTALL_PREFIX=~/Builds' >> ~/.nextcloud_build_variables
       
-      Replace ``~/Builds`` with a different directory if you'd like the build to end up elsewhere.
+   Replace ``~/Builds`` with a different directory if you'd like the build to end up elsewhere.
    
 ..
 
@@ -218,7 +218,7 @@ follow `Windows Installer Build (Cross-Compile)`_ instead.
 2. Get the QtKeychain_ sources as well as the latest versions of the Nextcloud client
    from Git as follows
 
-   .. code-block::
+   .. code-block:: bash
    
       git clone https://github.com/frankosterfeld/qtkeychain.git
       git clone git://github.com/nextcloud/client.git
@@ -259,7 +259,7 @@ follow `Windows Installer Build (Cross-Compile)`_ instead.
 .. _`Windows Installer Build (Cross-Compile)`:
 
 Windows Installer (i.e. Deployment) Build (Cross-Compile)
----------------------------------------
+---------------------------------------------------------
 
 Due to the large number of dependencies, building the client installer for Windows
 is **currently only officially supported on openSUSE**, by using the MinGW cross compiler.

+ 8 - 8
doc/installing.rst

@@ -86,17 +86,17 @@ If you for instance want to install everything but the ``DesktopShortcut`` and t
 
 1. You explicitly name all the features you actually want to install (whitelist) where `Client` is always installed anyway::
 
-  msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT=StartMenuShortcuts
+    msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT=StartMenuShortcuts
 
 2. You pass the `NO_DESKTOP_SHORTCUT` and `NO_SHELL_EXTENSIONS` properties::
 
-  msiexec /passive /i Nextcloud-x.y.z-x64.msi NO_DESKTOP_SHORTCUT="1" NO_SHELL_EXTENSIONS="1"
+    msiexec /passive /i Nextcloud-x.y.z-x64.msi NO_DESKTOP_SHORTCUT="1" NO_SHELL_EXTENSIONS="1"
 
 .. NOTE::
-The Nextcloud `.msi` remembers these properties, so you don't need to specify them on upgrades.
+    The Nextcloud `.msi` remembers these properties, so you don't need to specify them on upgrades.
 
 .. NOTE::
-You cannot use these to change the installed features, if you want to do that, see the next section.
+    You cannot use these to change the installed features, if you want to do that, see the next section.
 
 Changing Installed Features
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -105,11 +105,11 @@ You can change the installed features later by using `REMOVE` and `ADDDEFAULT` p
 
 1. If you want to add the the desktop shortcut later, run the following command::
 
-  msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT="DesktopShortcut"
+    msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT="DesktopShortcut"
 
 2. If you want to remove it, simply run the following command::
 
-  msiexec /passive /i Nextcloud-x.y.z-x64.msi REMOVE="DesktopShortcut"
+    msiexec /passive /i Nextcloud-x.y.z-x64.msi REMOVE="DesktopShortcut"
 
 Windows keeps track of the installed features and using `REMOVE` or `ADDDEFAULT` will only affect the mentioned features.
 
@@ -118,7 +118,7 @@ and `ADDDEFAULT <https://msdn.microsoft.com/en-us/library/windows/desktop/aa3675
 on the Windows Installer Guide.
 
 .. NOTE::
-You cannot specify `REMOVE` on initial installation as it will disable all features.
+    You cannot specify `REMOVE` on initial installation as it will disable all features.
 
 Installation Folder
 ^^^^^^^^^^^^^^^^^^^
@@ -150,7 +150,7 @@ This option also removes the checkbox to let users decide if they want to launch
 for non passive/quiet mode.
 
 .. NOTE::
-This option does not have any effect without GUI.
+    This option does not have any effect without GUI.
 
 No Reboot After Installation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+ 1 - 1
doc/nextcloudcmd.rst

@@ -10,7 +10,7 @@ monitor for file system changes.
 
 
 Install ``nextcloudcmd``
-~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 CentOS
 

+ 0 - 1
doc/options.rst

@@ -26,7 +26,6 @@ The other options are:
 
 ``--logdebug``
         Also output debug-level messages in the log (equivalent to setting the env var QT_LOGGING_RULES="qt.*=true;*.debug=true").
-)
 
 ``--confdir`` `<dirname>`
         Uses the specified configuration directory.