documentation review (#5802)

docs/process-services/components/process-list.component.md

@@ -73,7 +73,7 @@ when the process list is empty:
 | ---- | ---- | ----------- |
 | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
 | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a row in the process list is clicked. |
-| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
+| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
 | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. |
 
 ## Details

docs/process-services/components/start-process.component.md

@@ -22,6 +22,8 @@ Starts a process.
     -   [Starting a process not included in an app](#starting-a-process-not-included-in-an-app)
     -   [Custom data example](#custom-data-example)
     -   [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process)
+    -   [Starting a process with a selected application](#starting-a-process-with-a-selected-application)
+    -   [Error handling](#error-handling)
 -   [See also](#see-also)
 
 ## Basic Usage
@@ -42,8 +44,8 @@ Starts a process.
 | name | `string` | "" | (optional) Name to assign to the current process. |
 | processDefinitionName | `string` |  | (optional) Definition name of the process to start. |
 | processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. |
+| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. |
 | showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. |
-| showSelectApplicationDropdown | `boolean` | false | application selection dropdown. |
 | title | `string` |  | (optional) Define the header of the component. |
 | values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) |  | Parameter to pass form field values in the start form if one is associated. |
 | variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` |  | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/RestVariable.md). |
@@ -52,8 +54,9 @@ Starts a process.
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process is canceled. |
-| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when an error occurs. |
+| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. |
+| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the process is canceled. |
+| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
 | processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`>` | Emitted when process definition selection changes. |
 | start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. |
 
@@ -194,7 +197,6 @@ You can use the `showSelectApplicationDropdown` property to Hide or show applica
 
 ![Start process with selected application](../../docassets/images/start-process-with-selected-application.png)
 
-
 ### Error handling
 
 When an error occurs, the component will emit an error event that can be used to handle errors. Example:

docs/process-services/components/task-form.component.md

@@ -48,7 +48,7 @@ Shows a [`form`](../../../lib/process-services/src/lib/task-list/models/form.mod
 | formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
 | showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the form associated with the form task is attached. |
 | taskClaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the task is claimed. |
-| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the task is unclaimed (ie, requeued). |
+| taskUnclaimed | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the task is unclaimed (ie, requeued).. |
 
 ## See also
 

docs/process-services/components/task-header.component.md

@@ -26,8 +26,8 @@ Shows all the information related to a task.
 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
 | formName | `string` | null | The name of the form. |
-| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) |  | (required) Details related to the task. |
 | showClaimRelease | `boolean` | true | Toggles display of the claim/release button. |
+| taskDetails | [`TaskDetailsModel`](../../../lib/process-services/src/lib/task-list/models/task-details.model.ts) |  | (required) Details related to the task. |
 
 ### Events
 

docs/process-services/components/task-list.component.md

@@ -83,7 +83,7 @@ when the task list is empty:
 | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
 | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task in the list is clicked |
 | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected |
-| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
+| showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. |
 | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task list is loaded |
 
 ## Details

docs/process-services/directives/claim-task.directive.md

@@ -21,11 +21,11 @@ Claims a task
 
 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
-| taskId | `string` | "" | (Required) The id of the task. |
+| 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. |
+| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be claimed. |
+| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |

docs/process-services/pipes/process-name.pipe.md

@@ -8,22 +8,26 @@ Last reviewed: 2020-06-02
 # [Process name pipe](../../../lib/process-services/src/lib/pipes/process-name.pipe.ts "Defined in process-name.pipe.ts")
 
 When an identifier is specified, the input will be transformed replacing the identifiers with the values of the selected process definition provided.
+
 ## Basic Usage
+
 processNamePipe.transform('Example - %{processDefinition} - %{datetime}', new ProcessDefinitionRepresentation({ name: 'upload-passport'}));
+
 ### Properties
 
 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
 | processNameFormat | string | undefined | The process name format including the preferred identifiers to be used |
-| selectedProcessDefinition | ProcessDefinitionRepresentation | undefined | (optional) The selected process definition |
+| selectedProcessDefinition | [`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md) | undefined | (optional) The selected process definition |
 
 ## Details
+
 The pipe offers a convenient way to format a process name using a process name format template.
 
 The supported identifiers that can be used in the process name format are the following:
 
-- %{processDefinition}
-- %{datetime}
+-   %{processDefinition}
+-   %{datetime}
 
 When the %{processDefinition} identifier is used, the selected process definition provided
 will be added and positioned in the same place as the identifier.
@@ -31,10 +35,11 @@ will be added and positioned in the same place as the identifier.
 When the %{datetime} identifier is used, the current datetime will be added and positioned in the same place as the identifier.
 
 Important Notes:
-- All the identifiers are case-insensitive.
-- The identifiers can be used in any position (beginning, middle, end, custom).
-- The identifiers can NOT be used more than once each in the same processNameFormat (The second occurrence of each identifier will be ignored
-and handled as a plain string).
+
+-   All the identifiers are case-insensitive.
+-   The identifiers can be used in any position (beginning, middle, end, custom).
+-   The identifiers can NOT be used more than once each in the same processNameFormat (The second occurrence of each identifier will be ignored
+    and handled as a plain string).
 
 #### Result
 

docs/process-services/services/process-filter.service.md

@@ -39,9 +39,10 @@ Manage Process Filters, which are pre-configured Process Instance queries.
     Gets all filters defined for a Process App.
     -   _appId:_ `number`  - ID of the target app
     -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)`[]>` - Array of filter details
--   **getRunningFilterInstance**(appId: `number`): [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)<br/>
+-   **getRunningFilterInstance**(appId: `number`, index?: `number`): [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts)<br/>
     Creates and returns a filter that matches "running" process instances.
     -   _appId:_ `number`  - ID of the target app
+    -   _index:_ `number`  - (Optional) of the filter (optional)
     -   **Returns** [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) - Filter just created
 
 ## Details

docs/process-services/services/task-filter.service.md

@@ -25,21 +25,25 @@ Manage Task Filters, which are pre-configured Task Instance queries.
     Creates and returns the default filters for a process app.
     -   _appId:_ `number`  - ID of the target app
     -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`[]>` - Array of default filters just created
--   **getCompletedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
+-   **getCompletedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
     Creates and returns a filter for "Completed" task instances.
     -   _appId:_ `number`  - ID of the target app
+    -   _index:_ `number`  - (Optional) of the filter (optional)
     -   **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter
--   **getInvolvedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
+-   **getInvolvedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
     Creates and returns a filter for "Involved" task instances.
     -   _appId:_ `number`  - ID of the target app
+    -   _index:_ `number`  - (Optional) of the filter (optional)
     -   **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter
--   **getMyTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
+-   **getMyTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
     Creates and returns a filter for "My Tasks" task instances.
     -   _appId:_ `number`  - ID of the target app
+    -   _index:_ `number`  - (Optional) of the filter (optional)
     -   **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter
--   **getQueuedTasksFilterInstance**(appId: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
+-   **getQueuedTasksFilterInstance**(appId: `number`, index?: `number`): [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)<br/>
     Creates and returns a filter for "Queued Tasks" task instances.
     -   _appId:_ `number`  - ID of the target app
+    -   _index:_ `number`  - (Optional) of the filter (optional)
     -   **Returns** [`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) - The newly created filter
 -   **getTaskFilterById**(filterId: `number`, appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>`<br/>
     Gets a task filter by ID.