inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-4249] Updates for doc review (#4494)

Browse Source 
* [ADF-4249] Doc review updates

* [ADF-4249] Updated doc index pages

* [ADF-4249] Minor corrections to un/claim task docs
This commit is contained in:
Andy Stark
2019-03-26 10:18:44 +00:00
committed by Eugenio Romano
parent 04c6436ed2
commit cec08f50d7
11 changed files with 83 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -419,7 +419,9 @@ for more information about installing and using the source code.
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Claim Task Directive](process-services-cloud/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claim a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts) |
| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) |
| [Unclaim Task Directive](process-services-cloud/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaim a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts) |
### Pipes

10
docs/core/components/viewer.component.md
View File

@@ -2,7 +2,7 @@
Title: Viewer component
Added: v2.0.0
Status: Active
Last reviewed: 2019-01-16
Last reviewed: 2019-03-25
---
# [Viewer component](../../../lib/core/viewer/components/viewer.component.ts "Defined in viewer.component.ts")
@@ -24,7 +24,7 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/)
- [Custom file parameters](#custom-file-parameters)
- [Supported file formats](#supported-file-formats)
- [Content Renditions](#content-renditions)
- [Configuring PDF.js library](#configuring-pdfjs-library)
- [Configuring PDF.js library](#configuring-pdf-js-library)
- [Extending the Viewer](#extending-the-viewer)
- [Custom layout](#custom-layout)
- [Printing](#printing)
@@ -179,7 +179,7 @@ You can provide custom file parameters, for example a value for the `mimeType` o
### Supported file formats
The [Viewer component](viewer.component.md) consists of separate Views that handle particular types or type families based on either a file extension or a mime type:
The [Viewer component](viewer.component.md) consists of separate Views that handle particular file types or type families based on either a file extension or a mime type:
- PDF View
- application/pdf
@@ -223,7 +223,7 @@ The [Viewer component](viewer.component.md) consists of separate Views that hand
### Content Renditions
For those extensions and mime types that cannot be natively displayed in the browser, the Viewer will try to fetch the corresponding rendition using the [renditions service api](https://community.alfresco.com/docs/DOC-5879-rendition-service).
For those extensions and mime types that cannot be natively displayed in the browser, the Viewer will try to fetch the corresponding rendition using the [renditions service api](../services/renditions.service.md).
For the full list of supported types please refer to: [File types that support preview and thumbnail generation](http://docs.alfresco.com/5.2/references/valid-transformations-preview.html).
@@ -261,7 +261,7 @@ new CopyWebpackPlugin([
])
```
The [Viewer component](viewer.component.md) now should be able to display PDF files.
The [Viewer component](viewer.component.md) should now be able to display PDF files.
### Extending the Viewer

26
docs/process-services-cloud/claim-task.directive.md
View File

@@ -1,26 +0,0 @@
---
Title: Claim Task Directive
Added: v3.1.0
Status: Experimental
Last reviewed: 2019-03-05
---
# [Claim task directive](../../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts "Defined in claim-task.directive.ts")
Claim a task
## Basic Usage
```html
<button adf-claim-task [appName]="appName" [taskId]="taskId" (success)="onTaskClaimed()">Complete</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| taskId | `string` | empty |(Required) The id of the task. |
| appName | `string` | empty | (Required) The name of the application. |
| success | `EventEmitter<any>` | empty | Emitted when the task is completed. |
| error | `EventEmitter<any>` | empty | Emitted when the task cannot be completed. |

5
docs/process-services-cloud/components/process-list-cloud.component.md
View File

@@ -2,7 +2,7 @@
Title: Process Instance List Cloud component
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-03-20
Last reviewed: 2019-03-25
---
# [Process Instance List Cloud component](../../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts")
@@ -51,13 +51,14 @@ when the process list is empty:
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | The name of the application. |
| businessKey | `string` | "" | Filter the tasks to display only the ones with this businessKey value. |
| businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. |
| id | `string` | "" | Filter the processes to display only the ones with this ID. |
| initiator | `string` | "" | Name of the initiator of the process. |
| lastModifiedFrom | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. |
| lastModifiedTo | `string` | "" | Filter the processes. Display only process with lastModifiedTo equal to the supplied date. |
| multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row |
| name | `string` | "" | Filter the processes to display only the ones with this name. |
| presetColumn | `string` | | Custom preset column schema in JSON format. |
| processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. |
| processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. |
| selectionMode | `string` | "single" | Row selection mode. Can be "none", "single" or "multiple". For multiple mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |

2
docs/process-services-cloud/components/task-list-cloud.component.md
View File

@@ -2,7 +2,7 @@
Title: Task List Cloud component
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-03-20
Last reviewed: 2019-03-25
---
# [Task List Cloud component](../../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts")

32
docs/process-services-cloud/directives/claim-task.directive.md Normal file
View File

@@ -0,0 +1,32 @@
---
Title: Claim Task Directive
Added: v3.1.0
Status: Experimental
Last reviewed: 2019-03-25
---
# [Claim task directive](../../../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts "Defined in claim-task.directive.ts")
Claims a task
## Basic Usage
```html
<button adf-claim-task [appName]="appName" [taskId]="taskId" (success)="onTaskClaimed()">Complete</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | (Required) The name of the application. |
| taskId | `string` | | (Required) The id of the task. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is completed. |

32
docs/process-services-cloud/directives/unclaim-task.directive.md Normal file
View File

@@ -0,0 +1,32 @@
---
Title: Unclaim Task Directive
Added: v3.1.0
Status: Experimental
Last reviewed: 2019-03-25
---
# [Unclaim task directive](../../../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts "Defined in unclaim-task.directive.ts")
Unclaims a task
## Basic Usage
```html
<button adf-unclaim-task [appName]="appName" [taskId]="taskId" (success)="onTaskUnclaimed()">Complete</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | (Required) The name of the application. |
| taskId | `string` | | (Required) The id of the task. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is completed. |

8
docs/process-services-cloud/services/process-list-cloud.service.md
View File

@@ -2,7 +2,7 @@
Title: Process List Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-02-06
Last reviewed: 2019-03-25
---
# [Process List Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts "Defined in process-list-cloud.service.ts")
@@ -26,7 +26,7 @@ must at minimum have the `appName` property correctly set.
## Activiti 7
If you are generating a project for activiti7 you need to add in the **app.config.json** the list of the apps that you desire to use.
If you are generating a project for Activiti 7, you must add the list of apps you want to use in **app.config.json** .
For example :
@@ -34,4 +34,6 @@ For example :
"alfresco-deployed-apps" : [{"name": "simple-app"}]
```
For more information about the app list component refer to the [documentation](https://github.com/Alfresco/alfresco-ng2-components/blob/development/docs/process-services-cloud/app-list-cloud.component.md)
## See also
- [App list cloud component](../components/app-list-cloud.component.md)

26
docs/process-services-cloud/unclaim-tas.directie.md
View File

@@ -1,26 +0,0 @@
---
Title: Unclaim Task Directive
Added: v3.1.0
Status: Experimental
Last reviewed: 2019-03-05
---
# [Unclaim task directive](../../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts "Defined in unclaim-task.directive.ts")
Unclaim a task
## Basic Usage
```html
<button adf-unclaim-task [appName]="appName" [taskId]="taskId" (success)="onTaskUnclaimed()">Complete</button>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| taskId | `string` | empty |(Required) The id of the task. |
| appName | `string` | empty | (Required) The name of the application. |
| success | `EventEmitter<any>` | empty | Emitted when the task is completed. |
| error | `EventEmitter<any>` | empty | Emitted when the task cannot be completed. |

2
docs/versionIndex.md
View File

@@ -29,9 +29,11 @@ backend services have been tested with each released version of ADF.
<!--v310 start-->
- [Auth guard sso role service](core/services/auth-guard-sso-role.service.md)
- [Claim task directive](process-services-cloud/directives/claim-task.directive.md)
- [Complete task directive](process-services-cloud/directives/complete-task.directive.md)
- [Preview extension component](extensions/components/preview-extension.component.md)
- [Task cloud service](process-services-cloud/services/task-cloud.service.md)
- [Unclaim task directive](process-services-cloud/directives/unclaim-task.directive.md)
<!--v310 end-->

1
tools/doc/doctool.config.json
View File

@@ -124,6 +124,7 @@
"tasklist.service": "TaskListService",
"text-highlight.pipe": "HighlightPipe",
"text-mask.component": "InputMaskDirective",
"unclaim-task.directive": "UnClaimTaskDirective",
"user-initial.pipe": "InitialUsernamePipe"
},
"undocStoplist": [