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-1586] Removed ToCs and added See Alsos (#2729)

Browse Source
This commit is contained in:
Andy Stark
2017-11-24 15:57:58 +00:00
committed by Eugenio Romano
parent 05135a0494
commit 321e4fbdc2
15 changed files with 60 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/accordion-group.component.md
View File

@@ -4,19 +4,6 @@ Adds a collapsible panel to an [accordion menu](accordion.component.md).
![Accordion menu screenshot](docassets/images/accordion-menu.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
- [Details](#details)
- [See also](#see-also)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->

14
docs/accordion.component.md
View File

@@ -4,20 +4,6 @@ Creates a collapsible accordion menu.
![Accordion menu screenshot](docassets/images/accordion-menu.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
- [Details](#details)
* [Example](#example)
- [See also](#see-also)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html

21
docs/analytics-generator.component.md
View File

@@ -1,18 +1,6 @@
# Analytics Generator Component
The component generates and shows the charts
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
Generates and shows charts
## Basic Usage
@@ -36,3 +24,10 @@ The component generates and shows the charts
| --- | --- |
| success | Raised when the charts are loaded |
| error | Raised when an error occurs during the loading |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
<!-- seealso end -->

21
docs/analytics-report-list.component.md
View File

@@ -1,18 +1,6 @@
# Activiti Analytics List Component
The component shows the list of all the available reports
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
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 |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
<!-- seealso end -->

19
docs/analytics.component.md
View File

@@ -4,18 +4,6 @@ Shows the charts related to the reportId passed as input
![Analytics-without-parameters](docassets/images/analytics-without-parameters.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html
@@ -53,3 +41,10 @@ You can also hide chart parameters UI by setting the `hideParameters` to `true`:
| 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 |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
<!-- seealso end -->

14
docs/apps-list.component.md
View File

@@ -4,20 +4,6 @@ Shows all available apps.
![how-filter-apps](docassets/images/how-filter-apps.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
- [Details](#details)
* [How filter the activiti apps](#how-filter-the-activiti-apps)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html

11
docs/checklist.component.md
View File

@@ -2,17 +2,6 @@
Shows the checklist task functionality.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html

12
docs/comments.component.md
View File

@@ -4,18 +4,6 @@ Displays comments from users involved in a specified task and allows an involved
![adf-comments](docassets/images/adf-comments.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html

12
docs/create-process-attachment.component.md
View File

@@ -4,18 +4,6 @@ Displays Upload Component(Drag and Click) to upload the attachment to a specifie
![process-create-attachment](docassets/images/process-create-attachment.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html

12
docs/create-task-attachment.component.md
View File

@@ -4,18 +4,6 @@ Displays Upload Component(Drag and Click) to upload the attachment to a specifie
![task-create-attachment](docassets/images/task-create-attachment.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html

24
docs/file-uploading-dialog.component.md
View File

@@ -2,18 +2,6 @@
Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
- [Details](#details)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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).
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Upload button component](upload-button.component.md)
- [Upload drag area component](upload-drag-area.component.md)
<!-- seealso end -->

20
docs/like.component.md
View File

@@ -2,18 +2,6 @@
![Custom columns](docassets/images/social1.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html
@@ -31,3 +19,11 @@
| Name | Description |
| --- | --- |
| changeVote | Raised when vote gets changed |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Rating component](rating.component.md)
- [Rating service](rating.service.md)
<!-- seealso end -->

10
docs/rating.component.md
View File

@@ -1,6 +1,6 @@
# ADF Rating component
![Custom columns](docassets/images/social2.png)
![Rating component screenshot](docassets/images/social2.png)
## Basic Usage
@@ -21,3 +21,11 @@
| Name | Description |
| --- | --- |
| changeVote | Raised when vote gets changed |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Like component](like.component.md)
- [Rating service](rating.service.md)
<!-- seealso end -->

2
docs/seeAlsoGraph.json
View File

@@ -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": [],

14
docs/sites-dropdown.component.md
View File

@@ -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)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## 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 |