From 80234e56a5ab75e9969647f8aa8fb46920458134 Mon Sep 17 00:00:00 2001 From: Christian Wolf Date: Thu, 25 Nov 2021 17:12:47 +0100 Subject: [PATCH] Removed issues in developer manual Signed-off-by: Christian Wolf --- .../app_development/bootstrap.rst | 2 +- developer_manual/basics/front-end/l10n.rst | 2 +- .../basics/front-end/templates.rst | 5 +- .../client_apis/OCS/ocs-status-api.rst | 41 +++++--- .../client_apis/WebDAV/comments.rst | 97 +++++++++---------- developer_manual/conf.py | 2 +- developer_manual/design/introduction.rst | 2 - developer_manual/design/layoutcomponents.rst | 2 - developer_manual/how_to/index.rst | 2 +- developer_manual/html_css_design/content.rst | 1 - developer_manual/html_css_design/list.rst | 1 - .../html_css_design/navigation.rst | 5 - requirements.txt | 1 + 13 files changed, 80 insertions(+), 83 deletions(-) diff --git a/developer_manual/app_development/bootstrap.rst b/developer_manual/app_development/bootstrap.rst index b1d13b8f8..889f7b557 100644 --- a/developer_manual/app_development/bootstrap.rst +++ b/developer_manual/app_development/bootstrap.rst @@ -102,7 +102,7 @@ Nextcloud 20 and later Nextcloud 20 is the first release with the interface ``\OCP\AppFramework\Bootstrap\IBootstrap``. This interface can be implemented by your app's ``Application`` class to signal that it wants to act on the bootstrapping stages. The major difference between this and the old process is that the boostrapping is not performed in sequence, but apps register and boot -interleaved. This should ensure that an app that ``boot``s can rely on all other apps' registration to be finished. +interleaved. This should ensure that an app that ``boot``\s can rely on all other apps' registration to be finished. The overall process is as follows: diff --git a/developer_manual/basics/front-end/l10n.rst b/developer_manual/basics/front-end/l10n.rst index 3ab48827b..ad312fe6e 100644 --- a/developer_manual/basics/front-end/l10n.rst +++ b/developer_manual/basics/front-end/l10n.rst @@ -209,7 +209,7 @@ As a small help, the file in question as well as the line of code is written in **Android Strings** -.. code-block:: Android +.. code-block:: xml Boards diff --git a/developer_manual/basics/front-end/templates.rst b/developer_manual/basics/front-end/templates.rst index f6078928c..22df685b7 100644 --- a/developer_manual/basics/front-end/templates.rst +++ b/developer_manual/basics/front-end/templates.rst @@ -13,9 +13,9 @@ can be accessed through:: $_['key'] -.. note:: To prevent XSS the following PHP **functions for printing are forbidden: echo, print() and - - 5 - 0 - 2016-01-18 22:10:30 - -``` +.. code-block:: xml + + + + 5 + 0 + 2016-01-18 22:10:30 + + Example Output (without headers): -``` - - - - - 3 - 0 - 0 - 0 - first - comment - users - master - files - 2156 - 2016-01-18 22:01:16 - 2016-01-20 14:01:24 - - - - - 2 - 0 - 0 - 0 - first - comment - users - master - files - 2156 - 2016-01-18 22:01:12 - 2016-01-20 14:01:24 - - - -``` +.. code-block:: xml + + + + + + 3 + 0 + 0 + 0 + first + comment + users + master + files + 2156 + 2016-01-18 22:01:16 + 2016-01-20 14:01:24 + + + + + 2 + 0 + 0 + 0 + first + comment + users + master + files + 2156 + 2016-01-18 22:01:12 + 2016-01-20 14:01:24 + + + If you want a real life example of use, the announcement center has comments implemented. See the comments related files in `https://github.com/nextcloud/announcementcenter/tree/master/js` diff --git a/developer_manual/conf.py b/developer_manual/conf.py index fd43c341a..40018c860 100644 --- a/developer_manual/conf.py +++ b/developer_manual/conf.py @@ -29,7 +29,7 @@ from conf import * # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx'] +extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx', 'sphinxcontrib.phpdomain'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../_shared_assets/templates'] diff --git a/developer_manual/design/introduction.rst b/developer_manual/design/introduction.rst index 1260e42ec..74b4c9309 100644 --- a/developer_manual/design/introduction.rst +++ b/developer_manual/design/introduction.rst @@ -1,7 +1,5 @@ .. _navigation: -.. _newbutton: - ============ Introduction ============ diff --git a/developer_manual/design/layoutcomponents.rst b/developer_manual/design/layoutcomponents.rst index 3fe470e56..f26bdbcb6 100644 --- a/developer_manual/design/layoutcomponents.rst +++ b/developer_manual/design/layoutcomponents.rst @@ -3,8 +3,6 @@ Layout components All Nextcloud apps are built using individual reusable components for consistency and efficiency. Currently, these components are written in Vue and can be found at the `nextcloud-vue repository on Github `_ with the documentation available at `the Nextcloud Vue components style guide `_. -.. _Navigation: - Navigation ---------- diff --git a/developer_manual/how_to/index.rst b/developer_manual/how_to/index.rst index 73f16007a..720b29f2f 100644 --- a/developer_manual/how_to/index.rst +++ b/developer_manual/how_to/index.rst @@ -169,7 +169,7 @@ Test with Nextcloud WebAuthn without SSL -------------------- -`Chrome has the option to test WebAuthn with a fake device.`_ Browsers support WebAuthn on HTTPS protected sites and localhost domains. Unfortunately this is not supported by the used PHP library where the check for HTTPS needs to be commented for testing on non-HTTPS localhost development environments. +`Chrome has the option to test WebAuthn with a fake device `__. Browsers support WebAuthn on HTTPS protected sites and localhost domains. Unfortunately this is not supported by the used PHP library where the check for HTTPS needs to be commented for testing on non-HTTPS localhost development environments. :: diff --git a/developer_manual/html_css_design/content.rst b/developer_manual/html_css_design/content.rst index ba1b774cb..7d3406eb6 100644 --- a/developer_manual/html_css_design/content.rst +++ b/developer_manual/html_css_design/content.rst @@ -1,6 +1,5 @@ .. sectionauthor:: John Molakvoæ .. codeauthor:: John Molakvoæ -.. _content: ============ Main content diff --git a/developer_manual/html_css_design/list.rst b/developer_manual/html_css_design/list.rst index ff1c78e78..8c2873f3f 100644 --- a/developer_manual/html_css_design/list.rst +++ b/developer_manual/html_css_design/list.rst @@ -1,6 +1,5 @@ .. sectionauthor:: John Molakvoæ .. codeauthor:: John Molakvoæ -.. _list: ============= Content list diff --git a/developer_manual/html_css_design/navigation.rst b/developer_manual/html_css_design/navigation.rst index d5f80c2f5..d25b580a1 100644 --- a/developer_manual/html_css_design/navigation.rst +++ b/developer_manual/html_css_design/navigation.rst @@ -1,8 +1,5 @@ .. sectionauthor:: John Molakvoæ .. codeauthor:: John Molakvoæ -.. _navigation: - -.. _newbutton: =============== Introduction @@ -464,8 +461,6 @@ Various information * You can add the ``icon-loading-small`` class to any ``li`` element to set it in a `loading` state. * Every element as a ``min-height`` of 44px as that is the minimum recommended touch target. It also helps with clickability and separation on desktop environments. -.. _settings: - ========= Settings ========= diff --git a/requirements.txt b/requirements.txt index 88cbdd574..30d48610d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,3 +2,4 @@ sphinx rst2pdf pillow sphinx-rtd-theme +sphinxcontrib-phpdomain