mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-02 17:59:36 +07:00
Merge branch 'master' into fixheaderandfooter
This commit is contained in:
Jos Poortvliet
@@ -536,6 +536,7 @@ nav a {
|
||||
padding-left: 0;
|
||||
animation: fadeInRight .5s ease forwards;
|
||||
pointer-events: none; } }
|
||||
}
|
||||
@keyframes fadeInRight {
|
||||
0% {
|
||||
opacity: 0;
|
||||
@@ -549,9 +550,6 @@ nav a {
|
||||
.nav {
|
||||
padding-bottom: 70px;
|
||||
transition: all .2s ease-in; }
|
||||
@media (max-width: 992px) {
|
||||
.nav {
|
||||
padding-bottom: 20px; } }
|
||||
.nav.no-shadow {
|
||||
box-shadow: none !important; }
|
||||
.nav.scrolled {
|
||||
|
||||
@@ -92,17 +92,17 @@ during installation and update, so you shouldn't need to change it.
|
||||
|
||||
::
|
||||
|
||||
'dbtype' => 'sqlite',
|
||||
'dbtype' => 'sqlite3',
|
||||
|
||||
Identifies the database used with this installation. See also config option
|
||||
``supportedDatabases``
|
||||
|
||||
Available:
|
||||
- sqlite (SQLite3)
|
||||
- sqlite3 (SQLite3)
|
||||
- mysql (MySQL/MariaDB)
|
||||
- pgsql (PostgreSQL)
|
||||
|
||||
Defaults to ``sqlite``
|
||||
Defaults to ``sqlite3``
|
||||
|
||||
::
|
||||
|
||||
@@ -910,6 +910,8 @@ Some of the Nextcloud code may be stored in alternate locations.
|
||||
'https://play.google.com/store/apps/details?id=com.nextcloud.client',
|
||||
'customclient_ios' =>
|
||||
'https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8',
|
||||
'customclient_ios_appid' =>
|
||||
'1125420102',
|
||||
|
||||
This section is for configuring the download links for Nextcloud clients, as
|
||||
seen in the first-run wizard and on Personal pages.
|
||||
@@ -917,7 +919,8 @@ seen in the first-run wizard and on Personal pages.
|
||||
Defaults to
|
||||
* Desktop client: ``https://nextcloud.com/install/#install-clients``
|
||||
* Android client: ``https://play.google.com/store/apps/details?id=com.nextcloud.client``
|
||||
* iOS client : ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8``
|
||||
* iOS client: ``https://itunes.apple.com/us/app/nextcloud/id1125420102?mt=8``
|
||||
*iOS client app id: ``1125420102``
|
||||
|
||||
Apps
|
||||
----
|
||||
@@ -1378,6 +1381,29 @@ to be fetched in addition to any requested file.
|
||||
|
||||
One way to test is applying for a trystack account at http://trystack.org/
|
||||
|
||||
::
|
||||
|
||||
'objectstore' => [
|
||||
'class' => 'OC\\Files\\ObjectStore\\Swift',
|
||||
'arguments' => [
|
||||
'autocreate' => true,
|
||||
'user' => [
|
||||
'name' => 'swift',
|
||||
'password' => 'swift',
|
||||
'domain' => [
|
||||
'name' => 'default',
|
||||
],
|
||||
],
|
||||
'tenantName' => 'service',
|
||||
'serviceName' => 'swift',
|
||||
'region' => 'regionOne',
|
||||
'url' => "http://yourswifthost:5000/v3",
|
||||
'bucket' => 'nextcloud',
|
||||
],
|
||||
],
|
||||
|
||||
To use swift V3
|
||||
|
||||
Sharing
|
||||
-------
|
||||
|
||||
|
||||
@@ -519,7 +519,6 @@ Encryption
|
||||
disable it again.
|
||||
encryption:encrypt-all Encrypt all files for all users
|
||||
encryption:list-modules List all available encryption modules
|
||||
encryption:migrate initial migration to encryption 2.0
|
||||
encryption:set-default-module Set the encryption default module
|
||||
encryption:show-key-storage-root Show current key storage root
|
||||
encryption:status Lists the current status of encryption
|
||||
@@ -574,9 +573,6 @@ single-sign on. Use this only on fresh installations with no existing data, or
|
||||
on systems where encryption has not already been enabled. It is not possible to
|
||||
disable it.
|
||||
|
||||
``encryption:migrate`` migrates encryption keys after a major Nextcloud version
|
||||
upgrade. You may optionally specify individual users in a space-delimited list.
|
||||
|
||||
See :doc:`../configuration_files/encryption_configuration` to learn more.
|
||||
|
||||
.. _federation_sync_label:
|
||||
|
||||
@@ -21,6 +21,9 @@ If access to a file has been denied for a user, the user can not:
|
||||
|
||||
Examples
|
||||
--------
|
||||
After installing the File Access Control app as described in
|
||||
:doc:`../installation/apps_management_installation`
|
||||
navigate to the configuration and locate the File Access Control settings.
|
||||
|
||||
.. figure:: images/files_access_control_sample_rules.png
|
||||
:alt: Sample rules to block on user group, time and IP base.
|
||||
|
||||
@@ -15,11 +15,17 @@ This is especially useful for retention and :doc:`access_control`, so people
|
||||
that got the files shared can not remove the tag to stop the retention or
|
||||
allow access against the owners will.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
After installing the Files automated tagging app as described in
|
||||
:doc:`../installation/apps_management_installation`
|
||||
navigate to the configuration and locate the Workflow settings.
|
||||
|
||||
.. figure:: images/automated_tagging_sample_rule.png
|
||||
:alt: Sample rule to assign a restricted tag.
|
||||
:alt: Example rule to assign a restricted tag.
|
||||
|
||||
In the sample you can see a simple rule with only one condition.
|
||||
In the example you can see a simple rule with only one condition.
|
||||
It will tag all files with the restricted tag ``Protected file`` that are
|
||||
uploaded into a folder that is tagged with ``Protect content``. No user can
|
||||
remove the tag ``Protected file`` and therefor access control and retention
|
||||
@@ -29,3 +35,10 @@ Available rules
|
||||
---------------
|
||||
|
||||
The available rules can be seen in the access control section: :ref:`available-rules-label`.
|
||||
|
||||
Executing actions
|
||||
-----------------
|
||||
|
||||
It is possible to execute actions like ```convert to PDF``` based on assigned tags. Nextcloud
|
||||
GmbH assists customers in this with hands-on help and documentation on our
|
||||
`customer portal <https://portal.nextcloud.com>`_.
|
||||
|
||||
@@ -5,13 +5,17 @@ Retention of files
|
||||
Nextcloud's Files Retention app allows to automatically delete files that
|
||||
are tagged with a collaborative tag and have a certain age.
|
||||
|
||||
Sample
|
||||
------
|
||||
Example
|
||||
-------
|
||||
|
||||
After installing the Retention app as described in
|
||||
:doc:`../installation/apps_management_installation`
|
||||
navigate to the configuration and locate the Workflow settings.
|
||||
|
||||
.. figure:: images/retention_sample.png
|
||||
:alt: Sample rule to delete files after 14 days.
|
||||
|
||||
The rule from the sample will delete all files tagged with ``Temporary file`` after 14 days.
|
||||
The rule from the example will delete all files tagged with ``Temporary file`` after 14 days.
|
||||
|
||||
Common misconfigurations
|
||||
------------------------
|
||||
|
||||
@@ -451,6 +451,14 @@ confirm your paths, for example::
|
||||
If any of your system environment variables are not present in the file then
|
||||
you must add them.
|
||||
|
||||
Alternatively it is possible to use the environemt variables of your system by modifying
|
||||
|
||||
/etc/php/7.0/fpm/pool.d/www.conf
|
||||
|
||||
and uncommenting the line
|
||||
|
||||
clear_env = no
|
||||
|
||||
When you are using shared hosting or a control panel to manage your `Nextcloud VM
|
||||
<https://github.com/nextcloud/vm>`_ or server, the configuration files are almost
|
||||
certain to be located somewhere else, for security and flexibility reasons, so
|
||||
|
||||
@@ -491,6 +491,49 @@ A :doc:`template <templates>` can be rendered by returning a TemplateResponse. A
|
||||
|
||||
}
|
||||
|
||||
Public page templates
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For public pages, that are rendered to users who are not logged in to the
|
||||
Nextcloud instance, a :any:`PublicTemplateResponse <OCP\\AppFramework\\Http\\Template\\PublicTemplateResponse>` should be used, to load the
|
||||
correct base template. It also allows adding an optional set of actions that
|
||||
will be shown in the top right corner of the public page.
|
||||
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
<?php
|
||||
namespace OCA\MyApp\Controller;
|
||||
|
||||
use OCP\AppFramework\Controller;
|
||||
use OCP\AppFramework\Http\Template\SimpleMenuAction;
|
||||
use OCP\AppFramework\Http\Template\PublicTemplateResponse;
|
||||
|
||||
class PageController extends Controller {
|
||||
|
||||
public function index() {
|
||||
$template = PublicTemplateResponse($this->appName, 'main', []);
|
||||
$template->setHeaderTitle('Public page');
|
||||
$template->setHeaderDetails('some details');
|
||||
$response->setHeaderActions([
|
||||
new SimpleMenuAction('download', 'Label 1', 'icon-css-class1', 'link-url', 0),
|
||||
new SimpleMenuAction('share', 'Label 2', 'icon-css-class2', 'link-url', 10),
|
||||
]);
|
||||
return $template;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
The header title and subtitle will be rendered in the header, next to the logo.
|
||||
The action with the highest priority (lowest number) will be used as the
|
||||
primary action, others will shown in the popover menu on demand.
|
||||
|
||||
A :any:`SimpleMenuAction <OCP\\AppFramework\\Http\\Template\\SimpleMenuAction>` will be a link with an icon added to the menu. App
|
||||
developers can implement their own types of menu renderings by adding a custom
|
||||
class implementing the :any:`IMenuAction <OCP\\AppFramework\\Http\\Template\\IMenuAction>` interface.
|
||||
|
||||
|
||||
|
||||
Redirects
|
||||
^^^^^^^^^
|
||||
|
||||
|
||||
@@ -6,7 +6,6 @@ Design guidelines
|
||||
:maxdepth: 2
|
||||
|
||||
navigation
|
||||
settings
|
||||
content
|
||||
list
|
||||
popovermenu
|
||||
|
||||
@@ -2,10 +2,67 @@
|
||||
.. codeauthor:: John Molakvoæ <skjnldsv@protonmail.com>
|
||||
.. _navigation:
|
||||
|
||||
.. _newbutton:
|
||||
|
||||
===============
|
||||
App navigation
|
||||
Introduction
|
||||
===============
|
||||
|
||||
The navigation section of any Nextcloud app is the left sidebar.
|
||||
It is basically composed of
|
||||
|
||||
* a primary action button
|
||||
* a menu
|
||||
* a settings area
|
||||
|
||||
The primary action button and the settings area are optional.
|
||||
|
||||
|
||||
===============
|
||||
New button
|
||||
===============
|
||||
|
||||
Introduction
|
||||
-------------
|
||||
|
||||
A primary action button is just a stylised button located above the navigation part of your app.
|
||||
The goal is to have an homogeneity of design across all apps using this button.
|
||||
|
||||
Basic layout
|
||||
-------------
|
||||
|
||||
.. figure:: ../images/newbutton.png
|
||||
:alt: Navigation with a new button
|
||||
:figclass: figure-with-code
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<div id="app-navigation">
|
||||
<div class="app-navigation-new">
|
||||
<button type="button" class="icon-add">
|
||||
Add user
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<!-- Your navigation here -->
|
||||
<!-- Your settings here -->
|
||||
|
||||
</div>
|
||||
|
||||
Rules
|
||||
------
|
||||
|
||||
* Stay simple, don't use overcomplicated text in this button.
|
||||
* Avoid using sentences longer than one line.
|
||||
* Do not edit the styling of this button.
|
||||
* Only **one** button is allowed here.
|
||||
|
||||
.. _appnavigation:
|
||||
|
||||
=====================
|
||||
App navigation menu
|
||||
=====================
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
@@ -31,6 +88,9 @@ Basic layout
|
||||
.. code-block:: html
|
||||
|
||||
<div id="app-navigation">
|
||||
|
||||
<!-- Your primary action button here -->
|
||||
|
||||
<ul>
|
||||
<li><a href="#">First level entry</a></li>
|
||||
<li>
|
||||
@@ -41,6 +101,9 @@ Basic layout
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<!-- Your settings here -->
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@@ -387,3 +450,45 @@ 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
|
||||
=========
|
||||
|
||||
Introduction
|
||||
-------------
|
||||
|
||||
To create a settings area create a div with the id ``app-settings`` inside the ``app-navigation`` div.
|
||||
|
||||
* The data attribute ``data-apps-slide-toggle`` slides up a target area using a jQuery selector and hides the area if the user clicks outside of it.
|
||||
* Max height of the settings area is 300px. Do **not** change that.
|
||||
* Keep it clear, organized and simple.
|
||||
|
||||
Basic layout
|
||||
-------------
|
||||
|
||||
.. figure:: ../images/settings.*
|
||||
:alt: Settings
|
||||
:figclass: figure-with-code
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<div id="app-navigation">
|
||||
|
||||
<!-- Your primary action button here -->
|
||||
<!-- Your navigation here -->
|
||||
|
||||
<div id="app-settings">
|
||||
<div id="app-settings-header">
|
||||
<button class="settings-button"
|
||||
data-apps-slide-toggle="#app-settings-content">
|
||||
Settings
|
||||
</button>
|
||||
</div>
|
||||
<div id="app-settings-content">
|
||||
<!-- Your settings content here -->
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -58,6 +58,24 @@ Basic layout
|
||||
<label for="radio1">Select</label>
|
||||
</span>
|
||||
</li>
|
||||
<li>
|
||||
<span class="menuitem">
|
||||
<span class="icon icon-user"></span>
|
||||
<form>
|
||||
<input id="input-folder" type="text" value="new email">
|
||||
<input type="submit" value=" " class="primary icon-checkmark-white">
|
||||
</form>
|
||||
</span>
|
||||
</li>
|
||||
<li>
|
||||
<span class="menuitem">
|
||||
<span class="icon icon-folder"></span>
|
||||
<form>
|
||||
<input id="input-folder" type="text" value="New folder">
|
||||
<input type="submit" value=" " class="icon-confirm">
|
||||
</form>
|
||||
</span>
|
||||
</li>
|
||||
<ul>
|
||||
</div>
|
||||
|
||||
@@ -74,6 +92,8 @@ Technical details
|
||||
* The required **right** distance to the border (or padding, whatever you want to use) of the three-dot icon should be 14px (5 for menu margin and 6 for arrow position)
|
||||
* The ``span`` element **must** have the ``menuitem`` class.
|
||||
* The checkbox/radio must use the :ref:`nextcloud custom <checkboxes-and-radios>`
|
||||
* The form element is optionnal if you're using inputs.
|
||||
* Supported inputs are all text based ones and buttons type ones
|
||||
|
||||
.. image:: ../images/popover-position.png
|
||||
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
.. sectionauthor:: John Molakvoæ <skjnldsv@protonmail.com>
|
||||
.. codeauthor:: John Molakvoæ <skjnldsv@protonmail.com>
|
||||
.. _settings:
|
||||
|
||||
========
|
||||
Settings
|
||||
========
|
||||
|
||||
To create a settings area create a div with the id ``app-settings`` inside the ``app-navigation`` div.
|
||||
|
||||
* The data attribute ``data-apps-slide-toggle`` slides up a target area using a jQuery selector and hides the area if the user clicks outside of it.
|
||||
* Max height of the settings area is 300px. Do **not** change that.
|
||||
* Keep it clear, organized and simple.
|
||||
|
||||
.. figure:: ../images/settings.*
|
||||
:alt: Settings
|
||||
:figclass: figure-with-code
|
||||
|
||||
.. code-block:: html
|
||||
|
||||
<div id="app-navigation">
|
||||
|
||||
<!-- Your navigation here -->
|
||||
|
||||
<div id="app-settings">
|
||||
<div id="app-settings-header">
|
||||
<button class="settings-button"
|
||||
data-apps-slide-toggle="#app-settings-content"
|
||||
><?php p($l->t('Settings'));?></button>
|
||||
</div>
|
||||
<div id="app-settings-content">
|
||||
<!-- Your settings in here -->
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
BIN
developer_manual/images/newbutton.png
Normal file
BIN
developer_manual/images/newbutton.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 6.2 KiB After Width: | Height: | Size: 9.4 KiB |
@@ -6,7 +6,7 @@ The External Storage application allows you to mount external storage services,
|
||||
such as Google Drive, Dropbox, Amazon S3, SMB/CIFS fileservers, and FTP servers
|
||||
in Nextcloud. Your Nextcloud server administrator controls which of these are
|
||||
available to you. Please see `Configuring External Storage (GUI)
|
||||
<https://docs.nextcloud.org/server/12/admin_manual/configuration_files/
|
||||
<https://docs.nextcloud.org/server/13/admin_manual/configuration_files/
|
||||
external_storage_configuration_gui.html>`_ in the Nextcloud Administrator's
|
||||
manual for configuration howtos and examples.
|
||||
|
||||
|
||||
@@ -25,6 +25,3 @@ Mobile clients
|
||||
Visit your Personal page in your Nextcloud Web interface to find download links
|
||||
for Android and iOS mobile sync clients. Or, visit the `Nextcloud download page
|
||||
<https://nextcloud.com/install/>`_.
|
||||
|
||||
Visit the `Nextcloud documentation page <https://docs.nextcloud.com/>`_ to read
|
||||
the user manuals.
|
||||
|
||||
Reference in New Issue
Block a user