diff --git a/docs/README.md b/docs/README.md index c9a25e85da..bb159d2513 100644 --- a/docs/README.md +++ b/docs/README.md @@ -57,7 +57,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [About component](core/about.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component allow you to have a general overview of the version of ADF installed and the status of the [Content service](../core/content.service.md) and [Process service](../process-services/process.service.md). | [Source](../lib/core/about/about.component.ts) | +| [About component](core/about.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | This component allow you to have a general overview of the version of ADF installed and the status of the [Content service](core/content.service.md) and [Process service](process-services/process.service.md). | [Source](../lib/core/about/about.component.ts) | | [Buttons menu component](core/buttons-menu.component.md) | Displays buttons on a responsive menu. | [Source](../lib/core/buttons-menu/buttons-menu.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) | @@ -68,8 +68,8 @@ for more information about installing and using the source code. | [Datatable component](core/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](core/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](core/form-list.component.md) | Shows APS forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | -| [Form component](core/form.component.md) | Shows a [`Form`](../../lib/process-services/task-list/models/form.model.ts) from APS | [Source](../lib/core/form/components/form.component.ts) | -| [Start form component](core/start-form.component.md) | Displays the Start [`Form`](../../lib/process-services/task-list/models/form.model.ts) for a process. | [Source](../lib/core/form/components/start-form.component.ts) | +| [Form component](core/form.component.md) | Shows a [`Form`](../lib/process-services/task-list/models/form.model.ts) from APS | [Source](../lib/core/form/components/form.component.ts) | +| [Start form component](core/start-form.component.md) | Displays the Start [`Form`](../lib/process-services/task-list/models/form.model.ts) for a process. | [Source](../lib/core/form/components/start-form.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) | @@ -84,7 +84,7 @@ for more information about installing and using the source code. | [Empty content component](core/empty-content.component.md) | Provides a generic "Empty Content" placeholder for components. | [Source](../lib/core/templates/empty-content/empty-content.component.ts) | | [Error content component](core/error-content.component.md) | Displays info about a specific error. | [Source](../lib/core/templates/error-content/error-content.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](../core/toolbar.component.md) title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | +| [Toolbar title component](core/toolbar-title.component.md) | Supplies custom HTML to be included in a [Toolbar component](core/toolbar.component.md) 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](core/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | | [Viewer component](core/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | @@ -106,7 +106,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Form field model](core/form-field.model.md) | Contains the value and metadata for a field of a [`Form`](../../lib/process-services/task-list/models/form.model.ts) component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | +| [Form field model](core/form-field.model.md) | Contains the value and metadata for a field of a [`Form`](../lib/process-services/task-list/models/form.model.ts) component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | | [Comment process model](core/comment-process.model.md) | Represents a comment added to a Process Services task or process instance. | [Source](../lib/core/models/comment-process.model.ts) | | [Product version model](core/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | | [User process model](core/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | @@ -122,16 +122,16 @@ for more information about installing and using the source code. | [Node name tooltip pipe](core/node-name-tooltip.pipe.md) | Formats the tooltip for a Node. | [Source](../lib/core/pipes/node-name-tooltip.pipe.ts) | | [Text highlight pipe](core/text-highlight.pipe.md) | Adds highlighting to words or sections of text that match a search string. | [Source](../lib/core/pipes/text-highlight.pipe.ts) | | [Time ago pipe](core/time-ago.pipe.md) | Converts a recent past date into a number of days ago. | [Source](../lib/core/pipes/time-ago.pipe.ts) | -| [User initial pipe](core/user-initial.pipe.md) | Takes the name fields of a [`UserProcessModel`](../core/user-process.model.md) object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | +| [User initial pipe](core/user-initial.pipe.md) | Takes the name fields of a [`UserProcessModel`](core/user-process.model.md) object and extracts and formats the initials. | [Source](../lib/core/pipes/user-initial.pipe.ts) | ## Services | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Card item types service](core/card-item-types.service.md) | Maps type names to field component types for the [Card View component](../core/card-view.component.md). | [Source](../lib/core/card-view/services/card-item-types.service.ts) | -| [Card view update service](core/card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](../core/card-view.component.md). | [Source](../lib/core/card-view/services/card-view-update.service.ts) | +| [Card item types service](core/card-item-types.service.md) | Maps type names to field component types for the [Card View component](core/card-view.component.md). | [Source](../lib/core/card-view/services/card-item-types.service.ts) | +| [Card view update service](core/card-view-update.service.md) | Reports edits and clicks within fields of a [Card View component](core/card-view.component.md). | [Source](../lib/core/card-view/services/card-view-update.service.ts) | | [Activiti alfresco service](core/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](core/form-rendering.service.md) | Maps an APS form field type string onto the corresponding form [widget component](../insights/widget.component.md) type. | [Source](../lib/core/form/services/form-rendering.service.ts) | +| [Form rendering service](core/form-rendering.service.md) | Maps an APS form field type string onto the corresponding form [widget component](insights/widget.component.md) type. | [Source](../lib/core/form/services/form-rendering.service.ts) | | [Form service](core/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | | [Node service](core/node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) | | [Process content service](core/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) | @@ -209,16 +209,16 @@ for more information about installing and using the source code. | [Add permission panel component](content-services/add-permission-panel.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission-panel.component.ts) | | [Add permission component](content-services/add-permission.component.md) | Searches for people or groups to add to the current node permissions. | [Source](../lib/content-services/permission-manager/components/add-permission/add-permission.component.ts) | | [Permission list component](content-services/permission-list.component.md) | Shows node permissions as a table. | [Source](../lib/content-services/permission-manager/components/permission-list/permission-list.component.ts) | -| [Search check list component](content-services/search-check-list.component.md) | Implements a checklist widget for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) | +| [Search check list component](content-services/search-check-list.component.md) | Implements a checklist widget for the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-check-list/search-check-list.component.ts) | | [Search chip list component](content-services/search-chip-list.component.md) | Displays search criteria as a set of "chips". | [Source](../lib/content-services/search/components/search-chip-list/search-chip-list.component.ts) | | [Search control component](content-services/search-control.component.md) | Displays a input text which shows find-as-you-type suggestions. | [Source](../lib/content-services/search/components/search-control.component.ts) | -| [Search date range component](content-services/search-date-range.component.md) | Implements a date range widget for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) | +| [Search date range component](content-services/search-date-range.component.md) | Implements a date range widget for the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-date-range/search-date-range.component.ts) | | [Search filter component](content-services/search-filter.component.md) | Represents a main container component for custom search and faceted search settings. | [Source](../lib/content-services/search/components/search-filter/search-filter.component.ts) | -| [Search number range component](content-services/search-number-range.component.md) | Implements a number range widget for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) | -| [Search radio component](content-services/search-radio.component.md) | Implements a radio button list widget for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) | -| [Search slider component](content-services/search-slider.component.md) | Implements a numeric slider widget for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) | +| [Search number range component](content-services/search-number-range.component.md) | Implements a number range widget for the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-number-range/search-number-range.component.ts) | +| [Search radio component](content-services/search-radio.component.md) | Implements a radio button list widget for the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-radio/search-radio.component.ts) | +| [Search slider component](content-services/search-slider.component.md) | Implements a numeric slider widget for the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-slider/search-slider.component.ts) | | [Search sorting picker component](content-services/search-sorting-picker.component.md) | Provides an ability to select one of the predefined sorting definitions for search results: | [Source](../lib/content-services/search/components/search-sorting-picker/search-sorting-picker.component.ts) | -| [Search text component](content-services/search-text.component.md) | Implements a text input widget for the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) | +| [Search text component](content-services/search-text.component.md) | Implements a text input widget for the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-text/search-text.component.ts) | | [Search component](content-services/search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) | | [Sites dropdown component](content-services/sites-dropdown.component.md) | Displays a dropdown menu to show and interact with the sites of the current user. | [Source](../lib/content-services/site-dropdown/sites-dropdown.component.ts) | | [Like component](content-services/like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) | @@ -230,7 +230,7 @@ for more information about installing and using the source code. | [Upload button component](content-services/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.component.ts) | | [Upload drag area component](content-services/upload-drag-area.component.md) | Adds a drag and drop area to upload files to ACS. | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) | | [Upload version button component](content-services/upload-version-button.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Activates a file version upload. | [Source](../lib/content-services/upload/components/upload-version-button.component.ts) | -| [Version list component](content-services/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a [Version Manager component](../content-services/version-manager.component.md). | [Source](../lib/content-services/version-manager/version-list.component.ts) | +| [Version list component](content-services/version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a [Version Manager component](content-services/version-manager.component.md). | [Source](../lib/content-services/version-manager/version-list.component.ts) | | [Version manager component](content-services/version-manager.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node with the ability to upload a new version. | [Source](../lib/content-services/version-manager/version-manager.component.ts) | | [Webscript component](content-services/webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) | @@ -259,12 +259,12 @@ for more information about installing and using the source code. | ---- | ----------- | ----------- | | [Content node dialog service](content-services/content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../lib/content-services/content-node-selector/content-node-dialog.service.ts) | | [Custom resources service](content-services/custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../lib/content-services/document-list/services/custom-resources.service.ts) | -| [Document actions service](content-services/document-actions.service.md) | Implements the document menu actions for the [Document List component](../content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/document-actions.service.ts) | -| [Document list service](content-services/document-list.service.md) | Implements node operations used by the [Document List component](../content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/document-list.service.ts) | -| [Folder actions service](content-services/folder-actions.service.md) | Implements the folder menu actions for the [Document List component](../content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) | +| [Document actions service](content-services/document-actions.service.md) | Implements the document menu actions for the [Document List component](content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/document-actions.service.ts) | +| [Document list service](content-services/document-list.service.md) | Implements node operations used by the [Document List component](content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/document-list.service.ts) | +| [Folder actions service](content-services/folder-actions.service.md) | Implements the folder menu actions for the [Document List component](content-services/document-list.component.md). | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) | | [Node permission dialog service](content-services/node-permission-dialog.service.md) | Displays dialogs to let the user set node permissions. | [Source](../lib/content-services/permission-manager/services/node-permission-dialog.service.ts) | | [Node permission service](content-services/node-permission.service.md) | Manages role permissions for content nodes. | [Source](../lib/content-services/permission-manager/services/node-permission.service.ts) | -| [Search filter service](content-services/search-filter.service.md) | Registers widgets for use with the [Search Filter component](../content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) | +| [Search filter service](content-services/search-filter.service.md) | Registers widgets for use with the [Search Filter component](content-services/search-filter.component.md). | [Source](../lib/content-services/search/components/search-filter/search-filter.service.ts) | | [Search query builder service](content-services/search-query-builder.service.md) | Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. | [Source](../lib/content-services/search/search-query-builder.service.ts) | | [Rating service](content-services/rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) | | [Tag service](content-services/tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) | @@ -275,7 +275,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | +| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for [Search filter component](content-services/search-filter.component.md) widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | [(Back to Contents)](#contents) diff --git a/docs/content-services/README.md b/docs/content-services/README.md index f420c6e848..504ef4c14c 100644 --- a/docs/content-services/README.md +++ b/docs/content-services/README.md @@ -88,4 +88,4 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | +| [Search Widget interface](search-widget.interface.md) | Specifies required properties for [Search filter component](search-filter.component.md) widgets. | [Source](../../lib/content-services/search/search-widget.interface.ts) | diff --git a/docs/content-services/add-permission-panel.component.md b/docs/content-services/add-permission-panel.component.md index 0afa3f396b..4277ab124e 100644 --- a/docs/content-services/add-permission-panel.component.md +++ b/docs/content-services/add-permission-panel.component.md @@ -30,7 +30,7 @@ Searches for people or groups to add to the current node permissions. ## Details -This component uses a [Search component](../search.component.md) to retrieve the +This component uses a [Search component](search.component.md) to retrieve the groups and people that could be added to the permission list of the current node. The `select` event is emitted when a result is clicked from the list. diff --git a/docs/core/info-drawer-tab.md b/docs/core/info-drawer-tab.component.md similarity index 100% rename from docs/core/info-drawer-tab.md rename to docs/core/info-drawer-tab.component.md diff --git a/docs/core/menu-button.model.md b/docs/core/menu-button.model.md deleted file mode 100644 index 24bb3211a6..0000000000 --- a/docs/core/menu-button.model.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -Added: v2.4.0 -Status: Active -Last reviewed: 2018-05-25 ---- - -# Menu button model - -Defines the properties for an item in a [Buttons Menu component](../core/buttons-menu.component.md). - -## Basic usage - -```ts -let button = new MenuButton({ - label: 'Export', - icon: 'file_download', - handler: this.exportItem.bind(this), - id: 'export-button', - isVisible: this.isItemValid.bind(this) -}); -``` -## Class members - -## Properties - -| Name | Type | Description | -| ---- | ---- | ----------- | -| label | `string` | Label to display for the button. | -| icon | `string` | Icon to display for the button. | -| handler | `function` | Callback for the event handler for button clicks. | -| styles | `string` | CSS classes to apply to the button. | -| id | `string` | Id of the button. | -| isVisible | `function` | Boolean function that determines whether the button is visible (returns true) or hidden (returns false). | - -## Details - -An array of [`MenuButton`](../../lib/core/buttons-menu/menu-button.model.ts) instances is passed to the Button Menu component via its -`buttons` property. See the [Buttons Menu component](../core/buttons-menu.component.md) page for a code sample and -further details about setting up the menu. - -## See also - -- [Buttons menu component](../core/buttons-menu.component.md) diff --git a/docs/tutorials/creating-javascript-app-using-alfresco-js-api.md b/docs/tutorials/creating-javascript-app-using-alfresco-js-api.md index 899381d1c2..5c95b71586 100644 --- a/docs/tutorials/creating-javascript-app-using-alfresco-js-api.md +++ b/docs/tutorials/creating-javascript-app-using-alfresco-js-api.md @@ -20,11 +20,11 @@ The only prerequisite of this tutorial is that an instance of Alfresco Content S but its simplicity allows us to focus more on the development of the environment setup. If you don't have an instance of Alfresco Content Services up and running, see -[Preparing the development environment](./preparing-the-development-environment.html) +[Preparing the development environment](./preparing-environment.md) to learn how to set it up. You will need the `npm` client to download the requested Node libraries (also explained in -[Preparing the development environment](./preparing-the-development-environment.html)). +[Preparing the development environment](./preparing-environment.md)). ## Creating the JavaScript application diff --git a/docs/tutorials/creating-the-app-using-yeoman.md b/docs/tutorials/creating-the-app-using-yeoman.md index 1f0d0097c2..1f04b272ac 100644 --- a/docs/tutorials/creating-the-app-using-yeoman.md +++ b/docs/tutorials/creating-the-app-using-yeoman.md @@ -6,7 +6,7 @@ Level: Basic In this tutorial you are going to see how to create an ADF application from scratch, using the [Yeoman scaffolding tool](http://yeoman.io/). This is a "getting started" task that should enable you to start developing your own ADF application. ## Prerequisites -Before any further task, be sure you executed the optional section described in [the preparation of the development environment](./preparing-environment.html), dedicated to the installation of the ADF Yeoman generator. This is a requested prerequisite to complete this tutorial with success. +Before any further task, be sure you executed the optional section described in [the preparation of the development environment](./preparing-environment.md), dedicated to the installation of the ADF Yeoman generator. This is a requested prerequisite to complete this tutorial with success. ## Creating the ADF application The creation of a brand new application is straightforward using the [Yeoman generator](http://yeoman.io/). Open a terminal and execute the following command. diff --git a/docs/tutorials/working-with-nodes-api-service.md b/docs/tutorials/working-with-nodes-api-service.md index 05aa8a522b..618270227e 100644 --- a/docs/tutorials/working-with-nodes-api-service.md +++ b/docs/tutorials/working-with-nodes-api-service.md @@ -8,7 +8,7 @@ To focus the description on the `NodesApiService`, we will develop on top of the [Alfresco Example Content Application](https://github.com/Alfresco/alfresco-content-app). If you don't have it already installed in your development environment then see the *how-to* description in -[preparation of the development environment](./preparing-the-development-environment.md). +[preparation of the development environment](./preparing-environment.md). When you have the Alfresco Example Content Application up and running, edit the `FileComponent` defined in `src/app/components/files/files.component.ts`. Change the `onNodeDoubleClick` method diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 12dfd2f6bb..7f69e14b21 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -14,7 +14,7 @@ of components organized by ADF libraries. ## v2.4.0 -**Release:** Forthcoming
+**Released:** 2018-06-21 ([Release notes](https://community.alfresco.com/docs/DOC-7397))
**APS compatible version:** v1.6.4+
**ACS compatible version:** v5.2.3
@@ -30,7 +30,7 @@ of components organized by ADF libraries. - [Buttons menu component](core/buttons-menu.component.md) - [Empty content component](core/empty-content.component.md) - [Error content component](core/error-content.component.md) -- [Menu button model](core/menu-button.model.md) +- [Info drawer tab component](core/info-drawer-tab.component.md) - [Node permission dialog service](content-services/node-permission-dialog.service.md) - [Search check list component](content-services/search-check-list.component.md) - [Search date range component](content-services/search-date-range.component.md)