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-3921] Reviewed docs where deprecated content was removed (#4170)

Browse Source 
* [ADF-3921] Reviewed cont services docs where deprecated stuff was removed

* [ADF-3921] Fixed YAML template and affected source links
This commit is contained in:
Andy Stark 2019-01-16 14:30:44 +00:00 committed by Eugenio Romano
parent ed6e390e19
commit ad572fed1d
13 changed files with 32 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/content-services/content-node-selector.component.md
View File

@ -2,7 +2,7 @@
Title: Content Node Selector component
Added: v2.0.0
Status: Active
Last reviewed: 2018-04-18
Last reviewed: 2019-01-16
---
# [Content Node Selector component](../../lib/content-services/content-node-selector/content-node-selector.component.ts "Defined in content-node-selector.component.ts")
@ -11,31 +11,6 @@ Allows a user to select items from a Content Services repository.
![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png)
## Contents
- [Class members](#class-members)
- [Properties](#properties)
- [Details](#details)
- [Showing the dialog](#showing-the-dialog)
- [Usage example](#usage-example)
- [RowFilter and ImageResolver](#rowfilter-and-imageresolver)
- [Using the breadcrumbTransform function](#using-the-breadcrumbtransform-function)
- [See also](#see-also)
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| currentFolderId | `string` | null | (**Deprecated:** in 2.1.0) |
| dropdownHideMyFiles | `boolean` | false | (**Deprecated:** in 2.1.0) |
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | (**Deprecated:** in 2.1.0) |
| imageResolver | `ImageResolver` | null | (**Deprecated:** in 2.1.0) |
| pageSize | `number` | | (**Deprecated:** in 2.1.0) |
| rowFilter | `RowFilter` | null | (**Deprecated:** in 2.1.0) |
| title | `string` | null | (**Deprecated:** in 2.1.0) |
## Details
The [Content Node Selector component](../content-services/content-node-selector.component.md) works a lot like the standard File Open/Save

15
docs/content-services/document-list.component.md
View File

@ -2,7 +2,7 @@
Title: Document List component
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-12
Last reviewed: 2019-01-16
---
# [Document List component](../../lib/content-services/document-list/components/document-list.component.ts "Defined in document-list.component.ts")
@ -98,7 +98,8 @@ Displays the documents from a repository.
The properties `currentFolderId` and `node` set the initial folder shown by
the Document List. They cannot be used together, so choose the one that suits your use case
best.
Document list will automatically show special icons for : `Smart Folder`, `Link to a Folder` and `Folder with rules` as showed in the picture below :
The Document list will automatically show special icons for : `Smart Folder`, `Link to a Folder` and `Folder with rules` as shown below :
![Document List Folders](../docassets/images/document-list-special-folder-icon.png)
@ -576,14 +577,14 @@ You can also add tooltips, styling, automatic column title translation and other
You can use the following components as column templates:
| Name | Description |
| --- | --- |
| ---- | ----------- |
| adf-name-column | Renders hyperlink-styled name of the node. Provides formatted tooltip. Emits `name-click` DOM event that can be handled by any parent component. |
| adf-library-name-column | Renders library name. Provides formatted tooltips and extra details for libraries with same names on the page. Emits `name-click` DOM event that can be handled by any parent component. |
| adf-library-role-column | Renders i18n-enabled information about Library (Site) role (`Manager`, `Collaborator`, `Contributor`, `Consumer`) |
| adf-library-status-column | Renders i18n-enabled information about Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`)|
| adf-library-status-column | Renders i18n-enabled information about Library (Site) status (`Public`, `Private`, `Moderated`, `Unknown`) |
| adf-trashcan-name-column | Renders a name of the deleted node. Distinguishes between a Library (Site) and File/Folder nodes. Provides proper tooltips. |
All components above require only `context` property to be bound,
All the components above require only the `context` property to be bound, since
each component fetches and renders the information it needs from the underlying node.
For example:
@ -596,8 +597,8 @@ For example:
</data-column>
```
> All the components above also participate in the Extensibility
> and can be used to compose DocumentList layouts from within the plugins.
All the components above also participate in [Extensibility](../user-guide/app-extensions.md)
and can be used to compose DocumentList layouts from within the plugins.
### Date Column

17
docs/content-services/document-list.service.md
View File

@ -2,7 +2,7 @@
Title: Document List service
Added: v2.0.0
Status: Active
Last reviewed: 2018-09-13
Last reviewed: 2019-01-16
---
# [Document List service](../../lib/content-services/document-list/services/document-list.service.ts "Defined in document-list.service.ts")
@ -18,11 +18,6 @@ Implements node operations used by the [Document List component](../content-serv
- _nodeId:_ `string` - The id of the node to be copied
- _targetParentId:_ `string` - The id of the folder where the node will be copied
- **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the copied node
- **createFolder**(name: `string`, parentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`>`<br/>
Creates a new folder in the path.
- _name:_ `string` - Folder name
- _parentId:_ `string` - Parent folder ID
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntity`](../content-services/document-library.model.md)`>` - Details of the created folder node
- **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes a node.
- _nodeId:_ `string` - ID of the node to delete
@ -30,9 +25,9 @@ Implements node operations used by the [Document List component](../content-serv
- **getDefaultMimeTypeIcon**(): `string`<br/>
Gets a default icon for MIME types with no specific icon.
- **Returns** `string` - Path to the icon file
- **getDocumentThumbnailUrl**(node: [`MinimalNodeEntity`](../content-services/document-library.model.md)): `string`<br/>
- **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `string`<br/>
Get thumbnail URL for the given document node.
- _node:_ [`MinimalNodeEntity`](../content-services/document-library.model.md) - Node to get URL for.
- _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) - Node to get URL for.
- **Returns** `string` - Thumbnail URL string
- **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>`<br/>
Gets the folder node with the specified relative name path below the root node.
@ -40,11 +35,11 @@ Implements node operations used by the [Document List component](../content-serv
- _opts:_ `any` - (Optional) Options.
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts)`>` - Details of the folder
- **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>`<br/>
(**Deprecated:** 2.3.0) Gets a folder node via its node ID.
- **getFolderNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
Gets a folder node via its node ID.
- _nodeId:_ `string` - ID of the folder node
- _includeFields:_ `string[]` - Extra information to include (available options are "aspectNames", "isLink" and "association")
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` - Details of the folder
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
- **getMimeTypeIcon**(mimeType: `string`): `string`<br/>
Gets the icon that represents a MIME type.
- _mimeType:_ `string` - MIME type to get the icon for

2
docs/content-services/file-uploading-dialog.component.md
View File

@ -2,7 +2,7 @@
Title: File Uploading Dialog Component
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-20
Last reviewed: 2019-01-16
---
# [File Uploading Dialog Component](../../lib/content-services/upload/components/file-uploading-dialog.component.ts "Defined in file-uploading-dialog.component.ts")

2
docs/content-services/search-control.component.md
View File

@ -2,7 +2,7 @@
Title: Search control component
Added: v2.0.0
Status: Active
Last reviewed: 2018-11-14
Last reviewed: 2019-01-16
---
# [Search control component](../../lib/content-services/search/components/search-control.component.ts "Defined in search-control.component.ts")

6
docs/content-services/search-filter.component.md
View File

@ -177,7 +177,7 @@ The properties of the `options` objects are as follows:
| Name | Type | Description |
| ---- | ---- | ----------- |
| key | string | Unique key to identify the entry. This can also be used to map DataColumn instances. |
| key | string | Unique key to identify the entry. This can also be used to map [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) instances. |
| label | string | Display text, which can also be an [i18n resource key](../user-guide/internationalization.md). |
| type | string | This specifies how to order the results. It can be based on a field, based on the position of the document in the index, or by score/relevance. |
| field | string | The name of the field. |
@ -189,7 +189,7 @@ for further details.
### Categories and widgets
The Search [Settings component](../../demo-shell/src/app/components/settings/settings.component.ts) and Query Builder require a `categories` section in the
The Search Settings component and Query Builder require a `categories` section in the
configuration.
Categories are used to configure the UI widgets that let the user edit the search query
@ -229,7 +229,7 @@ a category:
| [Slider](search-slider.component.md) | `slider` | Selects a single numeric value in a given range that a field may contain |
| [Text](search-text.component.md) | `text` | Specifies a text value that a field may contain |
See the individual search widget pages for full details of their usage and settings.
See the individual [search widget](../../lib/content-services/search/search-widget.interface.ts) pages for full details of their usage and settings.
You can also implement your own custom search widgets. See the [`SearchWidget`](../../lib/content-services/search/search-widget.interface.ts) interface
page for full details of how to do this.

2
docs/content-services/search-filter.service.md
View File

@ -28,7 +28,7 @@ export class MyAppOrComponent {
}
```
See the Search Widget interface page for details about creating your own
See the [Search Widget](../../lib/content-services/search/search-widget.interface.ts) interface page for details about creating your own
custom search widgets.
## See also

2
docs/content-services/search-widget.interface.md
View File

@ -43,7 +43,7 @@ export interface SearchWidget {
The [Search Filter component](../content-services/search-filter.component.md) uses widgets to provide the UI that lets the user customize the
search. ADF provides a number of widgets out of the box (see the [See Also](#see-also) section
for a full list) but you can also implement your own. Both built-in and custom widgets must
implement the Search Widget interface to operate with the [Search Filter component](../content-services/search-filter.component.md).
implement the [Search Widget](../../lib/content-services/search/search-widget.interface.ts) interface to operate with the [Search Filter component](../content-services/search-filter.component.md).
### Implementing a custom widget

5
docs/content-services/search.component.md
View File

@ -2,7 +2,7 @@
Title: Search component
Added: v2.0.0
Status: Active
Last reviewed: 2018-04-13
Last reviewed: 2019-01-16
---
# [Search component](../../lib/content-services/search/components/search.component.ts "Defined in search.component.ts")
@ -40,6 +40,7 @@ Searches items for supplied search terms.
| maxResults | `number` | 20 | Maximum number of results to show in the search. |
| searchTerm | `string` | "" | Search term to use when executing the search. Updating this value will run a new search and update the results. |
| skipResults | `number` | 0 | Number of results to skip from the results pagination. |
| classList | `void` | | CSS class for display. |
### Events
@ -152,7 +153,7 @@ By doing this, you can get the results as the user types into the input text.
You can get finer control over the parameters of a search by defining them in a custom
[QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md)
object. The recommended way to do this is with a custom implementation of the
. The ADF source provides a standard implementation of this
[Search Configuration interface](../core/search-configuration.interface.md). The ADF source provides a standard implementation of this
interface, [`SearchConfigurationService`](../core/search-configuration.service.md) that you can use as a base to adapt to your needs. See the
[Search Configuration interface](../core/search-configuration.interface.md) page for full details of how to
customize your search.

3
docs/content-services/upload-button.component.md
View File

@ -2,7 +2,7 @@
Title: Upload Button Component
Added: v2.0.0
Status: Active
Last reviewed: 2018-09-13
Last reviewed: 2019-01-16
---
# [Upload Button Component](../../lib/content-services/upload/components/upload-button.component.ts "Defined in upload-button.component.ts")
@ -47,7 +47,6 @@ Activates a file upload.
| Name | Type | Description |
| ---- | ---- | ----------- |
| beginUpload | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UploadFilesEvent`](../../lib/content-services/upload/components/upload-files.event.ts)`>` | Emitted when the upload begins. |
| createFolder | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when a folder is created. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when an error occurs. |
| permissionEvent | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`PermissionModel`](../../lib/content-services/document-list/models/permissions.model.ts)`>` | Emitted when create permission is missing. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the file is uploaded successfully. |

3
docs/content-services/upload-drag-area.component.md
View File

@ -2,7 +2,7 @@
Title: Upload Drag Area Component
Added: v2.0.0
Status: Active
Last reviewed: 2018-09-13
Last reviewed: 2019-01-16
---
# [Upload Drag Area Component](../../lib/content-services/upload/components/upload-drag-area.component.ts "Defined in upload-drag-area.component.ts")
@ -69,7 +69,6 @@ as the drag/drop target:
| rootFolderId | `string` | "-root-" | The ID of the root. Use the nodeId for Content Services or the taskId/processId for Process Services. |
| versioning | `boolean` | false | Toggles versioning. |
### Events
| Name | Type | Description |

8
docs/content-services/version-list.component.md
View File

@ -2,7 +2,7 @@
Title: Version List component
Added: v2.0.0
Status: Experimental
Last reviewed: 2018-05-08
Last reviewed: 2019-01-16
---
# [Version List component](../../lib/content-services/version-manager/version-list.component.ts "Defined in version-list.component.ts")
@ -22,7 +22,7 @@ Displays the version history of a node in a [Version Manager component](../conte
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| allowDownload | `boolean` | true | Enable/disable downloading a version of the current node. |
| node | [`MinimalNodeEntryEntity`](../content-services/document-library.model.md) | | The target node. |
| node | `Node` | | The target node. |
| showActions | `boolean` | true | Toggles showing/hiding of version actions |
| showComments | `boolean` | true | Toggles showing/hiding of comments |
@ -30,8 +30,8 @@ Displays the version history of a node in a [Version Manager component](../conte
| Name | Type | Description |
| ---- | ---- | ----------- |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`MinimalNodeEntryEntity`](../content-services/document-library.model.md)`>` | Emitted when a version is restored |
| deleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a version is deleted |
| restored | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Node>` | Emitted when a version is restored |
## Details

2
tools/doc/yamlTemplates/template.ejs
View File

@ -3,7 +3,7 @@ items:
name: <%= name %>
fullName: <%= name %>
source:
path: <%= sources[0].fileName %>
path: <%= 'lib/' + sources[0].fileName %>
startLine: <%= sources[0].line %>
children:
<%_ if (typeof children !== "undefined") { -%>