From 7ad57b08dc60eb3ccb0e80216a3ccb7f6197b908 Mon Sep 17 00:00:00 2001 From: john-knowles <18680913+john-knowles@users.noreply.github.com> Date: Thu, 6 Sep 2018 13:46:50 +0100 Subject: [PATCH] Update README.md --- docs/README.md | 47 ++++++++++++++++++++++++++++++++--------------- 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/docs/README.md b/docs/README.md index d211a120c..417c6b6f9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,11 +17,11 @@ with a simple and easy to use interface for working with files stored in the Alf ### Prerequisites -This application uses the latest releases from Alfresco: +This application was created based on the latest releases from Alfresco: -- [Alfresco ADF (2.4.0)](https://community.alfresco.com/community/application-development-framework/pages/get-started) -- [Alfresco Content Services (5.2.3)](https://www.alfresco.com/platform/content-services-ecm) - or [Alfresco Community Edition (201802 EA)](https://www.alfresco.com/products/community/download) +- [Alfresco ADF (2.5.0)](https://community.alfresco.com/community/application-development-framework/pages/get-started) +- [Alfresco Content Services (6.0.0)](https://www.alfresco.com/platform/content-services-ecm) + or [Alfresco Community Edition (6.0 - General Release: 201806)](https://www.alfresco.com/products/community/download)

You also need node.js (LTS) installed to build it locally from source code. @@ -192,8 +192,9 @@ For more information on the [SearchComponent](https://github.com/Alfresco/alfres #### Actions and the Actions Toolbar All the views incorporate the [toolbar](https://alfresco.github.io/adf-component-catalog/components/ToolbarComponent.html) -component from the Alfresco Application Development Framework; -apart from the Trash view they all display the following actions when the current user has the necessary permissions, +component from the Alfresco Application Development Framework. + +Actions are displayed in the toolbar when item(s) are selected, or a right click is performed; apart from the Trash view they all display the following actions when the current user has the necessary permissions, actions are automatically hidden when the user does not have permission. @@ -244,6 +245,15 @@ actions are automatically hidden when the user does not have permission. once the move action has completed the user is notified and can undo the action (which moves the items back to the original location). + + + + + + + + + +
Share + Create and copy a link to a file that can be shared, the links are accessible without granting permissions to the file, and do not require users to login to the application. + + Not applicable. +
Delete @@ -259,11 +269,20 @@ actions are automatically hidden when the user does not have permission. Not applicable
Permissions + Permissions on a file can be adjusted as required in a number of ways; disable inheritance from the parent folder, change a user or groups role and grant users/groups access. + Not available
-Besides the actions available in the toolbar users can single click an item to select it, -or double click on a file to view it, and a folder to open it. +Besides the actions available in the toolbar users can +* single click on a file to view it, and a folder to open it +* single click an item to select it +* double click on a file to view it, and a folder to open it ### File Viewer @@ -308,10 +327,12 @@ At the bottom of the content the Viewer Controls allow users to interact with th - Jump to page number - Zoom in/out - Fit to page + - Print - Image View: - Zoom in/out - Rotate left/right (does not alter content in the repository) - Reset image + - Print - Media View: - Play/pause - Timeline position @@ -333,14 +354,9 @@ The Properties tab displays the node's metadata info by using the [ContentMetada For more information, please check also the [ContentMetadataComponent](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html). -#### Versions tab +#### Comments tab -The Versions tab displays info about the node's versions and allows users to [manage versions](#version-manager), according to their permissions. Only the file nodes have version data available. - -![Version Manager Tab](images/version-manager-tab.png) - -It uses the [VersionManagerComponent](https://alfresco.github.io/adf-component-catalog/components/VersionManagerComponent.html) from ADF framework. -Managing versions of a file can be possible also by accessing the 'Manage Versions' option from the 'More actions' menu. +The Comments tab displays all comments made on the selected node in the respoistory by using the [CommentsComponent](https://alfresco.github.io/adf-component-catalog/components/CommentsComponent.html). Users can post new comments that will be displayed immediately. ### Version Manager @@ -360,6 +376,7 @@ There are 2 ways users can access the Version Manager: #### Upload new version A new version for the selected file can be added by using this button. Users can upload a new file version using a file that is does not have the same name, or mime type as the current version, whilst allowing the user to choose the type of version (minor or major) and inputting supporting comments. + Please also check the [UploadVersionButtonComponent](https://alfresco.github.io/adf-component-catalog/components/UploadVersionButtonComponent.html). #### Actions Menu