diff --git a/developer_manual/android_library/examples.rst b/developer_manual/android_library/examples.rst index 3b3d31af2..d9be7cbc6 100644 --- a/developer_manual/android_library/examples.rst +++ b/developer_manual/android_library/examples.rst @@ -286,7 +286,7 @@ Read shared items by link ------------------------- Get information about what files and folder are shared by link (the object -mClient contains the information about the server URL and account) +mClient contains the information about the server URL and account). Code example ~~~~~~~~~~~~ diff --git a/developer_manual/android_library/index.rst b/developer_manual/android_library/index.rst index e203028a5..474ef61ee 100644 --- a/developer_manual/android_library/index.rst +++ b/developer_manual/android_library/index.rst @@ -19,7 +19,7 @@ setup and process of contribution is `documented here `_. You might want to start with doing one or two `starter issues `_ -to get into the code and note our :doc:`../general/index` +to get into the code and note our :doc:`../general/index`. Nextcloud Android Library ------------------------- diff --git a/developer_manual/android_library/library_installation.rst b/developer_manual/android_library/library_installation.rst index 88042c0b1..a6d2c5961 100644 --- a/developer_manual/android_library/library_installation.rst +++ b/developer_manual/android_library/library_installation.rst @@ -37,13 +37,13 @@ and add the dependency:: compile 'com.github.nextcloud:android-library:' - refers to the exact version you would like to include in your application. This could be -SNAPSHOT for always using the latest code revision of the master branch. Alternatively you can also specifiy a version number which refers to a fixed release, e.g. 1.0.0. (compile 'com.github.nextcloud:android-library:1.0.0') + refers to the exact version you would like to include in your application. This could be -SNAPSHOT for always using the latest code revision of the master branch. Alternatively you can also specifiy a version number which refers to a fixed release, e.g. 1.0.0. (compile 'com.github.nextcloud:android-library:1.0.0'). Add the library project to your project as a Git submodule ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Basically get the code and compile it having it integrated via a Git submodule +Basically get the code and compile it having it integrated via a Git submodule. Go into your own apps directory on the command line and add the Nextcloud Android library as a submodule:: git submodule add https://github.com/nextcloud/android-library nextcloud-android-library diff --git a/developer_manual/app/backgroundjobs.rst b/developer_manual/app/backgroundjobs.rst index 032a24296..125a8ccd0 100644 --- a/developer_manual/app/backgroundjobs.rst +++ b/developer_manual/app/backgroundjobs.rst @@ -11,7 +11,7 @@ Background/cron jobs are usually registered in the :file:`appinfo/app.php` by us getContainer()->query('UserHooks')->register(); -The hook logic should be in a separate class that is being registered in the :doc:`container` +The hook logic should be in a separate class that is being registered in the :doc:`container`: .. code-block:: php diff --git a/developer_manual/app/info.rst b/developer_manual/app/info.rst index d32e90144..9857a269f 100644 --- a/developer_manual/app/info.rst +++ b/developer_manual/app/info.rst @@ -175,7 +175,7 @@ specified. Valid values for the 'os' attribute are as returned by the PHP functi lib === Defines a required PHP extension with required minimum and/or maximum version. The names for the libraries have to match the result as returned by the PHP function `get_loaded_extensions `_. -The explicit version of an extension is read from `phpversion `_ - with some exception as to be read up in the `code base `_ +The explicit version of an extension is read from `phpversion `_ - with some exception as to be read up in the `code base `_. os == diff --git a/developer_manual/app/l10n.rst b/developer_manual/app/l10n.rst index 45d903a00..3fccb8f05 100644 --- a/developer_manual/app/l10n.rst +++ b/developer_manual/app/l10n.rst @@ -8,7 +8,7 @@ Nextcloud's translation system is powered by `Transifex `_ -* Apps correctly clean up after themselves on uninstall and correctly handle up- and downgrades +* Apps have to follow design and `HTML/CSS layout guidelines <../app/css.html>`_. +* Apps correctly clean up after themselves on uninstall and correctly handle up- and downgrades. * Apps clearly communicate their intended purpose and active features, including features introduced through updates. * Apps respect the users' choices and do not make unexpected changes, or limit users' ability to revert them. For example, they do not remove other apps or disable settings. * Apps must respect user privacy. IF user data is sent anywhere, this must be clearly explained and be kept to a minimum for the functioning of an app. Use proper security measures when needed. diff --git a/developer_manual/app/settings.rst b/developer_manual/app/settings.rst index 3a8e0351e..d91f65e9d 100644 --- a/developer_manual/app/settings.rst +++ b/developer_manual/app/settings.rst @@ -17,7 +17,7 @@ related to sharing. Settings Form ============= -For the settings form, three things are necessary +For the settings form, three things are necessary: 1. A class implementing ``\OCP\Settings\ISettings`` 2. A template diff --git a/developer_manual/app/startapp.rst b/developer_manual/app/startapp.rst index afeef7713..af12d1a2a 100644 --- a/developer_manual/app/startapp.rst +++ b/developer_manual/app/startapp.rst @@ -12,7 +12,7 @@ Then create a skeleton app in the `app store `_. IRC channels ------------ -Chat with us on `IRC `_. All channels are on **irc.freenode.net** +Chat with us on `IRC `_. All channels are on **irc.freenode.net**: * Setup: **#nextcloud** * Development: **#nextcloud-dev** diff --git a/developer_manual/core/ocs-share-api.rst b/developer_manual/core/ocs-share-api.rst index d2f47989f..dd40a0110 100644 --- a/developer_manual/core/ocs-share-api.rst +++ b/developer_manual/core/ocs-share-api.rst @@ -43,7 +43,7 @@ Get all shares from a given file/folder. * Result: XML with the shares -Statuscodes +Statuscodes: * 100 - successful * 400 - not a directory (if the 'subfile' argument was used) diff --git a/developer_manual/core/theming.rst b/developer_manual/core/theming.rst index e583debb5..263797784 100644 --- a/developer_manual/core/theming.rst +++ b/developer_manual/core/theming.rst @@ -29,10 +29,10 @@ Creating and activating a new theme =================================== There are two basic ways of creating new themings: -* Doing all new from scratch -* Starting from an existing theme or the example theme and doing everything step by step and more experimentally +* doing all new from scratch +* starting from an existing theme or the example theme and doing everything step by step and more experimentally -Depending on how you created your new theme it will be necessary to +Depending on how you created your new theme it will be necessary to: * put a new theme into the /themes folder. The theme can be activated by putting ``'theme' => 'MyTheme'`` into the ``/config/config.php`` file. * make your changes in the ``/themes/MyTheme`` folder @@ -99,10 +99,10 @@ The (main) pictures that can be found inside Nextcloud standard theming are the Inserting your new logo ----------------------- Inserting a new logo into an existing theme is as simple as replacing the old logo with the new (generated) one. -You can use: scalable vector graphics (.svg) or common graphics formats for the Internet such as portable network graphics (.png) or .jpeg +You can use: scalable vector graphics (.svg) or common graphics formats for the Internet such as portable network graphics (.png) or .jpeg. Just insert the new created picture by using the unchanged name of the old picture. -The app icons can also be overwritten in a theme. To change for example the app icon of the activity app you need to overwrite it by saving the new image to …/nextcloud/themes/default/apps/activity/img/activity.svg +The app icons can also be overwritten in a theme. To change for example the app icon of the activity app you need to overwrite it by saving the new image to …/nextcloud/themes/default/apps/activity/img/activity.svg. Changing favicon ---------------- diff --git a/developer_manual/core/translation.rst b/developer_manual/core/translation.rst index bc9353a26..6ca36a66a 100644 --- a/developer_manual/core/translation.rst +++ b/developer_manual/core/translation.rst @@ -84,7 +84,7 @@ Manual quick translation update: cd l10n/ && perl l10n.pl read && tx push -s && tx pull -a && perl l10n.pl write && cd .. -The translation script requires Locale::PO, installable via ``apt-get install liblocale-po-perl`` +The translation script requires Locale::PO, installable via ``apt-get install liblocale-po-perl``. Configure Transifex ------------------- diff --git a/developer_manual/core/unit-testing.rst b/developer_manual/core/unit-testing.rst index 0e8747b40..7e501bd28 100644 --- a/developer_manual/core/unit-testing.rst +++ b/developer_manual/core/unit-testing.rst @@ -34,7 +34,7 @@ Writing PHP unit tests To get started, do the following: - Create a directory called ``tests`` in the top level of your application - - Create a PHP file in the directory and ``require_once`` your class which you want to test. + - Create a PHP file in the directory and ``require_once`` your class which you want to test Then you can simply run the created test with phpunit. @@ -95,7 +95,7 @@ Bootstrapping Nextcloud ~~~~~~~~~~~~~~~~~~~~~~~ If you use Nextcloud functions or classes in your code, you'll need to make them available to your test by bootstrapping Nextcloud. -To do this, you'll need to provide the ``--bootstrap`` argument when running PHPUnit +To do this, you'll need to provide the ``--bootstrap`` argument when running PHPUnit: :file:`/srv/http/nextcloud`:: @@ -177,9 +177,9 @@ Every time you reload the page, the unit tests will be relaunched and will outpu Unit test paths ~~~~~~~~~~~~~~~ -JavaScript unit test examples can be found in :file:`apps/files/tests/js/` +JavaScript unit test examples can be found in :file:`apps/files/tests/js/`. -Unit tests for the core app JavaScript code can be found in :file:`core/js/tests/specs` +Unit tests for the core app JavaScript code can be found in :file:`core/js/tests/specs`. Documentation ~~~~~~~~~~~~~