diff --git a/docs/accordion-group.component.md b/docs/accordion-group.component.md index 9def0e6bef..de21a4ee5f 100644 --- a/docs/accordion-group.component.md +++ b/docs/accordion-group.component.md @@ -32,7 +32,7 @@ export class MyComponent implements OnInit { ### Properties | Name | Type | Description | -| --- | --- | --- | +| ---- | ---- | ----------- | | heading | string | Title heading for the group. | | isSelected | boolean | Is this group currently selected? | | headingIcon | string | The material design icon. | @@ -43,9 +43,6 @@ export class MyComponent implements OnInit { Place one or more accordion groups within an [Accordion component](accordion.component.md) to define a menu. - - ## See also -- [Accordion component](accordion.component.md) - \ No newline at end of file +- [Accordion component](accordion.component.md) diff --git a/docs/accordion.component.md b/docs/accordion.component.md index c7c1867298..224076d161 100644 --- a/docs/accordion.component.md +++ b/docs/accordion.component.md @@ -32,7 +32,7 @@ export class MyComponent implements OnInit { ### Properties | Name | Type | Description | -| --- | --- | --- | +| ---- | ---- | ----------- | | heading | string | The header title. | | isSelected | boolean | Define if the accordion group is selected or not. | | headingIcon | string | The material design icon. | @@ -69,9 +69,7 @@ the following example: ![how-create-accordion-menu](docassets/images/how-to-create-accordion-menu.png) - - ## See also -- [Accordion group component](accordion-group.component.md) - \ No newline at end of file +- [Accordion group component](accordion-group.component.md) + diff --git a/docs/angular-material-design.md b/docs/angular-material-design.md index b5fd0dece5..b1ec5cb69f 100644 --- a/docs/angular-material-design.md +++ b/docs/angular-material-design.md @@ -2,7 +2,7 @@ Google's [Material Design](https://material.io/guidelines/material-design/introduction.html) -is an example of a *design language*, a +is an example of a _design language_, a general set of principles and ideas that are used to give designs a consistent look and feel. A design language might be used in-house by a company to maintain a "family resemblance" between its products or to @@ -53,9 +53,6 @@ See the Material Design [system icon docs](https://material.io/guidelines/style/icons.html#icons-system-icons) for further information and to download the set of standard icon images. - - ## See also -- [Theming](theming.md) - \ No newline at end of file +- [Theming](theming.md) diff --git a/docs/auth-guard-bpm.service.md b/docs/auth-guard-bpm.service.md index e60e94cc6c..fbba383834 100644 --- a/docs/auth-guard-bpm.service.md +++ b/docs/auth-guard-bpm.service.md @@ -31,13 +31,7 @@ either ACS or APS. See the [ADF custom page tutorial](https://community.alfresco.com/docs/DOC-6628-adf-105-creating-custom-pages-and-components) for worked examples of all three guards. - - ## See also -- [Auth guard ecm service](auth-guard-ecm.service.md) -- [Auth guard service](auth-guard.service.md) - - - - +- [Auth guard ecm service](auth-guard-ecm.service.md) +- [Auth guard service](auth-guard.service.md) diff --git a/docs/auth-guard-ecm.service.md b/docs/auth-guard-ecm.service.md index 213867218e..b19dcb2bff 100644 --- a/docs/auth-guard-ecm.service.md +++ b/docs/auth-guard-ecm.service.md @@ -31,13 +31,7 @@ either APS or ACS. See the [ADF custom page tutorial](https://community.alfresco.com/docs/DOC-6628-adf-105-creating-custom-pages-and-components) for worked examples of all three guards. - - ## See also -- [Auth guard service](auth-guard.service.md) -- [Auth guard bpm service](auth-guard-bpm.service.md) - - - - +- [Auth guard service](auth-guard.service.md) +- [Auth guard bpm service](auth-guard-bpm.service.md) diff --git a/docs/auth-guard.service.md b/docs/auth-guard.service.md index ea6a49a8e2..dd2ea4cb8d 100644 --- a/docs/auth-guard.service.md +++ b/docs/auth-guard.service.md @@ -32,13 +32,7 @@ against APS or ACS, respectively. See the [ADF custom page tutorial](https://community.alfresco.com/docs/DOC-6628-adf-105-creating-custom-pages-and-components) for worked examples of all three guards. - - ## See also -- [Auth guard bpm service](auth-guard-bpm.service.md) -- [Auth guard ecm service](auth-guard-ecm.service.md) - - - - +- [Auth guard bpm service](auth-guard-bpm.service.md) +- [Auth guard ecm service](auth-guard-ecm.service.md) diff --git a/docs/bpm-user.model.md b/docs/bpm-user.model.md index 03de2832b7..feba39a405 100644 --- a/docs/bpm-user.model.md +++ b/docs/bpm-user.model.md @@ -14,11 +14,8 @@ it is likely to change and so its properties are not listed here. For the latest version of the class, see the [source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/userinfo/models/bpm-user.model.ts). - - ## See also -- [Bpm user service](bpm-user.service.md) -- [Ecm user model](ecm-user.model.md) -- [People process service](people-process.service.md) - \ No newline at end of file +- [Bpm user service](bpm-user.service.md) +- [Ecm user model](ecm-user.model.md) +- [People process service](people-process.service.md) diff --git a/docs/bpm-user.service.md b/docs/bpm-user.service.md index d5d551f6fd..73c08c8fb5 100644 --- a/docs/bpm-user.service.md +++ b/docs/bpm-user.service.md @@ -21,10 +21,7 @@ and [getProfilePictureUrl](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProfileApi.md#getProfilePictureUrl) methods in the Alfresco JS API for more information about the REST calls used by this service. - - ## See also -- [Ecm user service](ecm-user.service.md) -- [Bpm user model](bpm-user.model.md) - \ No newline at end of file +- [Ecm user service](ecm-user.service.md) +- [Bpm user model](bpm-user.model.md) diff --git a/docs/breadcrumb.component.md b/docs/breadcrumb.component.md index e7a3f548b5..5e07e1f700 100644 --- a/docs/breadcrumb.component.md +++ b/docs/breadcrumb.component.md @@ -16,22 +16,19 @@ Indicates the current position within a navigation hierarchy. ### Properties | Name | Type | Description | -| --- | --- | --- | +| ---- | ---- | ----------- | | target | DocumentListComponent | (optional) DocumentList component to operate with. Upon clicks will instruct the given component to update. | | folderNode | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) | Active node, builds UI based on `folderNode.path.elements` collection. | -| root | string | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use i18n resource key for the property value. | +| root | string | (optional) Name of the root element of the breadcrumb. You can use this property to rename "Company Home" to "Personal Files" for example. You can use i18n resource key for the property value. | | rootId | string | (optional) The id of the root element. You can use this property to set a custom element the breadcrumb should start with. | ### Events | Name | Returned Type | Description | -| --- | --- | --- | -| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb | +| ---- | ------------- | ----------- | +| navigate | [PathElementEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PathElementEntity.md) | emitted when user clicks on a breadcrumb | - - ## See also -- [Document list component](document-list.component.md) -- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) - \ No newline at end of file +- [Document list component](document-list.component.md) +- [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) diff --git a/docs/comment-process.model.md b/docs/comment-process.model.md index d24f45bb5f..96d8fe6e15 100644 --- a/docs/comment-process.model.md +++ b/docs/comment-process.model.md @@ -19,9 +19,6 @@ class CommentProcessModel implements CommentRepresentation { } ``` - - ## See also -- [Comment process service](comment-process.service.md) - \ No newline at end of file +- [Comment process service](comment-process.service.md) diff --git a/docs/comment-process.service.md b/docs/comment-process.service.md index 4a8f479293..7e0f258d68 100644 --- a/docs/comment-process.service.md +++ b/docs/comment-process.service.md @@ -23,12 +23,6 @@ comments returned by the methods of this service. Also, the Comments API section [Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api) has further details about the underlying REST API. - - ## See also -- [Comment process model](comment-process.model.md) - - - - +- [Comment process model](comment-process.model.md) diff --git a/docs/content-node-selector.component.md b/docs/content-node-selector.component.md index 9630284316..56265fa44d 100644 --- a/docs/content-node-selector.component.md +++ b/docs/content-node-selector.component.md @@ -23,18 +23,17 @@ yourFunctionOnCopyOrMove(){ // place your action here on operation success! }); } - ``` #### Required parameters + The dialog needs this information to be correctly opened : | Name | Type | Description | -| --- | --- | --- | +| ---- | ---- | ----------- | | actionName | string | This will be the label for the confirm button of the dialog | | targetNode | [MinimalNodeEntryEntity](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/MinimalNode.md) | the node on which we are asking for copy/move action | -| neededPermissionForAction | string | needed permission to check to perform the relative action (es: copy will need the 'update' permission ) | - +| neededPermissionForAction | string | needed permission to check to perform the relative action (es: copy will need the 'update' permission ) | the `openCopyMoveDialog` method will return an [observable](http://reactivex.io/rxjs/manual/overview.html#observable) that can where you can subscribe to get the selection result and apply the custom actions. @@ -74,34 +73,32 @@ openSelectorDialog() { this.dialog.closeAll(); }); } - ``` + With this system your function has to take care of opening/closing the dialog. All the results will be streamed on the select [subject](http://reactivex.io/rxjs/manual/overview.html#subject) present into the `ContentNodeSelectorComponentData` object given to the dialog. When clicked on the action the data.select stream will be completed. ### Properties | Name | Type | Default | Description | -| --- | --- | --- | --- | +| ---- | ---- | ------- | ----------- | | title | string | "" | Text shown at the top of the selector | | currentFolderId | string | null | Node ID of the folder currently listed | -| dropdownHideMyFiles | boolean | false | Hide the "My Files" option added to the site list by default. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/sites-dropdown.component.md)| -| dropdownSiteList | [SitePaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | | custom site for site dropdown same as siteList. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/sites-dropdown.component.md#properties) | -| rowFilter | RowFilter | null | Custom row filter function. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/document-list.component.md#custom-row-filter)| +| dropdownHideMyFiles | boolean | false | Hide the "My Files" option added to the site list by default. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/sites-dropdown.component.md) | +| dropdownSiteList | [SitePaging](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | | custom site for site dropdown same as siteList. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/sites-dropdown.component.md#properties) | +| rowFilter | RowFilter | null | Custom row filter function. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/document-list.component.md#custom-row-filter) | | imageResolver | ImageResolver | null | Custom image resolver function. [See More](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/document-list.component.md#custom-image-resolver) | | pageSize | number | 10 | Number of items shown per page in the list | - ### Events | Name | Description | -| --- | --- | +| ---- | ----------- | | select | Emitted when the user has selected an item | - ### Using ContentNodeSelectorPanelComponent -```html +```html - ## See also -- [Document list component](document-list.component.md) - \ No newline at end of file +- [Document list component](document-list.component.md) diff --git a/docs/content.service.md b/docs/content.service.md index ad9a55a5c3..fbe9eb5928 100644 --- a/docs/content.service.md +++ b/docs/content.service.md @@ -28,7 +28,7 @@ some cases by viewing it directly in the browser via a special URL that referenc the Blob. For example, you could use the Blob interface to construct an image in the [PNG format](https://en.wikipedia.org/wiki/Portable_Network_Graphics). Since PNG is a format the browser can display, you could use the Blob's URL in an -<img> element to view the image within the page. Alternatively, you could let +<img> element to view the image within the page. Alternatively, you could let the user download it as a PNG file. The `downloadBlob` method starts a download of the Blob data to the `filename` @@ -40,20 +40,14 @@ for details of how a Blob's contents are assembled from the constructor argument Use `createdTrustedUrl` to generate a URL string for a Blob. The URL refers to the Blob as though it were a file but it is actually an object stored in memory, so it does not persist across browser sessions. This URL can be used much like any -other, so you could use it for the `src` attribute of an <img> element or the +other, so you could use it for the `src` attribute of an <img> element or the `href` of a download link. Note that while the URL is 'trusted', the data it contains is not necessarily trustworthy unless you can vouch for it yourself; be careful that the data doesn't expose your app to [Cross Site Scripting](https://en.wikipedia.org/wiki/Cross-site_scripting) attacks. - - ## See also -- [Cookie service](cookie.service.md) -- [Storage service](storage.service.md) - - - - +- [Cookie service](cookie.service.md) +- [Storage service](storage.service.md) diff --git a/docs/ecm-user.model.md b/docs/ecm-user.model.md index 8cd598cc8e..ae1b75083a 100644 --- a/docs/ecm-user.model.md +++ b/docs/ecm-user.model.md @@ -14,11 +14,8 @@ it is likely to change and so its properties are not listed here. For the latest version of the class, see the [source file](https://github.com/Alfresco/alfresco-ng2-components/blob/development/lib/core/userinfo/models/ecm-user.model.ts). - - ## See also -- [Ecm user service](ecm-user.service.md) -- [People content service](people-content.service.md) -- [Bpm user model](bpm-user.model.md) - \ No newline at end of file +- [Ecm user service](ecm-user.service.md) +- [People content service](people-content.service.md) +- [Bpm user model](bpm-user.model.md) diff --git a/docs/ecm-user.service.md b/docs/ecm-user.service.md index 9d12922459..93881e2f62 100644 --- a/docs/ecm-user.service.md +++ b/docs/ecm-user.service.md @@ -24,10 +24,7 @@ See the [getPerson](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PeopleApi.md#getPerson) method in the Alfresco JS API for more information about the REST calls used by this service. - - ## See also -- [Bpm user service](bpm-user.service.md) -- [Ecm user model](ecm-user.model.md) - \ No newline at end of file +- [Bpm user service](bpm-user.service.md) +- [Ecm user model](ecm-user.model.md) diff --git a/docs/extensibility.md b/docs/extensibility.md index 60755ab97e..7c1850baa2 100644 --- a/docs/extensibility.md +++ b/docs/extensibility.md @@ -2,9 +2,9 @@ _Note: it is assumed you are familiar with Alfresco Process Services (powered by Activiti) form definition structure._ -- How components and widgets are rendered on a Form -- Replacing default form widgets with custom components -- Replacing custom stencils with custom components +- How components and widgets are rendered on a Form +- Replacing default form widgets with custom components +- Replacing custom stencils with custom components ## How components and widgets are rendered on a Form @@ -63,7 +63,7 @@ formRenderingService.setComponentTypeResolver('text', customResolver, true); ### Default component mappings | Stencil Name | Field Type | Component Type | -| --- | --- | --- | +| ------------ | ---------- | -------------- | | Text | text | TextWidgetComponent | | Number | integer | NumberWidgetComponent | | Multi-line text | multi-line-text | MultilineTextWidgetComponentComponent | @@ -252,4 +252,11 @@ export class MyView { At runtime you should now see your custom Angular component rendered in place of the stencils: -![adf stencil runtime](docassets/images/adf-stencil-02.png) \ No newline at end of file +![adf stencil runtime](docassets/images/adf-stencil-02.png) + +## See Also + +- [Form field model](form-field.model.md) +- [Form rendering service](form-rendering.service.md) +- [Form component](form.component.md) +- [Widget component](widget.component.md)