mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4249] Doc review updates (#4524)
* [ADF-4249] Edit latest changes to release notes * [ADF-4249] Fixed links
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
3f05bdc009
commit
95ee2bca71
@@ -21,16 +21,21 @@ If you want to be updated on the [ADF roadmap](../roadmap.md), check the public
|
||||
- [Single Sign On enhancement](#single-sign-on-enhancement)
|
||||
- [JS-API in Typescript](#js-api-in-typescript)
|
||||
- [Angular 7](#angular-7)
|
||||
- [Create library Component](#create-library-component)
|
||||
- [Tree view component](#tree-view-component)
|
||||
- [Deprecation removal](#deprecation-removal)
|
||||
- [Activiti 7 support](#activiti-7-support-experimental)
|
||||
- [Icon Component](#icon-component)
|
||||
- [Activiti 7 support (Experimental)](#activiti-7-support-experimental)
|
||||
- [Localization](#localization)
|
||||
- [References](#references)
|
||||
- [Icon Component](#icon-component)
|
||||
- [Issues addressed](#issues-addressed)
|
||||
- [Documentation](#documentation)
|
||||
- [Feature](#feature)
|
||||
- [Epic](#epic)
|
||||
- [Story](#story)
|
||||
- [Bug](#bug)
|
||||
- [Task](#task)
|
||||
- [Feature Documentation](#feature-documentation)
|
||||
- [Feature Bug](#feature-bug)
|
||||
- [Feature (Task)](#feature-task)
|
||||
|
||||
@@ -121,7 +126,7 @@ This rewrite has been necessary to make the JS-API lighter and faster with the
|
||||
|
||||
Note that the following old package names have been deprecated: **alfresco-js-api**, **alfresco-js-api-node**.
|
||||
|
||||
The Node and Browser version are now both in: **_@alfresco/js-api_**
|
||||
The [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) and Browser version are now both in: **_@alfresco/js-api_**
|
||||
Refer to the official [Alfresco JS-API documenation](https://github.com/Alfresco/alfresco-js-api) to learn more about this.
|
||||
|
||||
### Angular 7
|
||||
@@ -144,7 +149,7 @@ You can now create a new Content Services document library/site with the Create
|
||||
|
||||
|
||||
|
||||
Shows the folder and subfolders of a node as a tree view. For more information about the Tree View component, see the [component documentation](../content-services/components/tree-view.component.md)
|
||||
Shows the folder and subfolders of a node as a tree view. For more information about the [Tree View component,](../content-services/components/tree-view.component.md) see the [component documentation](../content-services/components/tree-view.component.md)
|
||||
|
||||
#### Basic Usage
|
||||
|
||||
@@ -201,7 +206,7 @@ links to documentation and source code:
|
||||
| [Start process cloud service](../process-services-cloud/services/start-process-cloud.service.md)  | Gets process definitions and starts processes. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
||||
| [Start task cloud service](../process-services-cloud/services/start-task-cloud.service.md)  | Starts standalone tasks. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
||||
| [Task filter cloud service](../process-services-cloud/services/task-filter-cloud.service.md)  | Manages task filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| [Task cloud service](../process-services-cloud/services/task-cloud.service.md)  | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) |
|
||||
| [Task cloud service](../process-services-cloud/services/task-cloud.service.md)  | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) |
|
||||
| [Task list cloud service](../process-services-cloud/services/task-list-cloud.service.md)  | Searches tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
|
||||
<!--process-services-cloud end-->
|
||||
@@ -226,7 +231,7 @@ Please refer to the [official documentation](http://docs.alfresco.com/) for furt
|
||||
|
||||
### Icon Component
|
||||
|
||||
Universal icon component that supports Material Ligatures and custom registered SVG icons in the same format.
|
||||
Universal [icon component](../core/components/icon.component.md) that supports Material Ligatures and custom registered SVG icons in the same format.
|
||||
|
||||
```html
|
||||
<!-- Font ligature -->
|
||||
@@ -239,7 +244,7 @@ Universal icon component that supports Material Ligatures and custom registered
|
||||
<adf-icon value="my-company:my-icon"></adf-icon>
|
||||
```
|
||||
|
||||
See Icon Component [documentation](../core/components/icon.component.md) for more details.
|
||||
See [Icon Component](../core/components/icon.component.md) [documentation](../core/components/icon.component.md) for more details.
|
||||
|
||||
## Issues addressed
|
||||
|
||||
|
||||
@@ -75,10 +75,10 @@ In ADF 3.0.0 (released in February) we announced the introduction of the new `*C
|
||||
<button adf-claim-task [appName]="appName" [taskId]="taskId" (success)="onTaskClaimed()">Complete</button>
|
||||
```
|
||||
|
||||
Please for more details refer to the :
|
||||
- [Claim a task](../process-services-cloud/directives/claim-task.directive.md)
|
||||
For more details refer to the :
|
||||
- [Claim task directive](../process-services-cloud/directives/claim-task.directive.md)
|
||||
|
||||
#### EditTaskComponent allow sorting and actions customization
|
||||
#### EditTaskComponent allows sorting and actions customization
|
||||
You can supply various _filter properties_ to edit that will determine
|
||||
which tasks are found by a filter.
|
||||
|
||||
@@ -86,7 +86,7 @@ By default, the **_id_**, **_name_**, **_createdDate_** and **_priority_** prop
|
||||
displayed in the editor. However, you can also choose which sort properties
|
||||
to show using the `sortProperties` array.
|
||||
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Edit Task Filter Cloud component](../process-services-cloud/components/edit-task-filter-cloud.component.md)
|
||||
|
||||
#### EditProcessComponent allow sorting and actions customization
|
||||
@@ -97,7 +97,7 @@ By default, the **_status_**, **_sort_** and **_order_** properties are
|
||||
displayed in the editor. However, you can also choose which properties
|
||||
to show using the `filterProperties` array.
|
||||
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Edit Process Filter Cloud component](../process-services-cloud/components/edit-process-filter-cloud.component.md)
|
||||
|
||||
#### Complete task directive
|
||||
@@ -105,7 +105,7 @@ Please for more details refer to the :
|
||||
```html
|
||||
<button adf-cloud-complete-task [appName]="appName" [taskId]="taskId" (success)="onTaskCompleted()">Complete</button>
|
||||
```
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Complete task directive](../process-services-cloud/directives/complete-task.directive.md)
|
||||
|
||||
### Enhanced DocumentList
|
||||
@@ -130,7 +130,7 @@ First, set the `stickyHeader` property of your datatable to `true`:
|
||||
</adf-document-list>
|
||||
```
|
||||
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Document List Component](../content-services/components/document-list.component.md)
|
||||
- [DataTable component](../core/components/datatable.component.md)
|
||||
|
||||
@@ -138,7 +138,7 @@ Please for more details refer to the :
|
||||
|
||||
As of this version of ADF, developers can include the full list of types/aspects into the metadata viewer, without the need to specify all of them. The limit of the previous version was that developers were requested to specify the list of types/aspects or an asterisk to say "include all". The use case represented by "include all except X, Y, Z..." was not covered but now it is.
|
||||
|
||||
You can list all the properties by simply adding the `includeAll: boolean` to your config. This config will display all the aspects and properties available for that specific file.
|
||||
You can list all the properties by simply adding `includeAll: boolean` to your config. This config will display all the aspects and properties available for that specific file.
|
||||
|
||||
```json
|
||||
"content-metadata": {
|
||||
@@ -163,7 +163,7 @@ Futhermore, you can also exclude specific aspects by adding the `exclude` proper
|
||||
}
|
||||
```
|
||||
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Content Metadata Card component](../content-services/components/content-metadata-card.component.md)
|
||||
|
||||
### Search pattern highlight
|
||||
@@ -202,7 +202,7 @@ The example above changes the highlighting prefix and postfix from the default
|
||||
fields except the "description" field, which uses '()' instead. The highlight information will
|
||||
then be added in each node entry response.
|
||||
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Search Filter component highlight](../content-services/components/search-filter.component.md#highlight)
|
||||
|
||||
|
||||
@@ -259,14 +259,14 @@ for further details about the structure and properties of `intervals` that you c
|
||||
Each defined `intervals` item is collected into its own collapsible category identified uniquely
|
||||
by its `label`. The code snippet just above will result in the following display of facet intervals:
|
||||
|
||||
|
||||
|
||||
|
||||
Please for more details refer to the :
|
||||
- [Facet intervals](../content-services/components/search-filter.component.md#facet-intervals)
|
||||
For more details refer to the :
|
||||
- [Facet intervals section of the Search Filter Component docs](../content-services/components/search-filter.component.md#facet-intervals)
|
||||
|
||||
|
||||
### SSO Role AuthGuard
|
||||
The [Auth Guard SSO role service](../../core/services/auth-guard-sso-role.service.md) implements an Angular
|
||||
The [Auth Guard SSO role service](../core/services/auth-guard-sso-role.service.md) implements an Angular
|
||||
[route guard](https://angular.io/guide/router#milestone-5-route-guards)
|
||||
to check the user has the right role permission. This is typically used with the
|
||||
`canActivate` guard check in the route definition. The roles that user needs to have in order to access the route has to be specified in the roles array as in the example below:
|
||||
@@ -284,7 +284,7 @@ const appRoutes: Routes = [
|
||||
]
|
||||
```
|
||||
|
||||
Please for more details refer to the :
|
||||
For more details refer to the :
|
||||
- [Facet intervals](../core/services/auth-guard-sso-role.service.md)
|
||||
|
||||
### Improved accessibility
|
||||
|
||||
Reference in New Issue
Block a user