From f929d31f96ff34ccfac361df5bfb12c330112017 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 17 Nov 2022 14:34:58 +0100 Subject: [PATCH] Fix syntax issues Signed-off-by: Joas Schilling --- .../external_storage/auth_mechanisms.rst | 4 ++-- .../file_sharing_configuration.rst | 2 +- .../installation/source_installation.rst | 2 +- admin_manual/office/example-docker.rst | 6 ++---- developer_manual/digging_deeper/projects.rst | 20 ++++++++++--------- user_manual/groupware/sync_thunderbird.rst | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/admin_manual/configuration_files/external_storage/auth_mechanisms.rst b/admin_manual/configuration_files/external_storage/auth_mechanisms.rst index 225eb6aba..6716f3fb5 100644 --- a/admin_manual/configuration_files/external_storage/auth_mechanisms.rst +++ b/admin_manual/configuration_files/external_storage/auth_mechanisms.rst @@ -33,7 +33,7 @@ setup of the mount point. The **Log-in credentials, save in session** mechanism uses the Nextcloud login credentials of the user to connect to the storage. These are not stored anywhere on the server, but rather in the user session, giving increased security. -This method has some important drawbacks, since Nextcloud has no access to the storage +This method has some important drawbacks, since Nextcloud has no access to the storage credentials and therefore cannot perform any background tasks on the storage: * Sharing is disabled @@ -70,7 +70,7 @@ can be regenerated with a button in the GUI. After generating your keys, you need to copy your new public key to the destination server to ``.ssh/authorized_keys``. -See :doc:`sftp.rst` for additional information on how to set up certificate based authentication on SFTP. +See :doc:`./sftp` for additional information on how to set up certificate based authentication on SFTP. .. figure:: images/auth_rsa.png :alt: Form on admin page for generating RSA keys. diff --git a/admin_manual/configuration_files/file_sharing_configuration.rst b/admin_manual/configuration_files/file_sharing_configuration.rst index 495d3b564..f0f97fdb3 100644 --- a/admin_manual/configuration_files/file_sharing_configuration.rst +++ b/admin_manual/configuration_files/file_sharing_configuration.rst @@ -77,7 +77,7 @@ forcing them. `_ for discussion of this. .. note:: There are more sharing options on config.php level available: - :ref:`Configuration Parameters` + `Configuration Parameters `_ .. _transfer_userfiles_label: diff --git a/admin_manual/installation/source_installation.rst b/admin_manual/installation/source_installation.rst index 6e593609e..1978b1fb3 100644 --- a/admin_manual/installation/source_installation.rst +++ b/admin_manual/installation/source_installation.rst @@ -33,7 +33,7 @@ If you get a result, the module is present. Required: -* PHP (see :doc:`./system_requirements.rst` for a list of supported versions) +* PHP (see :doc:`./system_requirements` for a list of supported versions) * PHP module ctype * PHP module curl * PHP module dom diff --git a/admin_manual/office/example-docker.rst b/admin_manual/office/example-docker.rst index 7391c410a..53a3fef4a 100644 --- a/admin_manual/office/example-docker.rst +++ b/admin_manual/office/example-docker.rst @@ -40,9 +40,7 @@ On a recent Ubuntu or Debian this should be possible using: apt-get install apache2 a2enmod proxy proxy_wstunnel proxy_http ssl -Afterward, configure one VirtualHost properly to proxy the traffic. For security reason we recommend to use a subdomain such as office.example.com instead of running on the same domain. An example config can be found below: - -.. code-block:: apache2 +Afterward, configure one VirtualHost properly to proxy the traffic. For security reason we recommend to use a subdomain such as office.example.com instead of running on the same domain. An example config can be found below:: ######################################## # Reverse proxy for Collabora Online @@ -113,7 +111,7 @@ Update the docker image: List running docker containers: .. code-block:: bash - docker ps + docker ps Stop and remove the Collabora Online container with the container id of the running one: .. code-block:: bash diff --git a/developer_manual/digging_deeper/projects.rst b/developer_manual/digging_deeper/projects.rst index 5dd800659..f1cde9bc9 100644 --- a/developer_manual/digging_deeper/projects.rst +++ b/developer_manual/digging_deeper/projects.rst @@ -12,7 +12,7 @@ Register a resource provider Things like files, deck cards and talk rooms are called Resources in projects. In order to add your own resource type, we need to create a class implementing the -`OCP\Collaboration\Resources\IProvider` interface. +``OCP\Collaboration\Resources\IProvider`` interface. .. code-block:: php @@ -82,7 +82,7 @@ In order to add your own resource type, we need to create a class implementing t } -The `MyResourceProvider` class needs to be registered during the :ref:`app bootstrap`. +The ``MyResourceProvider`` class needs to be registered during the :ref:`app bootstrap`. .. code-block:: php @@ -128,14 +128,14 @@ As you can see we also already register a front-end script, which we are going t Provide a user interface ------------------------ -The user interface can be registered through the public `OCP.Collaboration.registerType` +The user interface can be registered through the public ``OCP.Collaboration.registerType`` JavaScript method. The first parameter represents the resource type that has already -been specified in the `IResourceProvider` implementation. The second parameter is an object with +been specified in the ``IResourceProvider`` implementation. The second parameter is an object with three properties: - * `typeString` A localized string that will be displayed in the dropdown when choosing which resource type to link to - * `typeIconClass` A CSS class of the icon that should be used for this entry - * `action` An async function that will produce a resource picker UI and resolves with the resource id + * ``typeString`` A localized string that will be displayed in the dropdown when choosing which resource type to link to + * ``typeIconClass`` A CSS class of the icon that should be used for this entry + * ``action`` An async function that will produce a resource picker UI and resolves with the resource id The following example shows how a Vue.js component could be used to render the widget user interface, however this approach works for any other framework as well @@ -181,6 +181,8 @@ we can simply dispatch it when we render our main page template. .. code-block:: php +
diff --git a/user_manual/groupware/sync_thunderbird.rst b/user_manual/groupware/sync_thunderbird.rst index 2dc3ce6eb..6059b5696 100644 --- a/user_manual/groupware/sync_thunderbird.rst +++ b/user_manual/groupware/sync_thunderbird.rst @@ -27,7 +27,7 @@ When they are installed, if you are on Windows, go to **Extras**/**Synchronisati Alternative: Using the CardBook add-on (Contacts only) ------------------------------------------------------ `CardBook `_ is an advanced alternative to Thunderbird's address book, which supports CardDAV. You can have TbSync and CardBook installed in parallel. - + 1. Click the CardBook icon in the upper right corner of Thunderbird: .. image:: ../images/cardbook_icon.png