mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-02 17:59:36 +07:00
Fix style-related punctuation
Based on the style that can be inferred from the current documentation, paragraphs should end in periods, except when followed by lists or examples in which case they should end in colons; list items should not use an ending period, except when the list items act themselves as paragraphs. Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
This commit is contained in:
@@ -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
|
||||
~~~~~~~~~~~~
|
||||
|
||||
@@ -19,7 +19,7 @@ setup and process of contribution is
|
||||
`documented here <https://github.com/nextcloud/android/blob/master/SETUP.md>`_.
|
||||
|
||||
You might want to start with doing one or two `starter issues <https://github.com/nextcloud/android/issues?q=is%3Aopen+is%3Aissue+label%3A%22starter+issue%22>`_
|
||||
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
|
||||
-------------------------
|
||||
|
||||
@@ -37,13 +37,13 @@ and add the dependency::
|
||||
|
||||
compile 'com.github.nextcloud:android-library:<version>'
|
||||
|
||||
<version> 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')
|
||||
<version> 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
|
||||
|
||||
@@ -11,7 +11,7 @@ Background/cron jobs are usually registered in the :file:`appinfo/app.php` by us
|
||||
<?php
|
||||
\OCP\Backgroundjob::addRegularTask('\OCA\MyApp\Cron\SomeTask', 'run');
|
||||
|
||||
The class for the above example would live in :file:`cron/sometask.php`. Try to keep the method as small as possible because its hard to test static methods. Simply reuse the app container and execute a service that was registered in it.
|
||||
The class for the above example would live in :file:`cron/sometask.php`. Try to keep the method as small as possible because its hard to test static methods. Simply reuse the app container and execute a service that was registered in it:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ Hooks are used to execute code before or after an event has occurred. This is fo
|
||||
$app = new Application();
|
||||
$app->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
|
||||
|
||||
|
||||
@@ -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 <http://php.net/manual/en/function.get-loaded-extensions.php>`_.
|
||||
The explicit version of an extension is read from `phpversion <http://php.net/manual/de/function.phpversion.php>`_ - with some exception as to be read up in the `code base <https://github.com/nextcloud/server/blob/master/lib/private/App/PlatformRepository.php>`_
|
||||
The explicit version of an extension is read from `phpversion <http://php.net/manual/de/function.phpversion.php>`_ - with some exception as to be read up in the `code base <https://github.com/nextcloud/server/blob/master/lib/private/App/PlatformRepository.php>`_.
|
||||
|
||||
os
|
||||
==
|
||||
|
||||
@@ -8,7 +8,7 @@ Nextcloud's translation system is powered by `Transifex <https://www.transifex.c
|
||||
|
||||
PHP
|
||||
===
|
||||
Should it ever be needed to use localized strings on the server-side, simply inject the L10N service from the ServerContainer into the needed constructor
|
||||
Should it ever be needed to use localized strings on the server-side, simply inject the L10N service from the ServerContainer into the needed constructor:
|
||||
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
@@ -54,7 +54,7 @@ Approved apps are developed by trusted developers and have passed a cursory secu
|
||||
|
||||
Requirements:
|
||||
|
||||
* code is developed in an open and version-managed code repository, ideally GitHub with Git but other SCM/hosting is OK.
|
||||
* code is developed in an open and version-managed code repository, ideally GitHub with Git but other SCM/hosting is OK
|
||||
* minimum of one active developer/maintainer
|
||||
* minimum 5 ratings, average score 60/100 or better
|
||||
* app is at least 3 months old
|
||||
@@ -91,9 +91,9 @@ Requirements:
|
||||
|
||||
App store:
|
||||
|
||||
* show up in Apps page provided user has enabled "allow installation of experimental apps" in the settings.
|
||||
* Warning about security and stability risks is shown for app
|
||||
* sorted below all others.
|
||||
* show up in Apps page provided user has enabled "allow installation of experimental apps" in the settings
|
||||
* warning about security and stability risks is shown for app
|
||||
* sorted below all others
|
||||
|
||||
Getting an app approved
|
||||
-----------------------
|
||||
@@ -124,7 +124,7 @@ These are the app guidelines an app has to comply with to have a chance to be ap
|
||||
Legal and security
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* Apps can not use 'Nextcloud' in their name
|
||||
* Apps can not use 'Nextcloud' in their name.
|
||||
* Irregular and unannounced security audits of all apps can and will take place.
|
||||
* If any indication of malicious intent or bad faith is found the developer(s) in question can count on a minimum 2 year ban from any Nextcloud infrastructure.
|
||||
* Malicious intent includes deliberate spying on users by leaking user data to a third party system or adding a back door (like a hard-coded user account) to Nextcloud. An unintentional security bug that gets fixed in time won't be considered bad faith.
|
||||
@@ -136,16 +136,16 @@ Legal and security
|
||||
Be technically sound
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* Apps can only use the public Nextcloud API
|
||||
* At time of the release of an app it can only be configured to be compatible with the latest Nextcloud release +1
|
||||
* Apps should not cause Nextcloud to break, consume excessive memory or slow Nextcloud down
|
||||
* Apps should not hamper functionality of Nextcloud unless that is explicitly the goal of the app
|
||||
* Apps can only use the public Nextcloud API.
|
||||
* At time of the release of an app it can only be configured to be compatible with the latest Nextcloud release +1.
|
||||
* Apps should not cause Nextcloud to break, consume excessive memory or slow Nextcloud down.
|
||||
* Apps should not hamper functionality of Nextcloud unless that is explicitly the goal of the app.
|
||||
|
||||
Respect the users
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
* 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 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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -12,7 +12,7 @@ Then create a skeleton app in the `app store <https://apps.nextcloud.com/develop
|
||||
|
||||
Enable the app
|
||||
--------------
|
||||
The app can now be enabled on the Nextcloud apps page
|
||||
The app can now be enabled on the Nextcloud apps page.
|
||||
|
||||
App architecture
|
||||
----------------
|
||||
|
||||
@@ -28,7 +28,7 @@ Triaging follows these steps:
|
||||
|
||||
* Find an issue somebody should look at
|
||||
* Be that somebody and see if the issue content is useful for a developer
|
||||
* Reply and close, ask a question, add information or a label.
|
||||
* Reply and close, ask a question, add information or a label
|
||||
* Find the next bug-to-be-dealt-with and repeat!
|
||||
|
||||
General considerations
|
||||
|
||||
@@ -11,7 +11,7 @@ Communicate via our `forums <https://help.nextcloud.com>`_.
|
||||
|
||||
IRC channels
|
||||
------------
|
||||
Chat with us on `IRC <http://www.irchelp.org/>`_. All channels are on **irc.freenode.net**
|
||||
Chat with us on `IRC <http://www.irchelp.org/>`_. All channels are on **irc.freenode.net**:
|
||||
|
||||
* Setup: **#nextcloud**
|
||||
* Development: **#nextcloud-dev**
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
----------------
|
||||
|
||||
@@ -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
|
||||
-------------------
|
||||
|
||||
@@ -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
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Reference in New Issue
Block a user