inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2463] Moved doc files to subfolders (#3070)

Browse Source 
* [ADF-2463] Moved doc files to subfolders

* [ADF-2463] Fixed broken image links

* [ADF-2463] Moved doc files to subfolders

* [ADF-2463] Fixed broken image links
This commit is contained in:
Andy Stark 2018-03-13 11:55:33 +00:00 committed by Eugenio Romano
parent d4780d41ce
commit ba905acf13
37 changed files with 107 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/README.md
View File

@ -52,27 +52,27 @@ for more information about installing and using the source code.
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Card view component](card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
| [Card view component](core/card-view.component.md) | Displays a configurable property list renderer. | [Source](../lib/core/card-view/components/card-view/card-view.component.ts) |
| [Accordion group component](core/accordion-group.component.md) | Adds a collapsible panel to an accordion menu. | [Source](../lib/core/collapsable/accordion-group.component.ts) |
| [Accordion component](core/accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) |
| [Data column component](data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) |
| [Data column component](core/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) |
| [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) |
| [Form field component](form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) |
| [Form list component](form-list.component.md) | Shows APS forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) |
| [Form component](form.component.md) | Shows a Form from APS (see it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/)) | [Source](../lib/core/form/components/form.component.ts) |
| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) |
| [Text mask component](text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
| [Info drawer layout component](info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
| [Info drawer component](info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) |
| [Language menu component](language-menu.component.md) | Displays all the languages that are present in the "app.config.json" or the default one (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) |
| [Text mask component](core/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) |
| [Info drawer layout component](core/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) |
| [Info drawer component](core/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) |
| [Language menu component](core/language-menu.component.md) | Displays all the languages that are present in the "app.config.json" or the default one (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) |
| [Login component](login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) |
| [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) |
| [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) |
| [Host settings component](host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) |
| [Sidebar action menu component](sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) |
| [Toolbar divider component](toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) |
| [Toolbar title component](toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
| [Toolbar component](toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) |
| [Sidebar action menu component](core/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) |
| [Toolbar divider component](core/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) |
| [Toolbar title component](core/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) |
| [Toolbar component](core/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) |
| [User info component](user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) |
| [Viewer component](viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) |
@ -80,13 +80,13 @@ for more information about installing and using the source code.
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Context menu directive](context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) |
| [Context menu directive](core/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) |
| [Highlight directive](core/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) |
| [Logout directive](logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) |
| [Node delete directive](node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) |
| [Node favorite directive](node-favorite.directive.md) | Selectively toggles nodes as favorite | [Source](../lib/core/directives/node-favorite.directive.ts) |
| [Node permission directive](node-permission.directive.md) | Selectively disables an HTML element or Angular component | [Source](../lib/core/directives/node-permission.directive.ts) |
| [Node restore directive](node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) |
| [Node delete directive](core/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) |
| [Node favorite directive](core/node-favorite.directive.md) | Selectively toggles nodes as favorite | [Source](../lib/core/directives/node-favorite.directive.ts) |
| [Node permission directive](core/node-permission.directive.md) | Selectively disables an HTML element or Angular component | [Source](../lib/core/directives/node-permission.directive.ts) |
| [Node restore directive](core/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) |
| [Upload directive](core/upload.directive.md) | Allows your components or common HTML elements reacting on File drag and drop in order to upload content. | [Source](../lib/core/directives/upload.directive.ts) |
## Models
@ -115,7 +115,7 @@ for more information about installing and using the source code.
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Card view update service](card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](card-view.component.md). | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
| [Card view update service](core/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) |
| [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) |
| [Form rendering service](form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) |
| [Form service](form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) |
@ -123,14 +123,14 @@ for more information about installing and using the source code.
| [Process content service](process-content.service.md) | Manipulates content related to a Process Instance or Task Instance in APS. | [Source](../lib/core/form/services/process-content.service.ts) |
| [Alfresco api service](alfresco-api.service.md) | Provides access to initialized **AlfrescoJSApi** instance. | [Source](../lib/core/services/alfresco-api.service.ts) |
| [Apps process service](apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) |
| [Auth guard bpm service](auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
| [Auth guard ecm service](auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
| [Auth guard service](auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) |
| [Auth guard bpm service](core/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) |
| [Auth guard ecm service](core/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) |
| [Auth guard service](core/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) |
| [Authentication service](authentication.service.md) | Provides authentication for use with the Login component. | [Source](../lib/core/services/authentication.service.ts) |
| [Comment process service](core/comment-process.service.md) | Adds and retrieves comments for task and process instances in Process Services. | [Source](../lib/core/services/comment-process.service.ts) |
| [Content service](core/content.service.md) | Accesses app-generated data objects via URLs and file downloads. | [Source](../lib/core/services/content.service.ts) |
| [Cookie service](core/cookie.service.md) | Stores key-value data items as browser cookies. | [Source](../lib/core/services/cookie.service.ts) |
| [Deleted nodes api service](deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) |
| [Deleted nodes api service](core/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) |
| [Discovery api service](core/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) |
| [Favorites api service](favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) |
| [Highlight transform service](core/highlight-transform.service.md) | Adds HTML to a string to highlight chosen sections. | [Source](../lib/core/services/highlight-transform.service.ts) |
@ -143,12 +143,12 @@ for more information about installing and using the source code.
| [Renditions service](renditions.service.md) ![Deprecated](docassets/images/DeprecatedIcon.png) | Manages prearranged conversions of content to different formats. | [Source](../lib/core/services/renditions.service.ts) |
| [Search configuration service](search-configuration.service.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) |
| [Shared links api service](core/shared-links-api.service.md) | Finds shared links to Content Services items. | [Source](../lib/core/services/shared-links-api.service.ts) |
| [Sites service](sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) |
| [Sites service](core/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) |
| [Storage service](core/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) |
| [Thumbnail service](core/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) |
| [Translation service](translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) |
| [Upload service](upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) |
| [User preferences service](user-preferences.service.md) | Stores preferences for components. | [Source](../lib/core/services/user-preferences.service.ts) |
| [User preferences service](core/user-preferences.service.md) | Stores preferences for components. | [Source](../lib/core/services/user-preferences.service.ts) |
| [Bpm user service](core/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) |
| [Ecm user service](core/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/userinfo/services/ecm-user.service.ts) |
@ -314,11 +314,11 @@ for more information about installing and using the source code.
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Widget component](widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
| [Analytics generator component](analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) |
| [Analytics report list component](analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
| [Analytics component](analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) |
| [Diagram component](diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/diagram/components/diagram.component.ts) |
| [Widget component](insights/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
| [Analytics generator component](insights/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) |
| [Analytics report list component](insights/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
| [Analytics component](insights/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) |
| [Diagram component](insights/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/diagram/components/diagram.component.ts) |
<!--insights end-->

0
docs/auth-guard-bpm.service.md → docs/core/auth-guard-bpm.service.md
View File

0
docs/auth-guard-ecm.service.md → docs/core/auth-guard-ecm.service.md
View File

0
docs/auth-guard.service.md → docs/core/auth-guard.service.md
View File

2
docs/card-view-update.service.md → docs/core/card-view-update.service.md
View File

@ -4,7 +4,7 @@ Status: Active
---
# Card View Update service
Reports edits and clicks within fields of a [Card View component](card-view.component.md).
Reports edits and clicks within fields of a Card View component.
## Details

2
docs/card-view.component.md → docs/core/card-view.component.md
View File

@ -6,7 +6,7 @@ Status: Active
Displays a configurable property list renderer.
![adf-custom-view](docassets/images/adf-custom-view.png)
![adf-custom-view](../docassets/images/adf-custom-view.png)
## Basic Usage

0
docs/context-menu.directive.md → docs/core/context-menu.directive.md
View File

22
docs/data-column.component.md → docs/core/data-column.component.md
View File

@ -105,9 +105,9 @@ Every cell in the DataTable component is bound to the dynamic data context conta
| Name | Type | Description |
| ---- | ---- | ----------- |
| data | [DataTableAdapter](datatable-adapter.interface.md) | Data adapter instance. |
| row | [DataRow](datatable-adapter.interface.md) | Current data row instance. |
| col | [DataColumn](datatable-adapter.interface.md) | Current data column instance. |
| data | [DataTableAdapter](../datatable-adapter.interface.md) | Data adapter instance. |
| row | [DataRow](../datatable-adapter.interface.md) | Current data row instance. |
| col | [DataColumn](../datatable-adapter.interface.md) | Current data column instance. |
You can use all three properties to gain full access to underlying data from within your custom templates.
In order to wire HTML templates with the data context you will need defining a variable that is bound to `$implicit` like shown below:
@ -156,7 +156,7 @@ In the Example below we will prepend `Hi!` to each file and folder name in the l
</data-column>
```
In the Example below we will integrate the [adf-tag-node-list](tag-node-list.component.md) component
In the Example below we will integrate the [adf-tag-node-list](../tag-node-list.component.md) component
with the document list.
```html
@ -171,7 +171,7 @@ with the document list.
</data-column>
```
![Tag component in document List](docassets/images/document-list-tag-template.png)
![Tag component in document List](../docassets/images/document-list-tag-template.png)
### Styling Techniques
@ -210,7 +210,7 @@ adf-document-list ::ng-deep adf-datatable > table > tbody > tr.is-selected > td.
Once your application starts you should see the following icon for each selected row:
![view-child](docassets/images/document-list-custom-icon.png)
![view-child](../docassets/images/document-list-custom-icon.png)
#### Hiding columns on small screens
@ -264,11 +264,11 @@ Now you can declare columns and assign `desktop-only` class where needed:
**Desktop View**
![Responsive Desktop](docassets/images/responsive-desktop.png)
![Responsive Desktop](../docassets/images/responsive-desktop.png)
**Mobile View**
![Responsive Mobile](docassets/images/responsive-mobile.png)
![Responsive Mobile](../docassets/images/responsive-mobile.png)
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
@ -276,7 +276,7 @@ Now you can declare columns and assign `desktop-only` class where needed:
## See also
- [Document list component](document-list.component.md)
- [Datatable component](datatable.component.md)
- [Task list component](task-list.component.md)
- [Document list component](../document-list.component.md)
- [Datatable component](../datatable.component.md)
- [Task list component](../task-list.component.md)
<!-- seealso end -->

6
docs/deleted-nodes-api.service.md → docs/core/deleted-nodes-api.service.md
View File

@ -15,12 +15,12 @@ Gets a list of Content Services nodes currently in the trash.
## Details
The `getDeletedNodes` method returns a NodePaging object that lists
the items in the trash (see [Document Library model](document-library.model.md) for
the items in the trash (see [Document Library model](../document-library.model.md) for
more information about this class). The format of the `options` parameter is
described in the [getDeletedNodes](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getDeletedNodes)
page of the Alfresco JS API docs.
## See also
- [Nodes api service](nodes-api.service.md)
- [Node service](node.service.md)
- [Nodes api service](../nodes-api.service.md)
- [Node service](../node.service.md)

2
docs/info-drawer-layout.component.md → docs/core/info-drawer-layout.component.md
View File

@ -6,7 +6,7 @@ Status: Active
Displays a sidebar-style information panel.
![Info drawer layout screenshot](docassets/images/infodrawerlayout.png)
![Info drawer layout screenshot](../docassets/images/infodrawerlayout.png)
## Basic usage

2
docs/info-drawer.component.md → docs/core/info-drawer.component.md
View File

@ -6,7 +6,7 @@ Status: Active
Displays a sidebar-style information panel with tabs.
![Info drawer screenshot](docassets/images/activities-infodrawer.png)
![Info drawer screenshot](../docassets/images/activities-infodrawer.png)
## Basic usage

6
docs/language-menu.component.md → docs/core/language-menu.component.md
View File

@ -6,7 +6,7 @@ Status: Active
Displays all the languages that are present in the "app.config.json" or the default one (EN).
![Language Menu screenshot](docassets/images/languages-menu.png)
![Language Menu screenshot](../docassets/images/languages-menu.png)
## Basic usage
@ -64,7 +64,7 @@ How to attach an ADF Language Menu as nested menu
</mat-menu>
```
![Nested Language Menu screenshot](docassets/images/languages-menu-nested.png)
![Nested Language Menu screenshot](../docassets/images/languages-menu-nested.png)
### Nested menu details
@ -72,4 +72,4 @@ In the previous example we are using the ADF Language Menu as nested menu.
## See Also
- [Internationalization](internationalization.md)
- [Internationalization](../internationalization.md)

0
docs/node-delete.directive.md → docs/core/node-delete.directive.md
View File

0
docs/node-favorite.directive.md → docs/core/node-favorite.directive.md
View File

0
docs/node-permission.directive.md → docs/core/node-permission.directive.md
View File

0
docs/node-restore.directive.md → docs/core/node-restore.directive.md
View File

4
docs/sidebar-action-menu.component.md → docs/core/sidebar-action-menu.component.md
View File

@ -6,8 +6,8 @@ Status: Active
Displays a sidebar-action menu information panel.
![Sidebar action menu button screenshot](docassets/images/sidebar-action-menu-button.png)
![Sidebar action menu icon screenshot](docassets/images/sidebar-action-menu-icon.png)
![Sidebar action menu button screenshot](../docassets/images/sidebar-action-menu-button.png)
![Sidebar action menu icon screenshot](../docassets/images/sidebar-action-menu-icon.png)
## Basic usage

4
docs/sites.service.md → docs/core/sites.service.md
View File

@ -30,7 +30,7 @@ Accesses and manipulates sites from a Content Services repository.
You can use `getSites` to get a list of all sites in the repository.
The sites are returned as `Observable<SiteModel[]>` (see
[Site Model](site.model.md) for more information about this class).
[Site Model](../site.model.md) for more information about this class).
If you are only interested in a single site and you have its ID, you
can use `getSite` to access it. Alternatively, you can use `getSiteContent`
or `getSiteMembers` to extract just the `contents` and `members` properties
@ -49,4 +49,4 @@ for more information about the available options.
## See also
- [Site model](site.model.md)
- [Site model](../site.model.md)

0
docs/text-mask.component.md → docs/core/text-mask.component.md
View File

0
docs/toolbar-divider.component.md → docs/core/toolbar-divider.component.md
View File

2
docs/toolbar-title.component.md → docs/core/toolbar-title.component.md
View File

@ -6,7 +6,7 @@ Status: Active
Supplies custom HTML to be included in a Toolbar component title.
![](docassets/images/adf-toolbar-02.png)
![](../docassets/images/adf-toolbar-02.png)
## Basic Usage

14
docs/toolbar.component.md → docs/core/toolbar.component.md
View File

@ -6,7 +6,7 @@ Status: Active
Simple container for headers, titles, actions and breadcrumbs.
![](docassets/images/adf-toolbar-01.png)
![](../docassets/images/adf-toolbar-01.png)
## Basic Usage
@ -45,7 +45,7 @@ You can use any HTML layout or Angular component as a content of the Title secti
The toolbar should now look similar to the following:
![](docassets/images/adf-toolbar-02.png)
![](../docassets/images/adf-toolbar-02.png)
### Divider
@ -90,11 +90,11 @@ You can use the following example to create a dropdown menu:
The code above is based on the `<mat-menu>` component from the `@angular/material` library. You can use any custom menu component as well.
![](docassets/images/adf-toolbar-03.png)
![](../docassets/images/adf-toolbar-03.png)
Once you click the menu button you should see the following menu items as defined earlier:
![](docassets/images/adf-toolbar-04.png)
![](../docassets/images/adf-toolbar-04.png)
### Custom color
@ -104,11 +104,11 @@ Depending on the overall application theme the colors of the toolbar should chan
For example:
![](docassets/images/adf-toolbar-05.png)
![](../docassets/images/adf-toolbar-05.png)
![](docassets/images/adf-toolbar-06.png)
![](../docassets/images/adf-toolbar-06.png)
![](docassets/images/adf-toolbar-07.png)
![](../docassets/images/adf-toolbar-07.png)
## See also

0
docs/user-preferences.service.md → docs/core/user-preferences.service.md
View File

2
docs/datatable.component.md
View File

@ -480,7 +480,7 @@ and do corresponding actions.
## See also
- [Data column component](data-column.component.md)
- [Data column component](core/data-column.component.md)
- [Pagination component](pagination.component.md)
- [DataTableAdapter](datatable-adapter.interface.md)
- [Document list component](document-list.component.md)

6
docs/document-list.component.md
View File

@ -535,7 +535,7 @@ You can also use the HTML-based schema declaration used by
</adf-datatable>
```
You can also add tooltips, styling, automatic column title translation and other features. See the [DataColumn component page](data-column.component.md) for more information about specifying and customizing columns.
You can also add tooltips, styling, automatic column title translation and other features. See the [DataColumn component page](core/data-column.component.md) for more information about specifying and customizing columns.
### Date Column
@ -602,7 +602,7 @@ you can also define your own actions. See the
[Content Action component](content-action.component.md)
for more information and examples.
You can also use the [Context Menu directive](context-menu.directive.md) from the
You can also use the [Context Menu directive](core/context-menu.directive.md) from the
[ADF Core](https://www.npmjs.com/package/ng2-alfresco-core) library to show the
actions you have defined in a context menu:
@ -802,7 +802,7 @@ This will give the following output:
## See also
- [Datatable component](datatable.component.md)
- [Data column component](data-column.component.md)
- [Data column component](core/data-column.component.md)
- [Pagination component](pagination.component.md)
- [Infinite pagination component](infinite-pagination.component.md)
- [Sites dropdown component](sites-dropdown.component.md)

2
docs/extensibility.md
View File

@ -262,4 +262,4 @@ At runtime you should now see your custom Angular component rendered in place of
- [Form field model](form-field.model.md)
- [Form rendering service](form-rendering.service.md)
- [Form component](form.component.md)
- [Widget component](widget.component.md)
- [Widget component](insights/widget.component.md)

0
docs/analytics-generator.component.md → docs/insights/analytics-generator.component.md
View File

0
docs/analytics-report-list.component.md → docs/insights/analytics-report-list.component.md
View File

0
docs/analytics.component.md → docs/insights/analytics.component.md
View File

0
docs/diagram.component.md → docs/insights/diagram.component.md
View File

6
docs/widget.component.md → docs/insights/widget.component.md
View File

@ -26,14 +26,14 @@ export class CustomEditorComponent extends WidgetComponent {}
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| readOnly | boolean | false | Does the widget show a read-only value? (ie, can't be edited) |
| field | [FormFieldModel](form-field.model.md) | | Data to be displayed in the field |
| field | [FormFieldModel](../form-field.model.md) | | Data to be displayed in the field |
## Details
The Widget component is the base class for all standard and custom form widgets. See the
[Form Extensibility and Customisation](extensibility.md) page for full details about
[Form Extensibility and Customisation](../extensibility.md) page for full details about
implementing custom widgets.
## See also
- [Extensibility](extensibility.md)
- [Extensibility](../extensibility.md)

10
docs/internationalization.md
View File

@ -191,30 +191,30 @@ You can use interpolations with the `translate` pipe in a similar way:
## Selecting the display language
ADF provides a [Language Menu component](language-menu.component.md) that
ADF provides a [Language Menu component](core/language-menu.component.md) that
you can add to a page to let the user choose their preferred language. The
available languages are defined in the `app.config.json` file for the app.
Note that when the user selects an item from the menu, it simply changes the "locale"
preference (which you can get via the [User Preferences service](user-preferences.service.md)).
preference (which you can get via the [User Preferences service](core/user-preferences.service.md)).
The `translate` pipe reacts automatically to this and changes the page text
immediately to the new language. However, text added via a variable set using
`TranslationService.get`, as in the example above, will not be updated like this;
you will need to get a new translation and set the variable's value again explicitly
from the code.
See the [Language Menu component](language-menu.component.md) page for further
See the [Language Menu component](core/language-menu.component.md) page for further
details and usage examples.
## Support for i18n within ADF components
Some components allow you to use translation keys in places where you would normally
supply your own messages directly. For example, the
[Data Column component](data-column.component.md) can accept a key instead of
[Data Column component](core/data-column.component.md) can accept a key instead of
normal text to specify the column title. Consult the documentation for a
component to see if it has built-in support for i18n.
## See also
- [Translation service](translation.service.md)
- [Language Menu component](language-menu.component.md)
- [Language Menu component](core/language-menu.component.md)

2
docs/node.service.md
View File

@ -122,4 +122,4 @@ See the `createNode` method for information about the response object.
## See also
- [Nodes api service](nodes-api.service.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)
- [Deleted nodes api service](core/deleted-nodes-api.service.md)

4
docs/nodes-api.service.md
View File

@ -167,11 +167,11 @@ to delete the node immediately if you have the right permissions. See the
and
[restoreNode](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#restoreNode)
pages in the Alfresco JS API for further details and options. Note that you can also use the
[Deleted Nodes Api service](deleted-nodes-api.service.md) get a list of all items currently in the trashcan.
[Deleted Nodes Api service](core/deleted-nodes-api.service.md) get a list of all items currently in the trashcan.
## See also
- [Document library model](document-library.model.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)
- [Deleted nodes api service](core/deleted-nodes-api.service.md)
- [Document list component](document-list.component.md)
- [Node service](node.service.md)

4
docs/site.model.md
View File

@ -8,7 +8,7 @@ Provides information about a site in a Content Services repository.
## Details
`SiteModel` is returned by methods from the [Sites Api service](sites.service.md).
`SiteModel` is returned by methods from the [Sites Api service](core/sites.service.md).
Also, the
[`getSite`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite)
and
@ -46,4 +46,4 @@ class SiteMembersModel {
## See also
- [Sites service](sites.service.md)
- [Sites service](core/sites.service.md)

4
docs/task-list.component.md
View File

@ -197,10 +197,10 @@ typical tasklist.
### DataColumn Features
You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [DataColumn](data-column.component.md) page for more information about these features.
You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [DataColumn](core/data-column.component.md) page for more information about these features.
## See also
- [Data column component](data-column.component.md)
- [Data column component](core/data-column.component.md)
- [DataTableAdapter](datatable-adapter.interface.md)
- [Pagination component](pagination.component.md)

54
docs/versionIndex.md
View File

@ -22,7 +22,7 @@ ADF version in which they were introduced. See the
- [Content node dialog service](content-node-dialog.service.md)
- [Content node selector panel component](content-node-selector-panel.component.md)
- [Search configuration service](search-configuration.service.md)
- [Sidebar action menu component](sidebar-action-menu.component.md)
- [Sidebar action menu component](core/sidebar-action-menu.component.md)
## v2.0.0
@ -31,21 +31,21 @@ ADF version in which they were introduced. See the
- [Activiti alfresco service](activiti-alfresco.service.md)
- [Alfresco api service](alfresco-api.service.md)
- [Alfresco content service](alfresco-content.service.md)
- [Analytics generator component](analytics-generator.component.md)
- [Analytics report list component](analytics-report-list.component.md)
- [Analytics component](analytics.component.md)
- [Analytics generator component](insights/analytics-generator.component.md)
- [Analytics report list component](insights/analytics-report-list.component.md)
- [Analytics component](insights/analytics.component.md)
- [App config service](core/app-config.service.md)
- [Apps list component](apps-list.component.md)
- [Apps process service](apps-process.service.md)
- [Auth guard bpm service](auth-guard-bpm.service.md)
- [Auth guard ecm service](auth-guard-ecm.service.md)
- [Auth guard service](auth-guard.service.md)
- [Auth guard bpm service](core/auth-guard-bpm.service.md)
- [Auth guard ecm service](core/auth-guard-ecm.service.md)
- [Auth guard service](core/auth-guard.service.md)
- [Authentication service](authentication.service.md)
- [Bpm user model](core/bpm-user.model.md)
- [Bpm user service](core/bpm-user.service.md)
- [Breadcrumb component](breadcrumb.component.md)
- [Card view update service](card-view-update.service.md)
- [Card view component](card-view.component.md)
- [Card view update service](core/card-view-update.service.md)
- [Card view component](core/card-view.component.md)
- [Checklist component](checklist.component.md)
- [Comment list component](comment-list.component.md)
- [Comment process model](core/comment-process.model.md)
@ -55,14 +55,14 @@ ADF version in which they were introduced. See the
- [Content node selector component](content-node-selector.component.md)
- [Content service](core/content.service.md)
- [Content widget](content.widget.md)
- [Context menu directive](context-menu.directive.md)
- [Context menu directive](core/context-menu.directive.md)
- [Cookie service](core/cookie.service.md)
- [Create process attachment component](create-process-attachment.component.md)
- [Create task attachment component](create-task-attachment.component.md)
- [Data column component](data-column.component.md)
- [Data column component](core/data-column.component.md)
- [Datatable component](datatable.component.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)
- [Diagram component](diagram.component.md)
- [Deleted nodes api service](core/deleted-nodes-api.service.md)
- [Diagram component](insights/diagram.component.md)
- [Discovery api service](core/discovery-api.service.md)
- [Document actions service](document-actions.service.md)
- [Document library model](document-library.model.md)
@ -89,19 +89,19 @@ ADF version in which they were introduced. See the
- [Highlight directive](core/highlight.directive.md)
- [Host settings component](host-settings.component.md)
- [Infinite pagination component](infinite-pagination.component.md)
- [Info drawer layout component](info-drawer-layout.component.md)
- [Info drawer component](info-drawer.component.md)
- [Language menu component](language-menu.component.md)
- [Info drawer layout component](core/info-drawer-layout.component.md)
- [Info drawer component](core/info-drawer.component.md)
- [Language menu component](core/language-menu.component.md)
- [Like component](like.component.md)
- [Log service](log.service.md)
- [Login component](login.component.md)
- [Logout directive](logout.directive.md)
- [Mime type icon pipe](core/mime-type-icon.pipe.md)
- [Node delete directive](node-delete.directive.md)
- [Node favorite directive](node-favorite.directive.md)
- [Node delete directive](core/node-delete.directive.md)
- [Node favorite directive](core/node-favorite.directive.md)
- [Node name tooltip pipe](core/node-name-tooltip.pipe.md)
- [Node permission directive](node-permission.directive.md)
- [Node restore directive](node-restore.directive.md)
- [Node permission directive](core/node-permission.directive.md)
- [Node restore directive](core/node-restore.directive.md)
- [Node service](node.service.md)
- [Nodes api service](nodes-api.service.md)
- [Notification service](core/notification.service.md)
@ -135,7 +135,7 @@ ADF version in which they were introduced. See the
- [Shared links api service](core/shared-links-api.service.md)
- [Site model](site.model.md)
- [Sites dropdown component](sites-dropdown.component.md)
- [Sites service](sites.service.md)
- [Sites service](core/sites.service.md)
- [Start form component](start-form.component.md)
- [Start process component](start-process.component.md)
- [Start task component](start-task.component.md)
@ -154,12 +154,12 @@ ADF version in which they were introduced. See the
- [Task list component](task-list.component.md)
- [Tasklist service](tasklist.service.md)
- [Text highlight pipe](core/text-highlight.pipe.md)
- [Text mask component](text-mask.component.md)
- [Text mask component](core/text-mask.component.md)
- [Thumbnail service](core/thumbnail.service.md)
- [Time ago pipe](core/time-ago.pipe.md)
- [Toolbar divider component](toolbar-divider.component.md)
- [Toolbar title component](toolbar-title.component.md)
- [Toolbar component](toolbar.component.md)
- [Toolbar divider component](core/toolbar-divider.component.md)
- [Toolbar title component](core/toolbar-title.component.md)
- [Toolbar component](core/toolbar.component.md)
- [Translation service](translation.service.md)
- [Upload button component](upload-button.component.md)
- [Upload drag area component](upload-drag-area.component.md)
@ -167,12 +167,12 @@ ADF version in which they were introduced. See the
- [Upload service](upload.service.md)
- [User info component](user-info.component.md)
- [User initial pipe](core/user-initial.pipe.md)
- [User preferences service](user-preferences.service.md)
- [User preferences service](core/user-preferences.service.md)
- [User process model](core/user-process.model.md)
- [Version list component](version-list.component.md)
- [Version manager component](version-manager.component.md)
- [Viewer component](viewer.component.md)
- [Webscript component](webscript.component.md)
- [Widget component](widget.component.md)
- [Widget component](insights/widget.component.md)
<!--history end-->