mirror of
https://github.com/Alfresco/alfresco-content-app.git
synced 2025-07-24 17:31:52 +00:00
[ACA-2157] Fixed structure, markup and links (#904)
* [ACA-2157] Added brief description and updated links * [ACA-2157] Fixed broken image URL
This commit is contained in:
Andy Stark
Denys Vuika
@@ -6,10 +6,10 @@ Title: Document List Layout
|
||||
|
||||
The main area of the application is composed of several individual ADF components:
|
||||
|
||||
1. [Breadcrumb](https://alfresco.github.io/adf-component-catalog/components/BreadcrumbComponent.html)
|
||||
2. [Toolbar](https://alfresco.github.io/adf-component-catalog/components/ToolbarComponent.html)
|
||||
3. [Document List](https://alfresco.github.io/adf-component-catalog/components/DocumentListComponent.html)
|
||||
4. [Pagination](https://alfresco.github.io/adf-component-catalog/components/PaginationComponent.html)
|
||||
1. [Breadcrumb](https://www.alfresco.com/abn/adf/docs/content-services/breadcrumb.component/)
|
||||
2. [Toolbar](https://www.alfresco.com/abn/adf/docs/core/toolbar.component/)
|
||||
3. [Document List](https://www.alfresco.com/abn/adf/docs/content-services/document-list.component/)
|
||||
4. [Pagination](https://www.alfresco.com/abn/adf/docs/core/pagination.component/)
|
||||
|
||||
|
||||
|
||||
@@ -20,150 +20,77 @@ The application has seven different Document List views which share commonalitie
|
||||
Personal Files retrieves all content from the logged in user's home area (`/User Homes/<username>/`) in the repository;
|
||||
if the user is ‘admin’ who does not have a home folder then the repository root folder is shown.
|
||||
|
||||
Personal Files is the [Files](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/files) component,
|
||||
Personal Files is the [Files](../../src/app/components/files) component,
|
||||
using the [Nodes API](https://api-explorer.alfresco.com/api-explorer/#/nodes).
|
||||
|
||||
## File Libraries
|
||||
|
||||
File Libraries retrieves all the sites that the user is a member of including what type of site it is: public, moderated or private.
|
||||
File Libraries is the [Libraries](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/libraries) component,
|
||||
File Libraries is the [Libraries](../../src/app/components/libraries) component,
|
||||
using the [Sites API](https://api-explorer.alfresco.com/api-explorer/#/sites).
|
||||
|
||||
When a user opens one of their sites then the content for the site's document library is shown.
|
||||
To display the files and folders from a site (`/Sites/<siteid>/Document Library/`) the [Files](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/files) component,
|
||||
To display the files and folders from a site (`/Sites/<siteid>/Document Library/`) the [Files](../../src/app/components/files) component,
|
||||
using the [Nodes API](https://api-explorer.alfresco.com/api-explorer/#/nodes) is used.
|
||||
|
||||
## Shared Files
|
||||
|
||||
The Shared Files view aggregates all files that have been shared using the QuickShare feature in the content repository.
|
||||
The [Shared Files](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/shared-files) component uses the [shared-links API](https://api-explorer.alfresco.com/api-explorer/#/shared-links)
|
||||
and includes extra columns to display where the file is
|
||||
[located](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/location-link)
|
||||
The [Shared Files](../../src/app/components/shared-files) component uses the [shared-links API](https://api-explorer.alfresco.com/api-explorer/#/shared-links)
|
||||
and includes extra columns to display where the file is located
|
||||
in the content repository and who created the shared link.
|
||||
|
||||
## Recent Files
|
||||
|
||||
The Recent Files view shows all the files that have been created or modified within the last 30 days by the current user.
|
||||
The [Recent Files](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/recent-files)
|
||||
component uses the Search API to query SOLR for changes made by the user and includes an extra column to display where the file is
|
||||
[located](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/location-link)
|
||||
The [Recent Files](../../src/app/components/recent-files)
|
||||
component uses the Search API to query SOLR for changes made by the user and includes an extra column to display where the file is located
|
||||
in the content repository.
|
||||
|
||||
## Favorites
|
||||
|
||||
The Favorites view shows all files and folders from the content repository that have been marked as a favorite by the current user.
|
||||
The [Favorites](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/favorites) component uses the
|
||||
The [Favorites](../../src/app/components/favorites) component uses the
|
||||
[favorites](https://api-explorer.alfresco.com/api-explorer/#/favorites) API to retrieve all the favorite nodes for the user
|
||||
and includes an extra column to display where the file is
|
||||
[located](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/location-link)
|
||||
and includes an extra column to display where the file is located
|
||||
in the content repository.
|
||||
|
||||
## Trash
|
||||
|
||||
The Trash view shows all the items that a user has deleted, admin will see items deleted by all users.
|
||||
The actions available in this view are Restore and Permanently Delete.
|
||||
The [Trashcan](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/trashcan) component uses the
|
||||
The [Trashcan](../../src/app/components/trashcan) component uses the
|
||||
[trashcan](https://api-explorer.alfresco.com/api-explorer/#/trashcan) API to retrieve the deleted items
|
||||
and perform the actions requested by the user and includes an extra column to display where the item was
|
||||
[located](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/location-link)
|
||||
and perform the actions requested by the user and includes an extra column to display where the item was located
|
||||
in the content repository before it was deleted.
|
||||
|
||||
## Search Results
|
||||
|
||||
The Search Results view shows the found items for a search query. It has a custom layout template and users can easily browse the results and perform actions on items.
|
||||
For more information on the [SearchComponent](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/search), please also check this [Search Results](/features/search-results) section.
|
||||
For more information on the [Search Component](../../src/app/components/search), please also check this [Search Results](/features/search-results) section.
|
||||
|
||||
Another custom template layout shows the results when searching for libaries so that users can find, join and favorite libraries that they aren't already members of.
|
||||
|
||||
## Actions and the Actions Toolbar
|
||||
|
||||
All the views incorporate the [toolbar](https://alfresco.github.io/adf-component-catalog/components/ToolbarComponent.html)
|
||||
All the views incorporate the [toolbar](https://www.alfresco.com/abn/adf/docs/core/toolbar.component/)
|
||||
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.
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<th>Action</th>
|
||||
<th>File</th>
|
||||
<th>Folder</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>View</td>
|
||||
<td>
|
||||
Opens the selected file using the <a href="https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/preview" target="_blank">Preview</a> component,
|
||||
where the file cannot be displayed natively in a browser a PDF rendition is obtained from the repository.
|
||||
</td>
|
||||
<td>Not applicable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Download</td>
|
||||
<td>Downloads single files to the user's computer, when multiple files are selected they are compressed into a ZIP and then downloaded.</td>
|
||||
<td>Folders are automatically compressed into a ZIP and then downloaded to the user's computer.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Edit</td>
|
||||
<td>Not applicable</td>
|
||||
<td>The folder name and description can be edited in a dialog.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Favorite</td>
|
||||
<td colspan="2">
|
||||
Toggle the favorite mark on or off for files and folders, when multiple items are selected
|
||||
and one or more are not favorites then the mark will be toggled on.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Copy</td>
|
||||
<td colspan="2">
|
||||
Files and folders can be copied to another location in the content repository using the
|
||||
<a href="https://alfresco.github.io/adf-component-catalog/components/ContentNodeSelectorComponent.html" target="_blank">content-node-selector</a> component;
|
||||
once the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Move</td>
|
||||
<td colspan="2">
|
||||
Files and folders can be moved to another location in the content repository using the
|
||||
<a href="https://alfresco.github.io/adf-component-catalog/components/ContentNodeSelectorComponent.html" target="_blank">content-node-selector</a> component;
|
||||
once the move action has completed the user is notified and can undo the action (which moves the items back to the original location).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Share</td>
|
||||
<td>
|
||||
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. Share links can automatically expire based on a date, the minimum expiry date is controlled by the Content Services repository, which is 1 day from the date of creation.
|
||||
</td>
|
||||
<td>
|
||||
Not applicable.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Delete</td>
|
||||
<td colspan="2">
|
||||
Files and folders can be deleted from their location in the content repository;
|
||||
once the delete action has completed the user is notified and can undo the action (which restores the items from the trash).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Manage Versions</td>
|
||||
<td>
|
||||
Versions of files can be viewed, uploaded, restored, downloaded and deleted by using the version manager dialog;
|
||||
once each action has completed the list of versions is updated according to the change.
|
||||
</td>
|
||||
<td>Not applicable</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Permissions</td>
|
||||
<td>
|
||||
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.
|
||||
</td>
|
||||
<td>Not available</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
| Action | File | Folder |
|
||||
| -- | -- | -- |
|
||||
| View | Opens the selected file using the [Preview component](../../src/app/components/preview). If the file cannot be displayed natively in a browser, a PDF rendition is obtained from the repository. | Not applicable |
|
||||
| Download | Downloads single files to the user's computer, when multiple files are selected they are compressed into a ZIP and then downloaded. | Folders are automatically compressed into a ZIP and then downloaded to the user's computer. |
|
||||
| Edit | Not applicable | The folder name and description can be edited in a dialog. |
|
||||
| Favorite | Toggle the favorite mark on or off for files and folders. If multiple items are selected and one or more are not favorites then the mark will be toggled on. |
|
||||
| Copy | Files and folders can be copied to another location in the content repository using the [Content node selector component](https://www.alfresco.com/abn/adf/docs/content-services/content-node-selector.component/). When the copy action has completed the user is notified and can undo the action (which permanently deletes the created copies). |
|
||||
| Move | Files and folders can be moved to another location in the content repository using the [Content node selector component](https://www.alfresco.com/abn/adf/docs/content-services/content-node-selector.component/). When 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. Share links can automatically expire based on a date, the minimum expiry date is controlled by the Content Services repository, which is 1 day from the date of creation. | Not applicable |
|
||||
| Delete | Files and folders can be deleted from their location in the content repository. When the delete action has completed the user is notified and can undo the action (which restores the items from the trash). |
|
||||
| Manage Versions | Versions of files can be viewed, uploaded, restored, downloaded and deleted by using the version manager dialog. When each action has completed the list of versions is updated according to the change. | 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 on a file to view it, and a folder to open it
|
||||
|
||||
@@ -4,7 +4,9 @@ Title: File Viewer
|
||||
|
||||
# File Viewer
|
||||
|
||||
The File Viewer has been created using the [ViewerComponent](https://alfresco.github.io/adf-component-catalog/components/ViewerComponent.html) from the ADF. The Viewer has four main areas:
|
||||
The File Viewer has been created using the [ViewerComponent](https://www.alfresco.com/abn/adf/core/viewer.component/) from ADF.
|
||||
|
||||
The Viewer has four main areas:
|
||||
|
||||
|
||||
|
||||
@@ -24,7 +26,7 @@ The Header & Toolbar section of the viewer contains a number of features that re
|
||||
|
||||
## Content
|
||||
|
||||
The File Viewer consists of four separate views that handle displaying the content based on four types of content, covering various [file/mime](https://alfresco.github.io/adf-component-catalog/components/ViewerComponent.html#supported-file-formats) types:
|
||||
The File Viewer consists of four separate views that handle displaying the content based on four types of content, covering various [file/mime](https://www.alfresco.com/abn/adf/core/viewer.component/#supported-file-formats) types:
|
||||
|
||||
- Document View: PDF files are displayed in the application File Viewer, for other document types (DOCX etc) then a PDF rendition is automatically retrieved.
|
||||
- Image View: JPEG, PNG, GIF, BMP and SVG images are natively displayed in the application File Viewer.
|
||||
|
||||
@@ -4,7 +4,7 @@ Title: Header
|
||||
|
||||
# Header
|
||||
|
||||
The application [header](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/header) has three main elements.
|
||||
The application [header](../../src/app/components/header) has three main elements.
|
||||
|
||||
1. [Logo and Color](#logo-and-color)
|
||||
2. [Search](#search)
|
||||
@@ -15,13 +15,13 @@ The application [header](https://github.com/Alfresco/alfresco-content-app/tree/m
|
||||
## Logo and Color
|
||||
|
||||
Logo & app primary color - logo and color are configurable by updating the
|
||||
[app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json) file in the root folder of the project.
|
||||
[app.config.json](../../src/app.config.json) file in the root folder of the project.
|
||||
Please refer to the [Application Configuration](/getting-started/configuration) documentation for more information on how to change the logo and color.
|
||||
|
||||
## Search
|
||||
|
||||
The application [Search](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/search) -
|
||||
uses the [ADF Search Component](https://github.com/Alfresco/alfresco-ng2-components/tree/master/lib/content-services/search).
|
||||
The application [Search](../../src/app/components/search) -
|
||||
uses the [ADF Search Component](https://www.alfresco.com/abn/adf/docs/content-services/search.component/).
|
||||
The app provides a 'live' search feature, where users can open files and folders directly from the Search API results.
|
||||
|
||||
|
||||
@@ -32,9 +32,9 @@ with advanced filtering and faceted search.
|
||||
|
||||
## Current User
|
||||
|
||||
[Current User](https://github.com/Alfresco/alfresco-content-app/tree/development/src/app/components/current-user) -
|
||||
[Current User](../../src/app/components/current-user) -
|
||||
displays the user's name, and a menu where users can logout.
|
||||
Optionally through updating the [app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json)
|
||||
Optionally through updating the [app.config.json](../../src/app.config.json)
|
||||
a language switching menu can be displayed.
|
||||
|
||||
|
||||
|
||||
@@ -4,18 +4,20 @@ Title: Info Drawer
|
||||
|
||||
# Info Drawer
|
||||
|
||||
The Info Drawer displays node information in the right sidebar panel. It is created by using the [InfoDrawerComponent](https://alfresco.github.io/adf-component-catalog/components/InfoDrawerComponent.html). This info is available for both folder and file nodes.
|
||||
The Info Drawer displays node information in the right sidebar panel.
|
||||
|
||||
It is created by using the [Info Drawer Component](https://www.alfresco.com/abn/adf/core/info-drawer.component/). This info is available for both folder and file nodes.
|
||||
|
||||
Currently, there are 2 tabs available: Properties and Versions.
|
||||
|
||||
## Properties tab
|
||||
|
||||
The Properties tab displays the node's metadata info by using the [ContentMetadataCardComponent](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataCardComponent.html).
|
||||
The Properties tab displays the node's metadata info by using the [Content Metadata Card Component](https://www.alfresco.com/abn/adf/core/content-metadata-card.component/).
|
||||
|
||||
|
||||
|
||||
|
||||
For more information, please check also the [ContentMetadataComponent](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html).
|
||||
For more information, please check also the [Content Metadata Component](https://www.alfresco.com/abn/adf/core/content-metadata.component/).
|
||||
|
||||
## Comments tab
|
||||
|
||||
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.
|
||||
The Comments tab displays all comments made on the selected node in the respoistory by using the [Comments Component](https://www.alfresco.com/abn/adf/core/comments.component/). Users can post new comments that will be displayed immediately.
|
||||
|
||||
@@ -4,16 +4,16 @@ Title: Search Results
|
||||
|
||||
# Search Results
|
||||
|
||||
Once you type the text in the Search Input component you are going to see the Search Results page
|
||||
When you type text in the Search Input component, you will see the Search Results page.
|
||||
|
||||
|
||||
|
||||
This page consists of the following ADF components:
|
||||
|
||||
- [Search Filter](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/content-services/search-filter.component.md)
|
||||
- [Search Chip List](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/content-services/search-chip-list.component.md)
|
||||
- [Search Sorting Picker](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/content-services/search-sorting-picker.component.md)
|
||||
- [Document List](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/content-services/document-list.component.md) with custom layout template
|
||||
- [Search Filter](https://www.alfresco.com/abn/adf/docs/content-services/search-filter.component/)
|
||||
- [Search Chip List](https://www.alfresco.com/abn/adf/docs/content-services/search-chip-list.component/)
|
||||
- [Search Sorting Picker](https://www.alfresco.com/abn/adf/docs/content-services/search-sorting-picker.component/)
|
||||
- [Document List](https://www.alfresco.com/abn/adf/docs/content-services/document-list.component/) with custom layout template
|
||||
- [Info Drawer](/features/info-drawer) with Metadata and [Version Management](#version-manager)
|
||||
- [Toolbar with basic actions](/features/document-list-layout#actions-and-the-actions-toolbar) like `Preview`, `Download`, `Favorite`, `Copy`, etc.
|
||||
|
||||
|
||||
@@ -4,8 +4,7 @@ Title: Side Navigation
|
||||
|
||||
# Side Navigation
|
||||
|
||||
The application [side navigation](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/sidenav) has two features:
|
||||
a button menu and navigation links.
|
||||
The application [side navigation](../../src/app/components/sidenav) has two features: a button menu and navigation links.
|
||||
|
||||
|
||||
|
||||
@@ -17,7 +16,7 @@ The New button displays a menu which provides three actions:
|
||||
- Upload a file - invokes the operating system file browser and allows a user to select file(s) to upload into their current location in the content repository.
|
||||
- Upload a folder - invokes the operating system folder browser and allows a user to select a folder to upload to their current location in the content repository.
|
||||
|
||||
When an upload starts the [upload component](https://github.com/Alfresco/alfresco-ng2-components/tree/master/lib/content-services/upload)
|
||||
When an upload starts the [upload component](https://www.alfresco.com/abn/adf/docs/content-services/upload.component/)
|
||||
is displayed which shows the user the progress of the uploads they have started.
|
||||
The upload dialog persists on the screen and can be minimized; users are able to continue using the application whilst uploads are in progress
|
||||
and uploads can be canceled which will stop uploads in progress or permanently delete already completed uploads.
|
||||
@@ -26,6 +25,6 @@ and uploads can be canceled which will stop uploads in progress or permanently d
|
||||
|
||||
## Navigation
|
||||
|
||||
The navigation links are configurable via the [app.config.json](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app.config.json).
|
||||
The navigation links are configurable via the [app.config.json](../../src/app.config.json).
|
||||
Default configuration creates two sections.
|
||||
See [Navigation](/getting-started/navigation) for more information about configuring the side navigation.
|
||||
|
||||
@@ -4,7 +4,7 @@ Title: User Interface - layout
|
||||
|
||||
# User Interface - layout
|
||||
|
||||
There are three main areas of the application controlled by the [Layout component](https://github.com/Alfresco/alfresco-content-app/tree/master/src/app/components/layout):
|
||||
There are three main areas of the application controlled by the [Layout component](../../src/app/components/layout):
|
||||
|
||||
1. [Application Header](/features/header)
|
||||
2. [Side Navigation](/features/side-navigation)
|
||||
|
||||
@@ -4,7 +4,7 @@ Title: Version Manager
|
||||
|
||||
# Version Manager
|
||||
|
||||
The versions of a file can be viewed and managed by using the [VersionManagerComponent](https://alfresco.github.io/adf-component-catalog/components/VersionManagerComponent.html).
|
||||
The versions of a file can be viewed and managed by using the [Version Manager Component](https://www.alfresco.com/abn/adf/content-services/version-manager.component/).
|
||||
|
||||
There are 2 ways users can access the Version Manager:
|
||||
|
||||
@@ -21,7 +21,7 @@ There are 2 ways users can access the Version Manager:
|
||||
|
||||
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).
|
||||
Please also check the [UploadVersionButtonComponent](https://www.alfresco.com/abn/adf/content-services/upload-version-button.component/).
|
||||
|
||||
## Actions Menu
|
||||
|
||||
@@ -40,4 +40,4 @@ In the app.config.json file, these are the current settings for the ACA version
|
||||
|
||||
Set the allowComments to false if the version comments should not be displayed on the version list.
|
||||
|
||||
Clicking to delete a version of a file triggers a confirmation dialog. Please see the [ConfirmDialogComponent](https://alfresco.github.io/adf-component-catalog/components/ConfirmDialogComponent.html) for more info.
|
||||
Clicking to delete a version of a file triggers a confirmation dialog. Please see the [Confirm Dialog Component](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/content-services/dialogs/confirm.dialog.ts) for more info.
|
||||
|
||||
Reference in New Issue
Block a user