diff --git a/docs/accordion-group.component.md b/docs/accordion-group.component.md index 884e2cbc53..9def0e6bef 100644 --- a/docs/accordion-group.component.md +++ b/docs/accordion-group.component.md @@ -4,19 +4,6 @@ Adds a collapsible panel to an [accordion menu](accordion.component.md). ![Accordion menu screenshot](docassets/images/accordion-menu.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) -- [Details](#details) -- [See also](#see-also) - - - - - ## Basic Usage ```html @@ -54,8 +41,7 @@ export class MyComponent implements OnInit { ## Details -Place one or more accordion groups within an [Accordion component](accordion.component.md) to define -a menu. +Place one or more accordion groups within an [Accordion component](accordion.component.md) to define a menu. diff --git a/docs/accordion.component.md b/docs/accordion.component.md index 75d42e6de0..c7c1867298 100644 --- a/docs/accordion.component.md +++ b/docs/accordion.component.md @@ -4,20 +4,6 @@ Creates a collapsible accordion menu. ![Accordion menu screenshot](docassets/images/accordion-menu.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) -- [Details](#details) - * [Example](#example) -- [See also](#see-also) - - - - - ## Basic Usage ```html diff --git a/docs/analytics-generator.component.md b/docs/analytics-generator.component.md index e9be5b6f73..4d5c77fc61 100644 --- a/docs/analytics-generator.component.md +++ b/docs/analytics-generator.component.md @@ -1,18 +1,6 @@ # Analytics Generator Component -The component generates and shows the charts - - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - +Generates and shows charts ## Basic Usage @@ -35,4 +23,11 @@ The component generates and shows the charts | Name | Description | | --- | --- | | success | Raised when the charts are loaded | -| error | Raised when an error occurs during the loading | \ No newline at end of file +| error | Raised when an error occurs during the loading | + + + +## See also + + + \ No newline at end of file diff --git a/docs/analytics-report-list.component.md b/docs/analytics-report-list.component.md index fbc41f1356..a30a948984 100644 --- a/docs/analytics-report-list.component.md +++ b/docs/analytics-report-list.component.md @@ -1,18 +1,6 @@ # Activiti Analytics List Component -The component shows the list of all the available reports - - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - +Shows a list of all available reports ## Basic Usage @@ -37,3 +25,10 @@ The component shows the list of all the available reports | success | The event is emitted when the report list is loaded | | error | The event is emitted when an error occurs during the loading | | reportClick | The event is emitted when the report in the list is selected | + + + +## See also + + + \ No newline at end of file diff --git a/docs/analytics.component.md b/docs/analytics.component.md index 1a86814623..d3869435eb 100644 --- a/docs/analytics.component.md +++ b/docs/analytics.component.md @@ -4,18 +4,6 @@ Shows the charts related to the reportId passed as input ![Analytics-without-parameters](docassets/images/analytics-without-parameters.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - - ## Basic Usage ```html @@ -52,4 +40,11 @@ You can also hide chart parameters UI by setting the `hideParameters` to `true`: | success | The event is emitted when the report parameters are loaded | | error | The event is emitted when an error occurs during the loading | | reportSaved | The event is emitted when a report is saved | -| reportDeleted | The event is emitted when a report is deleted | \ No newline at end of file +| reportDeleted | The event is emitted when a report is deleted | + + + +## See also + + + \ No newline at end of file diff --git a/docs/apps-list.component.md b/docs/apps-list.component.md index be7b8fc32b..2f4640fcd5 100644 --- a/docs/apps-list.component.md +++ b/docs/apps-list.component.md @@ -4,20 +4,6 @@ Shows all available apps. ![how-filter-apps](docassets/images/how-filter-apps.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) -- [Details](#details) - * [How filter the activiti apps](#how-filter-the-activiti-apps) - - - - - ## Basic Usage ```html @@ -69,4 +55,4 @@ You can use inside the filter one of the following property "modelId": "number", "tenantId": "number" } -``` \ No newline at end of file +``` diff --git a/docs/checklist.component.md b/docs/checklist.component.md index 313a535321..65c76cba67 100644 --- a/docs/checklist.component.md +++ b/docs/checklist.component.md @@ -2,17 +2,6 @@ Shows the checklist task functionality. - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - - - - - ## Basic Usage ```html diff --git a/docs/comments.component.md b/docs/comments.component.md index 9b477c7ec4..640da34a1b 100644 --- a/docs/comments.component.md +++ b/docs/comments.component.md @@ -4,18 +4,6 @@ Displays comments from users involved in a specified task and allows an involved ![adf-comments](docassets/images/adf-comments.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - - ## Basic Usage ```html diff --git a/docs/create-process-attachment.component.md b/docs/create-process-attachment.component.md index a1465e8f5f..a4173999e2 100644 --- a/docs/create-process-attachment.component.md +++ b/docs/create-process-attachment.component.md @@ -1,21 +1,9 @@ # Create Process Attachment component -Displays Upload Component(Drag and Click) to upload the attachment to a specified process instance +Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance ![process-create-attachment](docassets/images/process-create-attachment.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - - ## Basic Usage ```html diff --git a/docs/create-task-attachment.component.md b/docs/create-task-attachment.component.md index a17774984f..ed32812b0d 100644 --- a/docs/create-task-attachment.component.md +++ b/docs/create-task-attachment.component.md @@ -1,21 +1,9 @@ # Create Task Attachment Component -Displays Upload Component(Drag and Click) to upload the attachment to a specified task +Displays Upload Component (Drag and Click) to upload the attachment to a specified task ![task-create-attachment](docassets/images/task-create-attachment.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - - ## Basic Usage ```html diff --git a/docs/file-uploading-dialog.component.md b/docs/file-uploading-dialog.component.md index ac59e7a0b4..4d16b49a30 100644 --- a/docs/file-uploading-dialog.component.md +++ b/docs/file-uploading-dialog.component.md @@ -2,18 +2,6 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) -- [Details](#details) - - - - - ## Basic Usage ```html @@ -28,4 +16,14 @@ Shows a dialog listing all the files uploaded with the Upload Button or Drag Are ## Details -This component should be used in combination with upload button or drag-and-drop area. +This component should be used in combination with the +[Upload Button component](upload-button.component.md) or the +[Drag Area component](drag-area.component.md). + + + +## See also + +- [Upload button component](upload-button.component.md) +- [Upload drag area component](upload-drag-area.component.md) + diff --git a/docs/like.component.md b/docs/like.component.md index 0c933dafff..eedaba6187 100644 --- a/docs/like.component.md +++ b/docs/like.component.md @@ -2,18 +2,6 @@ ![Custom columns](docassets/images/social1.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - - ## Basic Usage ```html @@ -31,3 +19,11 @@ | Name | Description | | --- | --- | | changeVote | Raised when vote gets changed | + + + +## See also + +- [Rating component](rating.component.md) +- [Rating service](rating.service.md) + \ No newline at end of file diff --git a/docs/rating.component.md b/docs/rating.component.md index d42fc905b1..0ec88269a5 100644 --- a/docs/rating.component.md +++ b/docs/rating.component.md @@ -1,6 +1,6 @@ # ADF Rating component -![Custom columns](docassets/images/social2.png) +![Rating component screenshot](docassets/images/social2.png) ## Basic Usage @@ -20,4 +20,12 @@ | Name | Description | | --- | --- | -| changeVote | Raised when vote gets changed | \ No newline at end of file +| changeVote | Raised when vote gets changed | + + + +## See also + +- [Like component](like.component.md) +- [Rating service](rating.service.md) + \ No newline at end of file diff --git a/docs/seeAlsoGraph.json b/docs/seeAlsoGraph.json index 91ee2dd0eb..e797832102 100644 --- a/docs/seeAlsoGraph.json +++ b/docs/seeAlsoGraph.json @@ -55,7 +55,7 @@ "ecm-user.model": ["ecm-user.service", "people-content.service"], "ecm-user.service": [], "extensibility": [], - "file-uploading-dialog.component": [], + "file-uploading-dialog.component": ["upload-button.component","upload-drag-area.component"], "filter.model": ["process-filters.component", "task-filters.component"], "folder-actions.service": ["document-actions.service"], "form-list.component": [], diff --git a/docs/sites-dropdown.component.md b/docs/sites-dropdown.component.md index 93424828da..b82bb12d9e 100644 --- a/docs/sites-dropdown.component.md +++ b/docs/sites-dropdown.component.md @@ -4,18 +4,6 @@ Displays a dropdown menu to show and interact with the sites of the current user ![Dropdown sites](docassets/images/document-list-dropdown-list.png) - - - - -- [Basic Usage](#basic-usage) - * [Properties](#properties) - * [Events](#events) - - - - - ## Basic Usage ```html @@ -36,4 +24,4 @@ Displays a dropdown menu to show and interact with the sites of the current user | Name | Returned Type | Description | | --- | --- | --- | -| change | [SiteModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-alfresco-core/src/models/site.model.ts) | emitted when user selects a site. When default option is selected an empty model is emitted | +| change | [SiteModel](site.model.md) | emitted when user selects a site. When default option is selected an empty model is emitted |