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-3745] Doc review updates (#4165)

Browse Source 
* [ADF-3745] Doc review

* [ADF-3745] Minor fix to task attach list docs
This commit is contained in:
Andy Stark
2019-01-15 15:12:53 +00:00
committed by Eugenio Romano
parent 9dfac14931
commit 24a7c939e6
14 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/content-services/rating.component.md
View File

@@ -2,6 +2,7 @@
Title: Rating component Title: Rating component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2019-01-14
--- ---
# [Rating component](../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts") # [Rating component](../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts")

2
docs/process-services/apps-list.component.md
View File

@@ -2,7 +2,7 @@
Title: Apps List Component Title: Apps List Component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-06-08 Last reviewed: 2019-01-14
--- ---
# [Apps List Component](../../lib/process-services/app-list/apps-list.component.ts "Defined in apps-list.component.ts") # [Apps List Component](../../lib/process-services/app-list/apps-list.component.ts "Defined in apps-list.component.ts")

3
docs/process-services/create-process-attachment.component.md
View File

@@ -2,11 +2,12 @@
Title: Create Process Attachment component Title: Create Process Attachment component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2019-01-14
--- ---
# [Create Process Attachment component](../../lib/process-services/attachment/create-process-attachment.component.ts "Defined in create-process-attachment.component.ts") # [Create Process Attachment component](../../lib/process-services/attachment/create-process-attachment.component.ts "Defined in create-process-attachment.component.ts")
Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance.
![process-create-attachment](../docassets/images/process-create-attachment.png) ![process-create-attachment](../docassets/images/process-create-attachment.png)

3
docs/process-services/create-task-attachment.component.md
View File

@@ -2,11 +2,12 @@
Title: Create Task Attachment Component Title: Create Task Attachment Component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2019-01-14
--- ---
# [Create Task Attachment Component](../../lib/process-services/attachment/create-task-attachment.component.ts "Defined in create-task-attachment.component.ts") # [Create Task Attachment Component](../../lib/process-services/attachment/create-task-attachment.component.ts "Defined in create-task-attachment.component.ts")
Displays Upload Component (Drag and Click) to upload the attachment to a specified task Displays an Upload Component (Drag and Click) to upload the attachment to a specified task.
![task-create-attachment](../docassets/images/task-create-attachment.png) ![task-create-attachment](../docassets/images/task-create-attachment.png)

8
docs/process-services/people-list.component.md
View File

@@ -2,7 +2,7 @@
Title: People list component Title: People list component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-11-14 Last reviewed: 2019-01-14
--- ---
# [People list component](../../lib/process-services/people/components/people-list/people-list.component.ts "Defined in people-list.component.ts") # [People list component](../../lib/process-services/people/components/people-list/people-list.component.ts "Defined in people-list.component.ts")
@@ -44,7 +44,8 @@ export class SomeComponent implements OnInit {
} }
``` ```
In the component template use the [people list component](../process-services/people-list.component.md): You can use column templates with the [people list component](../process-services/people-list.component.md), since it is based on the
[Datatable component](../core/datatable.component.md):
<!-- {% raw %} --> <!-- {% raw %} -->
@@ -71,9 +72,6 @@ In the component template use the [people list component](../process-services/pe
<!-- {% endraw %} --> <!-- {% endraw %} -->
Note that the [people list component](../process-services/people-list.component.md) is based on the
[Datatable component](../core/datatable.component.md).
## Class members ## Class members
### Properties ### Properties

4
docs/process-services/process-attachment-list.component.md
View File

@@ -2,12 +2,12 @@
Title: Process Attachment List component Title: Process Attachment List component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-03-21 Last reviewed: 2019-01-14
--- ---
# [Process Attachment List component](../../lib/process-services/attachment/process-attachment-list.component.ts "Defined in process-attachment-list.component.ts") # [Process Attachment List component](../../lib/process-services/attachment/process-attachment-list.component.ts "Defined in process-attachment-list.component.ts")
Displays attached documents on a specified process instance Displays documents attached to a specified process instance.
![process-attachment-list-sample](../docassets/images/process-attachment-list.png) ![process-attachment-list-sample](../docassets/images/process-attachment-list.png)

3
docs/process-services/process-audit.directive.md
View File

@@ -2,11 +2,12 @@
Title: Process Audit Directive Title: Process Audit Directive
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2019-01-14
--- ---
# [Process Audit Directive](../../lib/process-services/process-list/components/process-audit.directive.ts "Defined in process-audit.directive.ts") # [Process Audit Directive](../../lib/process-services/process-list/components/process-audit.directive.ts "Defined in process-audit.directive.ts")
Fetches the Process Audit information the PDF or JSON format. Fetches the Process Audit information in PDF or JSON format.
![adf-process-audit-directive](../docassets/images/adf-process-audit-directive.png) ![adf-process-audit-directive](../docassets/images/adf-process-audit-directive.png)

2
docs/process-services/process-instance-header.component.md
View File

@@ -2,7 +2,7 @@
Title: Process Instance Details Header component Title: Process Instance Details Header component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-06-08 Last reviewed: 2019-01-14
--- ---
# [Process Instance Details Header component](../../lib/process-services/process-list/components/process-instance-header.component.ts "Defined in process-instance-header.component.ts") # [Process Instance Details Header component](../../lib/process-services/process-list/components/process-instance-header.component.ts "Defined in process-instance-header.component.ts")

1
docs/process-services/select-apps-dialog.component.md
View File

@@ -2,6 +2,7 @@
Title: Select App Component Title: Select App Component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2019-01-14
--- ---
# [Select App Component](../../lib/process-services/app-list/select-apps-dialog-component.ts "Defined in select-apps-dialog-component.ts") # [Select App Component](../../lib/process-services/app-list/select-apps-dialog-component.ts "Defined in select-apps-dialog-component.ts")

2
docs/process-services/start-process.component.md
View File

@@ -2,7 +2,7 @@
Title: Start Process component Title: Start Process component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-11-13 Last reviewed: 2019-01-14
--- ---
# [Start Process component](../../lib/process-services/process-list/components/start-process.component.ts "Defined in start-process.component.ts") # [Start Process component](../../lib/process-services/process-list/components/start-process.component.ts "Defined in start-process.component.ts")

4
docs/process-services/start-task.component.md
View File

@@ -2,12 +2,12 @@
Title: Start Task Component Title: Start Task Component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-11-13 Last reviewed: 2019-01-14
--- ---
# [Start Task Component](../../process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts") # [Start Task Component](../../process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts")
Creates/Starts a new task for the specified app Creates/Starts a new task for the specified app.
![adf-start-task](../docassets/images/adf-start-task.png) ![adf-start-task](../docassets/images/adf-start-task.png)

8
docs/process-services/task-attachment-list.component.md
View File

@@ -2,12 +2,12 @@
Title: Task Attachment List Component Title: Task Attachment List Component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-03-13 Last reviewed: 2019-01-14
--- ---
# [Task Attachment List Component](../../lib/process-services/attachment/task-attachment-list.component.ts "Defined in task-attachment-list.component.ts") # [Task Attachment List Component](../../lib/process-services/attachment/task-attachment-list.component.ts "Defined in task-attachment-list.component.ts")
Displays attached documents on a specified task. Displays documents attached to a specified task.
![task-attachment-list-sample](../docassets/images/task-attachment-list.png) ![task-attachment-list-sample](../docassets/images/task-attachment-list.png)
@@ -103,4 +103,6 @@ export class MyCustomTaskAttachmentComponent {
} }
``` ```
[Upload Drag Area Component](../content-services/upload-drag-area.component.md) ## See also
- [Upload Drag Area Component](../content-services/upload-drag-area.component.md)

1
docs/process-services/task-audit.directive.md
View File

@@ -2,6 +2,7 @@
Title: Task Audit Directive Title: Task Audit Directive
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2019-01-14
--- ---
# [Task Audit Directive](../../lib/process-services/task-list/components/task-audit.directive.ts "Defined in task-audit.directive.ts") # [Task Audit Directive](../../lib/process-services/task-list/components/task-audit.directive.ts "Defined in task-audit.directive.ts")

2
docs/process-services/task-header.component.md
View File

@@ -2,7 +2,7 @@
Title: Task Header component Title: Task Header component
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-11-13 Last reviewed: 2019-01-14
--- ---
# [Task Header component](../../lib/process-services/task-list/components/task-header.component.ts "Defined in task-header.component.ts") # [Task Header component](../../lib/process-services/task-list/components/task-header.component.ts "Defined in task-header.component.ts")