From a46e16c28a6e773cfc6dec5e0af60d3456d62b74 Mon Sep 17 00:00:00 2001
From: Andy Stark <30621568+therealandeeee@users.noreply.github.com>
Date: Wed, 23 Jan 2019 07:45:31 +0000
Subject: [PATCH] [ACA-2157] Fixed structure, markup and links (#904)
* [ACA-2157] Added brief description and updated links
* [ACA-2157] Fixed broken image URL
---
docs/README.md | 2 +-
docs/extending/actions.md | 2 +
docs/extending/application-actions.md | 10 +-
docs/extending/application-features.md | 18 +--
docs/extending/creating-custom-evaluators.md | 10 +-
docs/extending/extension-format.md | 22 +---
docs/extending/redistributable-libraries.md | 12 +-
docs/extending/registration.md | 4 +-
docs/extending/routes.md | 4 +-
docs/extending/rules.md | 15 +--
docs/extending/tutorials.md | 2 +
docs/features/document-list-layout.md | 131 ++++---------------
docs/features/file-viewer.md | 6 +-
docs/features/header.md | 12 +-
docs/features/info-drawer.md | 12 +-
docs/features/search-results.md | 10 +-
docs/features/side-navigation.md | 7 +-
docs/features/user-interface-layout.md | 2 +-
docs/features/version-manager.md | 6 +-
docs/getting-started/building-from-source.md | 4 +-
docs/getting-started/configuration.md | 14 +-
docs/getting-started/cors.md | 1 +
docs/getting-started/docker.md | 7 +-
docs/getting-started/internationalization.md | 4 +-
docs/getting-started/navigation.md | 4 +-
docs/getting-started/prerequisites.md | 4 +-
26 files changed, 106 insertions(+), 219 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 0831ddbfa..f59a495d3 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,7 +8,7 @@ Github only: true
The Alfresco Content Application a file management application built using
-[Alfresco Application Development Framework (ADF)](https://github.com/Alfresco/alfresco-ng2-components) components and was generated with [Angular CLI](https://github.com/angular/angular-cli).
+[Alfresco Application Development Framework (ADF)](https://www.alfresco.com/abn/adf/docs) components and was generated with [Angular CLI](https://github.com/angular/angular-cli).
## Documentation
diff --git a/docs/extending/actions.md b/docs/extending/actions.md
index 2151773e1..a7b8b9cc7 100644
--- a/docs/extending/actions.md
+++ b/docs/extending/actions.md
@@ -4,6 +4,8 @@ Title: Actions
# Actions
+Below are the details of the JSON properties that are used to define actions.
+
| Name | Description |
| -- | -- |
| **id** | Unique identifier. |
diff --git a/docs/extending/application-actions.md b/docs/extending/application-actions.md
index df939e0d4..2494f9e7e 100644
--- a/docs/extending/application-actions.md
+++ b/docs/extending/application-actions.md
@@ -4,8 +4,10 @@ Title: Application Actions
# Application Actions
-Application is using NgRx (Reactive libraries for Angular, inspired by Redux).
-To get more information on NxRx please refer to the following resources:
+The app uses **NgRx** (Reactive libraries for Angular, inspired by Redux)
+to implement application actions.
+
+For more information on NgRx, please refer to the following resources:
- [Comprehensive Introduction to @ngrx/store](https://gist.github.com/btroncone/a6e4347326749f938510)
@@ -41,10 +43,8 @@ export class MyService {
You can invoke every application action from the extensions, i.e. buttons, menus, etc.
-
-Many of the actions take currently selected nodes if no payload provided.
+**Tip:** Many of the actions take currently selected nodes if no payload provided.
That simplifies declaring and invoking actions from the extension files.
-
In the example below, we create a new entry to the "NEW" menu dropdown
and provide a new `Create Folder (plugin1)` command that invokes the `CREATE_FOLDER` application action.
diff --git a/docs/extending/application-features.md b/docs/extending/application-features.md
index 6aa546181..7eea45a9f 100644
--- a/docs/extending/application-features.md
+++ b/docs/extending/application-features.md
@@ -117,9 +117,7 @@ You can populate the menu with an extra entries like in the example below:
Please refer to the [Content Actions](/extending/application-features#content-actions) section for more details on supported properties.
-
-It is also possible to update or disable existing entries from within the external extension files. You will need to know the `id` of the target element to customize.
-
+**Tip:** It is also possible to update or disable existing entries from within the external extension files. You will need to know the `id` of the target element to customize.
## Navigation Bar
@@ -235,10 +233,8 @@ The example above renders two tabs:
All corresponding components must be registered for runtime use.
-
-See the [Registration](/extending/registration) section for more details
+**Tip:** See the [Registration](/extending/registration) section for more details
on how to register your own entries to be re-used at runtime.
-
### Tab properties
@@ -537,7 +533,7 @@ As with other content actions, custom plugins can disable, update or extend `Ope
## Content metadata presets
-The content metadata presets are needed by the [Content Metadata Component](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html#readme) to render the properties of metadata aspects for a given node.
+The content metadata presets are needed by the [Content Metadata Component](https://www.alfresco.com/abn/adf/docs/content-services/content-metadata-card.component/) to render the properties of metadata aspects for a given node.
The different aspects and their properties are configured in the `app.config.json` file, but they can also be set on runtime through extension files.
Configuring these presets from `app.extensions.json` will overwrite the default application setting.
@@ -547,9 +543,7 @@ Check out more info about merging extensions [here](/extending/extension-format#
The `content-metadata-presets` elements can be switched off by setting the `disabled` property.
This can be applied also for nested items, allowing disabling down to aspect level.
-
-In order to modify or disable existing entries, you need to know the id of the target element, along with its parents ids.
-
+**Tip:** In order to modify or disable existing entries, you need to know the id of the target element, along with its parents ids.
Your extensions can perform the following actions at runtime:
@@ -642,7 +636,5 @@ Here is the initial setting from `app.extension.json`:
```
-
-In order to allow the content-metadata presets to be extended, the settings from `app.config.json` must be copied to the `app.extensions.json` file and its ids must be added to all the items.
+**Tip:** In order to allow the content-metadata presets to be extended, the settings from `app.config.json` must be copied to the `app.extensions.json` file and its ids must be added to all the items.
Having ids allows external plugins to extend the current setting.
-
diff --git a/docs/extending/creating-custom-evaluators.md b/docs/extending/creating-custom-evaluators.md
index a397d1650..b6d9c1f36 100644
--- a/docs/extending/creating-custom-evaluators.md
+++ b/docs/extending/creating-custom-evaluators.md
@@ -6,7 +6,9 @@ Title: Creating custom evaluators
Rule evaluators are plain JavaScript (or TypeScript) functions that take `RuleContext` references and an optional list of `RuleParameter` instances.
-Application provides a special [RuleEvaluator](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app/extensions/rule.extensions.ts#L30) type alias for evaluator functions:
+Application provides a special
+[RuleEvaluator](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/extensions/src/lib/config/rule.extensions.ts)
+type alias for evaluator functions:
```ts
export type RuleEvaluator = (context: RuleContext, ...args: any[]) => boolean;
@@ -23,7 +25,7 @@ export function hasSelection(
}
```
-The `context` is a reference to a special instance of the [RuleContext](https://github.com/Alfresco/alfresco-content-app/blob/master/src/app/extensions/rule.extensions.ts#L32) type,
+The `context` is a reference to a special instance of the [RuleContext](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/extensions/src/lib/config/rule.extensions.ts) type,
that provides each evaluator access to runtime entities.
```ts
@@ -63,7 +65,5 @@ extensions.setEvaluators({
Now, the `plugin1.rules.hasSelection` evaluator can be used as an inline rule reference,
or part of the composite rule like `core.every`.
-
-See the [Registration](/extending/registration) section for more details
+**Tip:** See the [Registration](/extending/registration) section for more details
on how to register your own entries to be re-used at runtime.
-
diff --git a/docs/extending/extension-format.md b/docs/extending/extension-format.md
index b39e6383a..1259eb654 100644
--- a/docs/extending/extension-format.md
+++ b/docs/extending/extension-format.md
@@ -25,11 +25,9 @@ The format is represented by a JSON file with the structure similar to the follo
## Schema
-You can find the JSON schema at the project root folder: [extension.schema.json](https://github.com/Alfresco/alfresco-content-app/blob/master/extension.schema.json).
+You can find the JSON schema at the project root folder: [extension.schema.json](../../extension.schema.json).
-
-The Schema allows you to validate extension files, provides code completion and documentation hints.
-
+**Tip:** The Schema allows you to validate extension files, provides code completion and documentation hints.
```json
{
@@ -54,10 +52,8 @@ The order of declaration defines the order of loading.
}
```
-
-All extension files are merged together at runtime.
+**Note:** All extension files are merged together at runtime.
This allows plugins to overwrite the code from the main application or to alter other plugins.
-
## Startup behavior
@@ -69,10 +65,8 @@ For the sake of speed the files are loaded in parallel, however once everything
After all the external files are fetched, the `Loader` sorts them, removes the metadata properties and stacks the resulting JSON objects on top of each other.
-
-Any top-level property name that starts with the `$` symbol is considered metadata and does not participate in the merge process.
+**Tip:** Any top-level property name that starts with the `$` symbol is considered metadata and does not participate in the merge process.
That allows a plugin to carry extra information for maintenance and visualisation purposes, for example: `$name`, `$version`, `$description`, `$license`, etc.
-
### Merging properties
@@ -112,10 +106,8 @@ Final result:
Note that as a result we have two unique properties `plugin1.key` and `plugin2.key`,
and also a `plugin1.text` that was first defined in the `Plugin 1`, but then overwritten by the `Plugin 2`.
-
-JSON merging is a very powerful concept as it gives you the ability to alter any base application settings,
+**Tip:** JSON merging is a very powerful concept as it gives you the ability to alter any base application settings,
or toggle features in other plugins without rebuilding the application or corresponding plugin libraries.
-
### Merging objects
@@ -216,9 +208,7 @@ You can find more details in the [Disabling Content](/extending/extension-format
The extension `Loader` provides a special support for merging Arrays.
By default, two collections will be merged into a single array unless objects have `id` properties.
-
-If array contains two objects with the same `id` property, the objects will be merged rather than appended.
-
+**Tip:** If the array contains two objects with the same `id` property, the objects will be merged rather than appended.
Before: Plugin 1
diff --git a/docs/extending/redistributable-libraries.md b/docs/extending/redistributable-libraries.md
index f73e8294d..d7502dccd 100644
--- a/docs/extending/redistributable-libraries.md
+++ b/docs/extending/redistributable-libraries.md
@@ -122,10 +122,8 @@ Update the root `package.json` file and append the following entry to the `scrip
You can now use that script to build the library and copy assets to the output folder.
-
-It is good practice to provide installation instructions for your library in the `README.md` file.
+**Tip:** It is good practice to provide installation instructions for your library in the `README.md` file.
Be sure to mention that developers should have a build rule to copy your plugin definition file to the `assets/plugins` folder of the main application.
-
## Publishing library to NPM
@@ -156,9 +154,7 @@ npm install my-extension
This installs the library and all its dependencies.
-
-You do not need to install the library in the original workspace as the application is already configured to use the local version from the `dist` folder.
-
+**Note:** You do not need to install the library in the original workspace as the application is already configured to use the local version from the `dist` folder.
### Copy assets
@@ -223,6 +219,4 @@ npm start
Click the `My Extension` link and in the main content area you will see the extension component coming from your library.
-
-Depending on the application setup, you may need enabling external plugins via the `Settings` dialog available for `admin` users (clicking the application profile button).
-
+**Note:** Depending on the application setup, you may need enabling external plugins via the `Settings` dialog available for `admin` users (clicking the application profile button).
diff --git a/docs/extending/registration.md b/docs/extending/registration.md
index 6d4f1515e..cf2500b1d 100644
--- a/docs/extending/registration.md
+++ b/docs/extending/registration.md
@@ -42,10 +42,8 @@ export class MyExtensionModule {
}
```
-
-According to Angular rules, all components that are created dynamically at runtime
+**Note:** According to Angular rules, all components that are created dynamically at runtime
need to be registered within the `entryComponents` section of the NgModule.
-
The Registration API is not limited to the custom content only.
You can replace any existing entries by replacing the values from your module.
diff --git a/docs/extending/routes.md b/docs/extending/routes.md
index 05169ed10..5ba8af0db 100644
--- a/docs/extending/routes.md
+++ b/docs/extending/routes.md
@@ -38,10 +38,8 @@ Use the `app.layout.main` value for the `layout` property to get the default app
with header, navigation sidebar and main content area.
You can register any component to back the `app.layout.main` value.
-
-By default, the `app.layout.main` is used if you do not specify any custom values.
+**Tip:** By default, the `app.layout.main` is used if you do not specify any custom values.
Use `blank` if you want your route component take the whole page.
-
You can define the full route schema like in the next example:
diff --git a/docs/extending/rules.md b/docs/extending/rules.md
index 1370c1e39..655443ceb 100644
--- a/docs/extending/rules.md
+++ b/docs/extending/rules.md
@@ -4,8 +4,7 @@ Title: Rules
# Rules
-Rules allow evaluating conditions for extension components.
-For example, you can disable or hide elements based on certain rules.
+Rules allow you to evaluate conditions for extension components, so you can disable or hide elements based on certain rules, for example.
Every rule is backed by a condition evaluator.
@@ -47,10 +46,8 @@ Rules can accept other rules as parameters:
}
```
-
-You can also negate any rule by utilizing a `!` prefix:
+**Tip:** You can also negate any rule by utilizing a `!` prefix:
`!app.navigation.isTrashcan` is the opposite of the `app.navigation.isTrashcan`.
-
It is also possible to use inline references to registered evaluators without declaring rules,
in case you do not need providing extra parameters, or chaining multiple rules together.
@@ -160,10 +157,8 @@ The application exposes a set of navigation-related evaluators to help developer
The negated evaluators are provided just to simplify development, and to avoid having complex rule trees just to negate the rules,
for example mixing `core.every` and `core.not`.
-
-You can also negate any rule by utilizing a `!` prefix:
+**Tip:** You can also negate any rule by utilizing a `!` prefix:
`!app.navigation.isTrashcan` is the opposite of the `app.navigation.isTrashcan`.
-
| Key | Description |
| --------------------------------- | ------------------------------------------------------- |
@@ -182,10 +177,8 @@ You can also negate any rule by utilizing a `!` prefix:
| app.navigation.isSearchResults | User is using the **Search Results** page. |
| app.navigation.isNotSearchResults | Current page is not the **Search Results**. |
-
-See [Registration](/extending/registration) section for more details
+**Tip:** See the [Registration](/extending/registration) section for more details
on how to register your own entries to be re-used at runtime.
-
### Example
diff --git a/docs/extending/tutorials.md b/docs/extending/tutorials.md
index e946e06b1..49c0d6bbc 100644
--- a/docs/extending/tutorials.md
+++ b/docs/extending/tutorials.md
@@ -4,6 +4,8 @@ Title: Tutorials
# Tutorials
+Below are some short tutorials that cover common tasks.
+
## Custom route with parameters
In this tutorial, we are going to implement the following features:
diff --git a/docs/features/document-list-layout.md b/docs/features/document-list-layout.md
index cf9cb4a71..1712ba179 100644
--- a/docs/features/document-list-layout.md
+++ b/docs/features/document-list-layout.md
@@ -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//`) 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//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//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.
-
-
- | Action |
- File |
- Folder |
-
-
-
- | View |
-
- Opens the selected file using the Preview component,
- where 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, when 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;
- once 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;
- 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. 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;
- once 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;
- once 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 |
-
-
-
+| 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
diff --git a/docs/features/file-viewer.md b/docs/features/file-viewer.md
index 998846f15..2f62e76fb 100644
--- a/docs/features/file-viewer.md
+++ b/docs/features/file-viewer.md
@@ -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.
diff --git a/docs/features/header.md b/docs/features/header.md
index fa2c15ca7..7696b4a76 100644
--- a/docs/features/header.md
+++ b/docs/features/header.md
@@ -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.
diff --git a/docs/features/info-drawer.md b/docs/features/info-drawer.md
index b10096d20..11d34bd9d 100644
--- a/docs/features/info-drawer.md
+++ b/docs/features/info-drawer.md
@@ -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.
diff --git a/docs/features/search-results.md b/docs/features/search-results.md
index 70772b279..45b381751 100644
--- a/docs/features/search-results.md
+++ b/docs/features/search-results.md
@@ -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.
diff --git a/docs/features/side-navigation.md b/docs/features/side-navigation.md
index bbe78d0d0..aa5434384 100644
--- a/docs/features/side-navigation.md
+++ b/docs/features/side-navigation.md
@@ -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.
diff --git a/docs/features/user-interface-layout.md b/docs/features/user-interface-layout.md
index 5d2f49d72..962785121 100644
--- a/docs/features/user-interface-layout.md
+++ b/docs/features/user-interface-layout.md
@@ -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)
diff --git a/docs/features/version-manager.md b/docs/features/version-manager.md
index a397b5c00..b25144bf5 100644
--- a/docs/features/version-manager.md
+++ b/docs/features/version-manager.md
@@ -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.
diff --git a/docs/getting-started/building-from-source.md b/docs/getting-started/building-from-source.md
index bf535d421..5cd2bc012 100644
--- a/docs/getting-started/building-from-source.md
+++ b/docs/getting-started/building-from-source.md
@@ -30,10 +30,8 @@ The Content App provides a proxy configuration for a local development server th
You can find settings in the "proxy.conf.js" file in the project root directory.
-
-The proxy settings get automatically applied every time you run the application with the "npm start" script.
+**Note:** The proxy settings get automatically applied every time you run the application with the "npm start" script.
You must restart the application every time you change its settings.
-
## Running unit tests
diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md
index 04bb1fbdb..fe039187f 100644
--- a/docs/getting-started/configuration.md
+++ b/docs/getting-started/configuration.md
@@ -73,10 +73,7 @@ If you run the application from a different server than the Content Services ser
}
```
-
-If you run the application as part of Tomcat and not in the root (subfolder), then "baseShareUrl" value should contain full address to the app, for example: "baseShareUrl": "http://{serveraddress}{:port}/{folder}".
-
-
+**Note:** If you run the application as part of Tomcat and not in the root (subfolder), then "baseShareUrl" value should contain full address to the app, for example: "baseShareUrl": "http://{serveraddress}{:port}/{folder}".
## Application settings
@@ -149,9 +146,7 @@ By default, the application ships with the following rules already predefined:
}
```
-
-You can get more details on the supported rules in the following article: Upload Service.
-
+**Tip:** You can find more details on the supported rules in the ADF [Upload Service](https://www.alfresco.com/abn/adf/docs/core/upload.service/) docs.
### Pagination settings
@@ -175,6 +170,5 @@ You can change the default settings of the pagination that gets applied to all t
You can store any information in the application configuration file, and access it at runtime by using the `AppConfigService` service provided by ADF.
-
-Please refer to the AppConfigService documentation to get more details on Application Configuration features and API's available.
-
+**Tip:** Please refer to the ADF
+[App Config Service](https://www.alfresco.com/abn/adf/docs/core/app-config.service/) documentation to get more details on the Application Configuration features and APIs available.
diff --git a/docs/getting-started/cors.md b/docs/getting-started/cors.md
index 07fae3339..cddddfd6a 100644
--- a/docs/getting-started/cors.md
+++ b/docs/getting-started/cors.md
@@ -5,6 +5,7 @@ Title: CORS
# CORS
The Alfresco Content Application comes with the proxy configuration for Angular CLI to address CORS-related issues for development.
+
Also, the docker images contain Nginx settings needed for CORS when developing and debugging an application locally.
## Chrome Workaround
diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md
index e52006ec1..350e2c4b9 100644
--- a/docs/getting-started/docker.md
+++ b/docs/getting-started/docker.md
@@ -4,7 +4,8 @@ Title: Docker
# Docker
-The ACA comes with the ACS 6.0 Community Edition preconfigured.
+ACA comes with the ACS 6.0 Community Edition preconfigured.
+
The application runs in two modes:
- Development (runs latest source code, requires building application)
@@ -29,9 +30,7 @@ npm run stop:docker
## Preview Mode
-
-With this mode, you do not need building application from source code or installing dependencies.
-
+**Tip:** With this mode, you do not need building application from source code or installing dependencies.
To run the latest published container go to the `docker-compose` folder and start docker compose from there:
diff --git a/docs/getting-started/internationalization.md b/docs/getting-started/internationalization.md
index 9d568d355..de9ebbaf5 100644
--- a/docs/getting-started/internationalization.md
+++ b/docs/getting-started/internationalization.md
@@ -23,7 +23,7 @@ The default language is English, however the current browser language is taken a
## User-defined language
You can allow users to set custom languages that are saved to their preferences.
-The main application menu already has the [ADF Language Menu](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/core/language-menu.component.md) component integrated and pre-filled with the supported items.
+The main application menu already has the [ADF Language Menu](https://www.alfresco.com/abn/adf/docs/core/language-menu.component/) component integrated and pre-filled with the supported items.
To change the default language set edit the `app.config.json` file and add or remove items:
@@ -80,7 +80,7 @@ You can copy the content over to your newly created file and replace the English
The Content Application automatically bundles your file when the project builds.
You can test your locale by changing the browser language settings and reloading the page.
-Optionally, you can extend the [ADF Language Menu](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/core/language-menu.component.md) component with the newly added language by updating the `app.config.json` file.
+Optionally, you can extend the [ADF Language Menu](https://www.alfresco.com/abn/adf/docs/core/language-menu.component/) component with the newly added language by updating the `app.config.json` file.
## Customizing ADF translations
diff --git a/docs/getting-started/navigation.md b/docs/getting-started/navigation.md
index 5ec08fb46..c684b366b 100644
--- a/docs/getting-started/navigation.md
+++ b/docs/getting-started/navigation.md
@@ -54,9 +54,7 @@ Navigation configuration supports array and object like schema. Defining an obje
`label` - represents the visual name of the link. It can be a string or a i18n defined reference.
-
- Changing ` "route": { "url": "/..." } ` value will affect the navigation since these are mapped to application routing system.
-
+**Caution:** Changing ` "route": { "url": "/..." } ` value will affect the navigation since these are mapped to application routing system.
### Custom text (i18n)
diff --git a/docs/getting-started/prerequisites.md b/docs/getting-started/prerequisites.md
index e3fd3d00c..5cb03903d 100644
--- a/docs/getting-started/prerequisites.md
+++ b/docs/getting-started/prerequisites.md
@@ -10,9 +10,7 @@ This application uses the latest releases from Alfresco:
- [Alfresco Content Services (6.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.
-
+**Note:** You also need [Node.js](https://nodejs.org/en/) (LTS) installed to build it locally from source code.
The latest version of the Alfresco Content platform is required
due to the application using the latest [REST APIs](https://docs.alfresco.com/5.2/pra/1/topics/pra-welcome.html) developments.
\ No newline at end of file