[10.2] [PR 1228] Document ability to open the file sidebar from a per…

…malink Backport of PR #1228
owncloud · May 28, 2019 · 6bc1810 · 6bc1810
1 parent b9a6472
commit 6bc1810
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 3 deletions.
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
@@ -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
@@ -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
@@ -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
@@ -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,6 +10,8 @@ greater than two minutes are saved in data/[user]/versions.
 
 image:files_versioning.png[image]
 
+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.
 

diff --git a/modules/user_manual/pages/files/webgui/comments.adoc b/modules/user_manual/pages/files/webgui/comments.adoc
@@ -1,11 +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
@@ -1,5 +1,7 @@
 = Sharing Files
 :toc: right
+:tab-type-text: sharing
+:tab-type-link: share
 
 == Introduction
 
@@ -51,6 +53,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?