From 2b92f79b2d0938e054d9feb5bfa15781ac0dc215 Mon Sep 17 00:00:00 2001 From: Matthew Setter Date: Tue, 28 May 2019 14:59:12 +0200 Subject: [PATCH] [10.0] [PR 1228] Document ability to open the file sidebar from a permalink Backport of PR #1228 --- .../list-capabilities-response.json | 1 + .../pages/core/ocs-capabilities.adoc | 25 ++++++++++++++++--- .../_partials/direct_file_access_tip.adoc | 4 +++ .../pages/files/version_control.adoc | 8 ++++-- .../pages/files/webgui/comments.adoc | 7 ++++++ .../pages/files/webgui/sharing.adoc | 7 ++++++ 6 files changed, 47 insertions(+), 5 deletions(-) create mode 100644 modules/user_manual/pages/_partials/direct_file_access_tip.adoc diff --git a/modules/developer_manual/examples/core/apis/ocs-capabilities/list-capabilities-response.json b/modules/developer_manual/examples/core/apis/ocs-capabilities/list-capabilities-response.json index e25f10a65b..345d1e74b0 100644 --- a/modules/developer_manual/examples/core/apis/ocs-capabilities/list-capabilities-response.json +++ b/modules/developer_manual/examples/core/apis/ocs-capabilities/list-capabilities-response.json @@ -15,6 +15,7 @@ ], "bigfilechunking" : true, "privateLinks" : true, + "privateLinksDetailsParam": true, "undelete" : true, "versioning" : true }, diff --git a/modules/developer_manual/pages/core/ocs-capabilities.adoc b/modules/developer_manual/pages/core/ocs-capabilities.adoc index ab9b6f8c3b..ea2c7c8821 100644 --- a/modules/developer_manual/pages/core/ocs-capabilities.adoc +++ b/modules/developer_manual/pages/core/ocs-capabilities.adoc @@ -47,9 +47,28 @@ server’s supported checksum types, and preferred upload checksum type. [[files]] == Files -Stored under the `files` capabilities element, this returns the server’s -support for big file chunking, file versioning, its ability to undelete -files, and the list of files that are currently blacklisted. +Stored under the `files` capabilities element, this returns the server's support for the following capabilities: + +[cols=",",options="header"] +|=== +|Capability +|Response Key + +|Big file chunking +|`bigfilechunking` + +|File versioning +|`versioning` + +|Navigating directly to a file's version, comments, and sharing pane +|`privatelLinks` and `privateLinksDetailsParam` + +|Its ability to undelete files; and +|`undelete` + +|The list of files that are currently blacklisted. +|`blacklisted_files` +|=== [[files-sharing]] == Files Sharing diff --git a/modules/user_manual/pages/_partials/direct_file_access_tip.adoc b/modules/user_manual/pages/_partials/direct_file_access_tip.adoc new file mode 100644 index 0000000000..ce595d552d --- /dev/null +++ b/modules/user_manual/pages/_partials/direct_file_access_tip.adoc @@ -0,0 +1,4 @@ +[TIP] +==== +You can navigate directly to the {tab-type-text} pane for a file by using the URL: `https://your.owncloud.domain/f/?<$fileId>?details={tab-type-link}TabView`, and substituting `<$fileId>` for the file's id. +==== diff --git a/modules/user_manual/pages/files/version_control.adoc b/modules/user_manual/pages/files/version_control.adoc index 78a7936ada..879d3f451d 100644 --- a/modules/user_manual/pages/files/version_control.adoc +++ b/modules/user_manual/pages/files/version_control.adoc @@ -1,4 +1,6 @@ = Version Control +:tab-type-text: versions +:tab-type-link: versions ownCloud supports simple version control system for files. Versioning creates backups of files which are accessible via the Versions tab on @@ -8,8 +10,10 @@ greater than two minutes are saved in data/[user]/versions. image:files_versioning.png[image] -To restore a specific version of a file, click the circular arrow to the -left. Click on the timestamp to download it. +include::{partialsdir}/direct_file_access_tip.adoc[] + +To restore a specific version of a file, click the btn:[circular arrow] to the +left. Click on the btn:[timestamp] to download it. The versioning app expires old versions automatically to make sure that the user doesn’t run out of space. This pattern is used to delete old diff --git a/modules/user_manual/pages/files/webgui/comments.adoc b/modules/user_manual/pages/files/webgui/comments.adoc index 9148a0ac29..8447381afd 100644 --- a/modules/user_manual/pages/files/webgui/comments.adoc +++ b/modules/user_manual/pages/files/webgui/comments.adoc @@ -1,8 +1,15 @@ = Comments +:toc: right +:tab-type-text: comments +:tab-type-link: comments + +== Introduction In ownCloud, you can add one or more comments on both files and folders. This section describes how to add, edit, and delete comments. +include::{partialsdir}/direct_file_access_tip.adoc[] + [[add-comments]] == Add Comments diff --git a/modules/user_manual/pages/files/webgui/sharing.adoc b/modules/user_manual/pages/files/webgui/sharing.adoc index b9451f2754..f5c7bfd7ea 100644 --- a/modules/user_manual/pages/files/webgui/sharing.adoc +++ b/modules/user_manual/pages/files/webgui/sharing.adoc @@ -1,4 +1,9 @@ = Sharing Files +:toc: right +:tab-type-text: sharing +:tab-type-link: share + +== Introduction Clicking the share icon on any file or folder opens the Details view on the right, where the Share tab has focus. @@ -49,6 +54,8 @@ _edit_, _create_, _change_, and _delete_ the directory. image:files_page-2.png[Sharing files] +include::{partialsdir}/direct_file_access_tip.adoc[] + [[what-happens-when-share-recipients-move-files-and-folders]] === What Happens When Share Recipients Move Files and Folders?