From 86cc219bc4321c91f85d8f6114ade892ef3e28a4 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Wed, 14 Mar 2018 15:38:55 +0000 Subject: [PATCH] [ADF-2463] Moved doc files into subfolders (#3080) --- docs/README.md | 82 +++++++++---------- docs/alfresco-content.service.md | 2 +- .../breadcrumb.component.md | 4 +- .../content-action.component.md | 16 ++-- .../content-metadata.component.md | 2 +- .../content-node-dialog.service.md | 0 .../content-node-selector-panel.component.md | 4 +- .../content-node-selector.component.md | 2 +- .../document-actions.service.md | 0 .../document-library.model.md | 8 +- .../document-list.component.md | 42 +++++----- .../document-list.service.md | 0 .../dropdown-breadcrumb.component.md | 2 +- .../file-uploading-dialog.component.md | 0 .../folder-actions.service.md | 0 .../folder-create.directive.md | 0 .../folder-edit.directive.md | 0 docs/{ => content-services}/like.component.md | 2 +- .../node-download.directive.md | 0 .../permissions-style.model.md | 2 +- .../rating.component.md | 2 +- docs/{ => content-services}/rating.service.md | 0 .../search-control.component.md | 2 +- .../search.component.md | 12 +-- .../sites-dropdown.component.md | 4 +- .../tag-actions.component.md | 2 +- .../tag-list.component.md | 2 +- .../tag-node-list.component.md | 2 +- docs/{ => content-services}/tag.service.md | 0 .../upload-button.component.md | 76 +++++++++-------- .../upload-drag-area.component.md | 0 .../version-list.component.md | 2 +- .../version-manager.component.md | 2 +- .../webscript.component.md | 4 +- docs/core/data-column.component.md | 4 +- docs/core/deleted-nodes-api.service.md | 6 +- docs/{ => core}/file-draggable.directive.md | 2 +- docs/{ => core}/node.service.md | 2 +- docs/{ => core}/nodes-api.service.md | 18 ++-- docs/{ => core}/renditions.service.md | 2 +- .../search-configuration.interface.md | 2 +- .../search-configuration.service.md | 2 +- docs/{ => core}/viewer.component.md | 12 +-- docs/datatable.component.md | 2 +- docs/infinite-pagination.component.md | 2 +- docs/start-process.component.md | 2 +- docs/task-attachment-list.component.md | 4 +- docs/versionIndex.md | 76 ++++++++--------- 48 files changed, 206 insertions(+), 208 deletions(-) rename docs/{ => content-services}/breadcrumb.component.md (97%) rename docs/{ => content-services}/content-action.component.md (93%) rename docs/{ => content-services}/content-metadata.component.md (99%) rename docs/{ => content-services}/content-node-dialog.service.md (100%) rename docs/{ => content-services}/content-node-selector-panel.component.md (94%) rename docs/{ => content-services}/content-node-selector.component.md (98%) rename docs/{ => content-services}/document-actions.service.md (100%) rename docs/{ => content-services}/document-library.model.md (90%) rename docs/{ => content-services}/document-list.component.md (94%) rename docs/{ => content-services}/document-list.service.md (100%) rename docs/{ => content-services}/dropdown-breadcrumb.component.md (94%) rename docs/{ => content-services}/file-uploading-dialog.component.md (100%) rename docs/{ => content-services}/folder-actions.service.md (100%) rename docs/{ => content-services}/folder-create.directive.md (100%) rename docs/{ => content-services}/folder-edit.directive.md (100%) rename docs/{ => content-services}/like.component.md (92%) rename docs/{ => content-services}/node-download.directive.md (100%) rename docs/{ => content-services}/permissions-style.model.md (94%) rename docs/{ => content-services}/rating.component.md (90%) rename docs/{ => content-services}/rating.service.md (100%) rename docs/{ => content-services}/search-control.component.md (97%) rename docs/{ => content-services}/search.component.md (88%) rename docs/{ => content-services}/sites-dropdown.component.md (87%) rename docs/{ => content-services}/tag-actions.component.md (93%) rename docs/{ => content-services}/tag-list.component.md (85%) rename docs/{ => content-services}/tag-node-list.component.md (90%) rename docs/{ => content-services}/tag.service.md (100%) rename docs/{ => content-services}/upload-button.component.md (94%) rename docs/{ => content-services}/upload-drag-area.component.md (100%) rename docs/{ => content-services}/version-list.component.md (85%) rename docs/{ => content-services}/version-manager.component.md (95%) rename docs/{ => content-services}/webscript.component.md (97%) rename docs/{ => core}/file-draggable.directive.md (96%) rename docs/{ => core}/node.service.md (98%) rename docs/{ => core}/nodes-api.service.md (90%) rename docs/{ => core}/renditions.service.md (94%) rename docs/{ => core}/search-configuration.interface.md (98%) rename docs/{ => core}/search-configuration.service.md (94%) rename docs/{ => core}/viewer.component.md (96%) diff --git a/docs/README.md b/docs/README.md index edd92fd165..2186c9b4aa 100644 --- a/docs/README.md +++ b/docs/README.md @@ -74,7 +74,7 @@ for more information about installing and using the source code. | [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) | +| [Viewer component](core/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | ## Directives @@ -119,14 +119,14 @@ for more information about installing and using the source code. | [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](core/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](core/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | -| [Node service](node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.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](process-services/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](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) | +| [Authentication service](authentication.service.md) | Provides authentication to ACS and APS. | [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) | @@ -135,13 +135,13 @@ for more information about installing and using the source code. | [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) | | [Log service](log.service.md) | Provide a log functionality for your ADF application. | [Source](../lib/core/services/log.service.ts) | -| [Nodes api service](nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | +| [Nodes api service](core/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | | [Notification service](core/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/services/notification.service.ts) | | [Page title service](core/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | | [People content service](core/people-content.service.md) | Gets information about a Content Services user. | [Source](../lib/core/services/people-content.service.ts) | | [People process service](core/people-process.service.md) | Gets information about Process Services users. | [Source](../lib/core/services/people-process.service.ts) | -| [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) | +| [Renditions service](core/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](core/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](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) | @@ -166,7 +166,7 @@ for more information about installing and using the source code. | ---- | ----------- | ----------- | | [Data Table Adapter interface](datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | | [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | -| [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | +| [Search Configuration interface](core/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | [(Back to Contents)](#contents) @@ -183,55 +183,55 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Breadcrumb component](breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) | -| [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) | -| [Content metadata component](content-metadata.component.md) | Allows a user to display and edit metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) | -| [Content node selector panel component](content-node-selector-panel.component.md) | Opens a [Content Node Selector](content-node-selector.component.md) in its own dialog window. | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | -| [Content node selector component](content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) | -| [Content action component](content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) | -| [Document list component](document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-list.component.ts) | -| [Search control component](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 component](search.component.md) | Searches items for supplied search terms. | [Source](../lib/content-services/search/components/search.component.ts) | -| [Sites dropdown component](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](like.component.md) | Allows a user to add "likes" to an item. | [Source](../lib/content-services/social/like.component.ts) | -| [Rating component](rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) | -| [Tag actions component](tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/tag/tag-actions.component.ts) | -| [Tag list component](tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/tag/tag-list.component.ts) | -| [Tag node list component](tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/tag/tag-node-list.component.ts) | -| [File uploading dialog component](file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) | -| [Upload button component](upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/upload/components/upload-button.component.ts) | -| [Upload drag area component](upload-drag-area.component.md) | Adds a drag and drop area to upload files to Alfresco. | [Source](../lib/content-services/upload/components/upload-drag-area.component.ts) | -| [Version list component](version-list.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays the version history of a node in a [Version Manager component](version-manager.component.md) | [Source](../lib/content-services/version-manager/version-list.component.ts) | -| [Version manager component](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](webscript.component.md) | Provides access to Webscript features. | [Source](../lib/content-services/webscript/webscript.component.ts) | +| [Breadcrumb component](content-services/breadcrumb.component.md) | Indicates the current position within a navigation hierarchy. | [Source](../lib/content-services/breadcrumb/breadcrumb.component.ts) | +| [Dropdown breadcrumb component](content-services/dropdown-breadcrumb.component.md) | Indicates the current position within a navigation hierarchy using a dropdown menu. | [Source](../lib/content-services/breadcrumb/dropdown-breadcrumb.component.ts) | +| [Content metadata component](content-services/content-metadata.component.md) | Allows a user to display and edit metadata related to a node. | [Source](../lib/content-services/content-metadata/components/content-metadata/content-metadata.component.ts) | +| [Content node selector panel component](content-services/content-node-selector-panel.component.md) | Opens a Content Node Selector in its own dialog window. | [Source](../lib/content-services/content-node-selector/content-node-selector-panel.component.ts) | +| [Content node selector component](content-services/content-node-selector.component.md) | Allows a user to select items from a Content Services repository. | [Source](../lib/content-services/content-node-selector/content-node-selector.component.ts) | +| [Content action component](content-services/content-action.component.md) | Adds options to a Document List actions menu for a particular content type. | [Source](../lib/content-services/document-list/components/content-action/content-action.component.ts) | +| [Document list component](content-services/document-list.component.md) | Displays the documents from a repository. | [Source](../lib/content-services/document-list/components/document-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 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) | +| [Rating component](content-services/rating.component.md) | Allows a user to add ratings to an item. | [Source](../lib/content-services/social/rating.component.ts) | +| [Tag actions component](content-services/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/tag/tag-actions.component.ts) | +| [Tag list component](content-services/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/tag/tag-list.component.ts) | +| [Tag node list component](content-services/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/tag/tag-node-list.component.ts) | +| [File uploading dialog component](content-services/file-uploading-dialog.component.md) | Shows a dialog listing all the files uploaded with the Upload Button or Drag Area components. | [Source](../lib/content-services/upload/components/file-uploading-dialog.component.ts) | +| [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 Alfresco. | [Source](../lib/content-services/upload/components/upload-drag-area.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 | [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) | | _Upload version button component_ | _Not currently documented_ | [Source](../lib/content-services/upload/components/upload-version-button.component.ts) | ## Directives | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Node download directive](node-download.directive.md) | Allows folders and/or files to be downloaded. Multiple nodes are packed as a '.ZIP' archive. | [Source](../lib/content-services/directives/node-download.directive.ts) | -| [Folder create directive](folder-create.directive.md) | Allows folders to be created. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) | -| [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) | -| [File draggable directive](file-draggable.directive.md) | Provide drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) | +| [Node download directive](content-services/node-download.directive.md) | Allows folders and/or files to be downloaded. Multiple nodes are packed as a '.ZIP' archive. | [Source](../lib/content-services/directives/node-download.directive.ts) | +| [Folder create directive](content-services/folder-create.directive.md) | Allows folders to be created. | [Source](../lib/content-services/folder-directive/folder-create.directive.ts) | +| [Folder edit directive](content-services/folder-edit.directive.md) | Allows folders to be edited. | [Source](../lib/content-services/folder-directive/folder-edit.directive.ts) | +| [File draggable directive](core/file-draggable.directive.md) | Provide drag-and-drop features for an element such as a `div`. | [Source](../lib/content-services/upload/directives/file-draggable.directive.ts) | ## Models | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Document library model](document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../lib/content-services/document-list/models/document-library.model.ts) | -| [Permissions style model](permissions-style.model.md) | Sets custom CSS styles for rows of a [Document List](document-list.component.md) according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) | +| [Document library model](content-services/document-library.model.md) | Defines classes for use with the Content Services node API. | [Source](../lib/content-services/document-list/models/document-library.model.ts) | +| [Permissions style model](content-services/permissions-style.model.md) | Sets custom CSS styles for rows of a Document List according to the item's permissions. | [Source](../lib/content-services/document-list/models/permissions-style.model.ts) | ## Services | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Content node dialog service](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) | -| [Document actions service](document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/document-actions.service.ts) | -| [Document list service](document-list.service.md) | Implements node operations used by the Document List component. | [Source](../lib/content-services/document-list/services/document-list.service.ts) | -| [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../lib/content-services/document-list/services/folder-actions.service.ts) | -| [Rating service](rating.service.md) | Manages ratings for items in Content Services. | [Source](../lib/content-services/social/services/rating.service.ts) | -| [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../lib/content-services/tag/services/tag.service.ts) | +| [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) | +| [Document actions service](content-services/document-actions.service.md) | Implements the document menu actions for the Document List component. | [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. | [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. | [Source](../lib/content-services/document-list/services/folder-actions.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) | @@ -269,7 +269,7 @@ for more information about installing and using the source code. | [Start process component](start-process.component.md) | Starts a process. | [Source](../lib/process-services/process-list/components/start-process.component.ts) | | [Checklist component](process-services/checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/task-list/components/checklist.component.ts) | | [Start task component](start-task.component.md) | Creates/Starts new task for the specified app | [Source](../lib/process-services/task-list/components/start-task.component.ts) | -| [Task details component](task-details.component.md) | Shows the details of the task id passed in input | [Source](../lib/process-services/task-list/components/task-details.component.ts) | +| [Task details component](task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/task-list/components/task-details.component.ts) | | [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) | | [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/task-list/components/task-header.component.ts) | | [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/task-list/components/task-list.component.ts) | diff --git a/docs/alfresco-content.service.md b/docs/alfresco-content.service.md index ef99d57342..7a314585c2 100644 --- a/docs/alfresco-content.service.md +++ b/docs/alfresco-content.service.md @@ -29,7 +29,7 @@ Checks if the the node has the `allowableOperations` property. ## Details The methods that take a `node` parameter can receive the node as either a node ID string -or as a [MinimalNode](document-library.model.md) object. You can obtain the `ticket` string, +or as a [MinimalNode](content-services/document-library.model.md) object. You can obtain the `ticket` string, if you need it, from the [Authentication service](authentication.service.md). If `attachment` is false then the content can be viewed in the browser but not downloaded; the default value of true allows a download to take place. diff --git a/docs/breadcrumb.component.md b/docs/content-services/breadcrumb.component.md similarity index 97% rename from docs/breadcrumb.component.md rename to docs/content-services/breadcrumb.component.md index 039d19eb90..4247189a3f 100644 --- a/docs/breadcrumb.component.md +++ b/docs/content-services/breadcrumb.component.md @@ -8,7 +8,7 @@ Last reviewed: 2018-03-12 Indicates the current position within a navigation hierarchy. -![Breadcrumb](docassets/images/breadcrumb.png) +![Breadcrumb](../docassets/images/breadcrumb.png) ## Basic Usage @@ -84,7 +84,7 @@ A transform function to remove the "Sites" folder from the path would look somet Below, the breadcrumb is shown before and after the transform function is applied: -![Content Node Selector breadcrumbTransfrom before/after screenshot](docassets/images/breadcrumbTransform.png) +![Content Node Selector breadcrumbTransfrom before/after screenshot](../docassets/images/breadcrumbTransform.png) ## See also diff --git a/docs/content-action.component.md b/docs/content-services/content-action.component.md similarity index 93% rename from docs/content-action.component.md rename to docs/content-services/content-action.component.md index 166370751c..e34b2d5c63 100644 --- a/docs/content-action.component.md +++ b/docs/content-services/content-action.component.md @@ -6,7 +6,7 @@ Status: Active Adds options to a Document List actions menu for a particular content type. -![Document Actions](docassets/images/document-actions.png) +![Document Actions](../docassets/images/document-actions.png) ## Contents @@ -150,7 +150,7 @@ type and other details of the item just deleted: } ``` -![Custom delete message screenshot](docassets/images/ContentActSnackMessage.png) +![Custom delete message screenshot](../docassets/images/ContentActSnackMessage.png) ### Built-in action examples @@ -178,11 +178,11 @@ an item for users who don't have permission to use it (set `disableWithNoPermiss ``` -![Delete disable action button](docassets/images/content-action-disable-delete-button.png) +![Delete disable action button](../docassets/images/content-action-disable-delete-button.png) You can also implement the `permissionEvent` to handle permission errors (to show the user a notification, for example). Subscribe to this event from your component -and use the [Notification service](core/notification.service.md) to show a message. +and use the [Notification service](../core/notification.service.md) to show a message. ```html @@ -210,7 +210,7 @@ export class MyComponent { } ``` -![Delete show notification message](docassets/images/content-action-notification-message.png) +![Delete show notification message](../docassets/images/content-action-notification-message.png) #### Download @@ -230,7 +230,7 @@ This action simply starts a download of the corresponding document file. ``` -![Download document action](docassets/images/document-action-download.png) +![Download document action](../docassets/images/document-action-download.png) #### Copy and move @@ -238,7 +238,7 @@ These actions show the destination chooser dialog for copy and move actions. By the destination chooser lists all the folders of the subject item's parent. However, it won't allow the item being copied/moved to be the destination if it is itself a folder. -![Copy/move dialog](docassets/images/document-action-copymovedialog.png) +![Copy/move dialog](../docassets/images/document-action-copymovedialog.png) ```html @@ -280,7 +280,7 @@ Defining error, permission and success callbacks are pretty much the same as doi - The success callback's only parameter is the translatable success message string (could be used for showing in snackbar for example) - The permissionEvent callback is the same as described above with the delete action -![Copy/move document action](docassets/images/document-action-copymove.png) +![Copy/move document action](../docassets/images/document-action-copymove.png) ### Customizing built-in actions diff --git a/docs/content-metadata.component.md b/docs/content-services/content-metadata.component.md similarity index 99% rename from docs/content-metadata.component.md rename to docs/content-services/content-metadata.component.md index 7e7b119dd7..20239f35c0 100644 --- a/docs/content-metadata.component.md +++ b/docs/content-services/content-metadata.component.md @@ -6,7 +6,7 @@ Status: Active Allows a user to display and edit metadata related to a node. - + ## Basic Usage diff --git a/docs/content-node-dialog.service.md b/docs/content-services/content-node-dialog.service.md similarity index 100% rename from docs/content-node-dialog.service.md rename to docs/content-services/content-node-dialog.service.md diff --git a/docs/content-node-selector-panel.component.md b/docs/content-services/content-node-selector-panel.component.md similarity index 94% rename from docs/content-node-selector-panel.component.md rename to docs/content-services/content-node-selector-panel.component.md index f8d5a01ef9..6ab743c0c8 100644 --- a/docs/content-node-selector-panel.component.md +++ b/docs/content-services/content-node-selector-panel.component.md @@ -6,9 +6,9 @@ Last reviewed: 2018-03-12 # Content Node Selector Panel component -Opens a [Content Node Selector](content-node-selector.component.md) in its own dialog window. +Opens a Content Node Selector in its own dialog window. -![Content Node Selector screenshot](docassets/images/ContentNodeSelector.png) +![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png) ## Basic Usage diff --git a/docs/content-node-selector.component.md b/docs/content-services/content-node-selector.component.md similarity index 98% rename from docs/content-node-selector.component.md rename to docs/content-services/content-node-selector.component.md index 5610e5c667..80404a45b4 100644 --- a/docs/content-node-selector.component.md +++ b/docs/content-services/content-node-selector.component.md @@ -7,7 +7,7 @@ Last reviewed: 2018-03-12 Allows a user to select items from a Content Services repository. -![Content Node Selector screenshot](docassets/images/ContentNodeSelector.png) +![Content Node Selector screenshot](../docassets/images/ContentNodeSelector.png) ## Basic Usage diff --git a/docs/document-actions.service.md b/docs/content-services/document-actions.service.md similarity index 100% rename from docs/document-actions.service.md rename to docs/content-services/document-actions.service.md diff --git a/docs/document-library.model.md b/docs/content-services/document-library.model.md similarity index 90% rename from docs/document-library.model.md rename to docs/content-services/document-library.model.md index 2c4a720f85..a2b508049d 100644 --- a/docs/document-library.model.md +++ b/docs/content-services/document-library.model.md @@ -9,11 +9,11 @@ Defines classes for use with the Content Services node API. ## Details ADF provides several services that give higher-level access to -underlying [Alfresco JS Api](alfresco-api.service.md) functionality. +underlying [Alfresco JS Api](../alfresco-api.service.md) functionality. The classes defined below are used in some of these services to access the Content Services nodes API. You can use these services to access the nodes (ie, documents and folders) of a repository using their -associated ID strings. See [Nodes Api service](nodes-api.service.md) +associated ID strings. See [Nodes Api service](../core/nodes-api.service.md) for more detail about the usage of these classes. ## Node information @@ -23,7 +23,7 @@ These classes contain basic information about nodes (see about some of the properties). For example, this is used by the [Document List component](document-list.component.md) to supply a [data context](document-list.component.md#underlying-node-object) -for each row of the list. The [Nodes Api service](nodes-api.service.md) +for each row of the list. The [Nodes Api service](../core/nodes-api.service.md) has methods for getting the full information for a node ID string. ```ts @@ -113,5 +113,5 @@ class PathElementEntity { ## See also - [Document list component](document-list.component.md) -- [Nodes api service](nodes-api.service.md) +- [Nodes api service](../core/nodes-api.service.md) \ No newline at end of file diff --git a/docs/document-list.component.md b/docs/content-services/document-list.component.md similarity index 94% rename from docs/document-list.component.md rename to docs/content-services/document-list.component.md index 11472129c6..d852519167 100644 --- a/docs/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -8,7 +8,7 @@ Last reviewed: 2018-03-09 Displays the documents from a repository. -![Custom columns](docassets/images/custom-columns.png) +![Custom columns](../docassets/images/custom-columns.png) ## Contents @@ -122,7 +122,7 @@ have at least the following properties as part of the `Event.detail` property va } ``` -See the [DataTable](datatable.component.md) documentation for further details about +See the [DataTable](../datatable.component.md) documentation for further details about the other DOM events that the Document List component bubbles up from the DataTable. Below is a basic example of handling DOM events in the parent elements. @@ -145,7 +145,7 @@ Below is a basic example of handling DOM events in the parent elements. The Document List has an option to display items as "cards" instead of the standard view: -![card-view](docassets/images/document-list-card-view.png) +![card-view](../docassets/images/document-list-card-view.png) Set the `[display]` property to "gallery" to enable card view mode: @@ -359,7 +359,7 @@ export class FilesComponent implements OnInit { The `console.log(node)` for the `getNodeInfo` callback is just for study and debug purposes. It is useful for examining other information that you can access if necessary: -![documentLibrary](docassets/images/documentLibrary.png) +![documentLibrary](../docassets/images/documentLibrary.png) **Important note**: for this particular scenario you must also trigger `changeDetector.detectChanges()` as in the example above. @@ -420,7 +420,7 @@ export class MyAppComponent implements AfterViewInit { The example above should produce the following browser console output: -![view-child](docassets/images/viewchild.png) +![view-child](../docassets/images/viewchild.png) Now you can access Document List properties or call methods directly: @@ -518,10 +518,10 @@ A custom set of columns might look like the following: ``` -![Custom columns](docassets/images/custom-columns.png) +![Custom columns](../docassets/images/custom-columns.png) You can also use the HTML-based schema declaration used by -[DataTable](datatable.component.md), [Task List](task-list.component.md) and other components: +[DataTable](../datatable.component.md), [Task List](../task-list.component.md) and other components: ```html @@ -535,7 +535,7 @@ You can also use the HTML-based schema declaration used by ``` -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. +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](core/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: @@ -618,7 +618,7 @@ export class MyView { } ``` -![Folder context menu](docassets/images/folder-context-menu.png) +![Folder context menu](../docassets/images/folder-context-menu.png) This single extra line in the template enables context menu items for documents and folders. @@ -758,7 +758,7 @@ export class View1 { By default, the Document List provides the following content for the empty folder: -![Default empty folder](docassets/images/empty-folder-template-default.png) +![Default empty folder](../docassets/images/empty-folder-template-default.png) However, you can change this by defining your own custom HTML template: @@ -774,14 +774,14 @@ However, you can change this by defining your own custom HTML template: This will give the following output: -![Custom empty folder](docassets/images/empty-folder-template-custom.png) +![Custom empty folder](../docassets/images/empty-folder-template-custom.png) ### Custom 'permission denied' template By default, the Document List shows the following content when permission is denied: -![Default no permission](docassets/images/no-permission-default.png) +![Default no permission](../docassets/images/no-permission-default.png) You can change this by defining your own custom HTML template: @@ -797,18 +797,18 @@ You can change this by defining your own custom HTML template: This will give the following output: -![Custom no permission](docassets/images/no-permission-custom.png) +![Custom no permission](../docassets/images/no-permission-custom.png) ## See also -- [Datatable component](datatable.component.md) -- [Data column component](core/data-column.component.md) -- [Pagination component](pagination.component.md) -- [Infinite pagination component](infinite-pagination.component.md) +- [Datatable component](../datatable.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) -- [Metadata indicators](metadata-indicators.md) +- [Metadata indicators](../metadata-indicators.md) - [Document library model](document-library.model.md) -- [Nodes api service](nodes-api.service.md) +- [Nodes api service](../core/nodes-api.service.md) - [Breadcrumb component](breadcrumb.component.md) - [Content action component](content-action.component.md) - [Content node selector component](content-node-selector.component.md) @@ -816,4 +816,4 @@ This will give the following output: - [Dropdown breadcrumb component](dropdown-breadcrumb.component.md) - [Permissions style model](permissions-style.model.md) - [Version manager component](version-manager.component.md) -- [Viewer component](viewer.component.md) +- [Viewer component](../core/viewer.component.md) diff --git a/docs/document-list.service.md b/docs/content-services/document-list.service.md similarity index 100% rename from docs/document-list.service.md rename to docs/content-services/document-list.service.md diff --git a/docs/dropdown-breadcrumb.component.md b/docs/content-services/dropdown-breadcrumb.component.md similarity index 94% rename from docs/dropdown-breadcrumb.component.md rename to docs/content-services/dropdown-breadcrumb.component.md index 191dbd0004..ea912e58ae 100644 --- a/docs/dropdown-breadcrumb.component.md +++ b/docs/content-services/dropdown-breadcrumb.component.md @@ -6,7 +6,7 @@ Status: Active Indicates the current position within a navigation hierarchy using a dropdown menu. -![Dropdown Breadcrumb screenshot](docassets/images/DropdownBreadcrumb.png) +![Dropdown Breadcrumb screenshot](../docassets/images/DropdownBreadcrumb.png) ## Basic Usage diff --git a/docs/file-uploading-dialog.component.md b/docs/content-services/file-uploading-dialog.component.md similarity index 100% rename from docs/file-uploading-dialog.component.md rename to docs/content-services/file-uploading-dialog.component.md diff --git a/docs/folder-actions.service.md b/docs/content-services/folder-actions.service.md similarity index 100% rename from docs/folder-actions.service.md rename to docs/content-services/folder-actions.service.md diff --git a/docs/folder-create.directive.md b/docs/content-services/folder-create.directive.md similarity index 100% rename from docs/folder-create.directive.md rename to docs/content-services/folder-create.directive.md diff --git a/docs/folder-edit.directive.md b/docs/content-services/folder-edit.directive.md similarity index 100% rename from docs/folder-edit.directive.md rename to docs/content-services/folder-edit.directive.md diff --git a/docs/like.component.md b/docs/content-services/like.component.md similarity index 92% rename from docs/like.component.md rename to docs/content-services/like.component.md index 9dcb6132b7..ce8f1c7db7 100644 --- a/docs/like.component.md +++ b/docs/content-services/like.component.md @@ -6,7 +6,7 @@ Status: Active Allows a user to add "likes" to an item. -![Custom columns](docassets/images/social1.png) +![Custom columns](../docassets/images/social1.png) ## Basic Usage diff --git a/docs/node-download.directive.md b/docs/content-services/node-download.directive.md similarity index 100% rename from docs/node-download.directive.md rename to docs/content-services/node-download.directive.md diff --git a/docs/permissions-style.model.md b/docs/content-services/permissions-style.model.md similarity index 94% rename from docs/permissions-style.model.md rename to docs/content-services/permissions-style.model.md index 800006e7cb..3c1551c167 100644 --- a/docs/permissions-style.model.md +++ b/docs/content-services/permissions-style.model.md @@ -4,7 +4,7 @@ Status: Active --- # Permission Style model -Sets custom CSS styles for rows of a [Document List](document-list.component.md) according to the item's permissions. +Sets custom CSS styles for rows of a Document List according to the item's permissions. ## Properties diff --git a/docs/rating.component.md b/docs/content-services/rating.component.md similarity index 90% rename from docs/rating.component.md rename to docs/content-services/rating.component.md index 97d66be79e..a108db9785 100644 --- a/docs/rating.component.md +++ b/docs/content-services/rating.component.md @@ -6,7 +6,7 @@ Status: Active Allows a user to add ratings to an item. -![Rating component screenshot](docassets/images/social2.png) +![Rating component screenshot](../docassets/images/social2.png) ## Basic Usage diff --git a/docs/rating.service.md b/docs/content-services/rating.service.md similarity index 100% rename from docs/rating.service.md rename to docs/content-services/rating.service.md diff --git a/docs/search-control.component.md b/docs/content-services/search-control.component.md similarity index 97% rename from docs/search-control.component.md rename to docs/content-services/search-control.component.md index e020df065c..728ad02f5f 100644 --- a/docs/search-control.component.md +++ b/docs/content-services/search-control.component.md @@ -7,7 +7,7 @@ Last reviewed: 2018-03-13 Displays a input text which shows find-as-you-type suggestions. -![adf-search-control](docassets/images/search-control-component.png) +![adf-search-control](../docassets/images/search-control-component.png) ## Basic usage diff --git a/docs/search.component.md b/docs/content-services/search.component.md similarity index 88% rename from docs/search.component.md rename to docs/content-services/search.component.md index d3fbe1f583..2ee28cf71d 100644 --- a/docs/search.component.md +++ b/docs/content-services/search.component.md @@ -53,7 +53,7 @@ You have to add a template that will be shown when the results are loaded. The results are provided via the [$implicit variable of angular2](https://angular.io/api/common/NgTemplateOutlet) and can be accessed via the sugar sintax 'let-yourChosenName'. As per example above the result will be something like : -![adf-search-control](docassets/images/search-component-simple-template.png) +![adf-search-control](../docassets/images/search-component-simple-template.png) But you can define even a more complex template : @@ -99,7 +99,7 @@ But you can define even a more complex template : Which will look like : -![adf-search-control](docassets/images/search-component-complex-template.png) +![adf-search-control](../docassets/images/search-component-complex-template.png) ### Attach an input field to the search @@ -125,12 +125,12 @@ In this way it is possible to fetch the results from the word typed into the inp 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 -[Search Configuration interface](search-configuration.interface.md) (the `queryBody` parameter of the `Search component` is now deprecated). The ADF source provides a standard implementation of this +[Search Configuration interface](../core/search-configuration.interface.md) (the `queryBody` parameter of the `Search component` is now deprecated). The ADF source provides a standard implementation of this interface, `SearchConfigurationService` that you can use as a base to adapt to your needs. See the -[Search Configuration interface](search-configuration.interface.md) page for full details of how to +[Search Configuration interface](../core/search-configuration.interface.md) page for full details of how to customize your search. ## See Also -- [Search configuration interface](search-configuration.interface.md) -- [Search configuration service](search-configuration.service.md) +- [Search configuration interface](../core/search-configuration.interface.md) +- [Search configuration service](../core/search-configuration.service.md) diff --git a/docs/sites-dropdown.component.md b/docs/content-services/sites-dropdown.component.md similarity index 87% rename from docs/sites-dropdown.component.md rename to docs/content-services/sites-dropdown.component.md index 3753dfce22..a925c60093 100644 --- a/docs/sites-dropdown.component.md +++ b/docs/content-services/sites-dropdown.component.md @@ -8,7 +8,7 @@ Last reviewed: 2018-03-13 Displays a dropdown menu to show and interact with the sites of the current user. -![Dropdown sites](docassets/images/document-list-dropdown-list.png) +![Dropdown sites](../docassets/images/document-list-dropdown-list.png) ## Basic Usage @@ -32,4 +32,4 @@ Displays a dropdown menu to show and interact with the sites of the current user | Name | Returned Type | Description | | ---- | ------------- | ----------- | -| change | [SiteModel](site.model.md) | Emitted when user selects a site. When default option is selected an empty model is emitted | +| change | [SiteModel](../site.model.md) | Emitted when user selects a site. When default option is selected an empty model is emitted | diff --git a/docs/tag-actions.component.md b/docs/content-services/tag-actions.component.md similarity index 93% rename from docs/tag-actions.component.md rename to docs/content-services/tag-actions.component.md index 5535d70b88..b299e3f1de 100644 --- a/docs/tag-actions.component.md +++ b/docs/content-services/tag-actions.component.md @@ -6,7 +6,7 @@ Status: Active Shows available actions for tags. -![Custom columns](docassets/images/tag3.png) +![Custom columns](../docassets/images/tag3.png) ## Basic Usage diff --git a/docs/tag-list.component.md b/docs/content-services/tag-list.component.md similarity index 85% rename from docs/tag-list.component.md rename to docs/content-services/tag-list.component.md index 283b94b312..75c07095a9 100644 --- a/docs/tag-list.component.md +++ b/docs/content-services/tag-list.component.md @@ -6,7 +6,7 @@ Status: Active Shows tags for an item. -![Custom columns](docassets/images/tag2.png) +![Custom columns](../docassets/images/tag2.png) ## Basic Usage diff --git a/docs/tag-node-list.component.md b/docs/content-services/tag-node-list.component.md similarity index 90% rename from docs/tag-node-list.component.md rename to docs/content-services/tag-node-list.component.md index ad4df66596..b86cba573c 100644 --- a/docs/tag-node-list.component.md +++ b/docs/content-services/tag-node-list.component.md @@ -6,7 +6,7 @@ Status: Active Shows tags for a node. -![Custom columns](docassets/images/tag1.png) +![Custom columns](../docassets/images/tag1.png) ## Basic Usage diff --git a/docs/tag.service.md b/docs/content-services/tag.service.md similarity index 100% rename from docs/tag.service.md rename to docs/content-services/tag.service.md diff --git a/docs/upload-button.component.md b/docs/content-services/upload-button.component.md similarity index 94% rename from docs/upload-button.component.md rename to docs/content-services/upload-button.component.md index 2854c4fc1b..5e29126daa 100644 --- a/docs/upload-button.component.md +++ b/docs/content-services/upload-button.component.md @@ -2,12 +2,12 @@ Added: v2.0.0 Status: Active --- -# Upload Button Components - -## Upload Button Component +# Upload Button Component Activates a file upload. +## Basic usage + ```html ` | Emitted when a folder is created. | | permissionEvent | `EventEmitter` | Emitted when delete permission is missing. | -## Upload Version Button Component (Workaround) - -Activates a file version upload. -Until further backend API improvements, this component is meant to be used to enrich the feature of node version uploading and to decrease the restrictions currently applied to the node version upload. - -```html - - -``` - -### Properties - -Since UploadVersionButtonComponent extends UploadButtonComponent, the properties are the same. Note that some properties doesn't make sense in case of version upload button, thus are just simply ignored. For the version upload button the **node** (which is about to be versioned) is a mandatory input parameter. - -### Events - -Since UploadVersionButtonComponent extends UploadButtonComponent the properties are the same. - -### Restrictions -At the moment the API only allows new version uploads for a node, if the name of the new version is exactly the same as the old version (**and most importantly the extension**). Because of it, this workaround component uploads the chosen file with the same name as what the original file had (that is the reason, the **node** is a mandatory dependency for this component). - -So at the end what this component can and can not do: - -**Can**: -- upload a new version from the same file extension regardless of the file name. - -**Can not**: -- upload a new version which has a different file extension, than what the originally uploaded file had. (an error message is emitted on the error EventEmitter of the component). - ## Details ### How to show notification message with no permission @@ -105,4 +70,37 @@ export class MyComponent { } ``` -![Upload notification message](docassets/images/upload-notification-message.png) +![Upload notification message](../docassets/images/upload-notification-message.png) + +### Upload Version Button Component (Workaround) + +Activates a file version upload. +Until further backend API improvements, this component is meant to be used to enrich the feature of node version uploading and to decrease the restrictions currently applied to the node version upload. + +```html + + +``` + +### Properties and events + +Since UploadVersionButtonComponent extends UploadButtonComponent, the properties are the same. Note that some properties doesn't make sense in case of version upload button, thus are just simply ignored. For the version upload button the **node** (which is about to be versioned) is a mandatory input parameter. + +Since UploadVersionButtonComponent extends UploadButtonComponent the events are the same. + +### Restrictions +At the moment the API only allows new version uploads for a node, if the name of the new version is exactly the same as the old version (**and most importantly the extension**). Because of it, this workaround component uploads the chosen file with the same name as what the original file had (that is the reason, the **node** is a mandatory dependency for this component). + +So at the end what this component can and can not do: + +**Can**: +- upload a new version from the same file extension regardless of the file name. + +**Can not**: +- upload a new version which has a different file extension, than what the originally uploaded file had. (an error message is emitted on the error EventEmitter of the component). diff --git a/docs/upload-drag-area.component.md b/docs/content-services/upload-drag-area.component.md similarity index 100% rename from docs/upload-drag-area.component.md rename to docs/content-services/upload-drag-area.component.md diff --git a/docs/version-list.component.md b/docs/content-services/version-list.component.md similarity index 85% rename from docs/version-list.component.md rename to docs/content-services/version-list.component.md index f9ebf1120d..d540ef5ffe 100644 --- a/docs/version-list.component.md +++ b/docs/content-services/version-list.component.md @@ -4,7 +4,7 @@ Status: Experimental --- # Version List component -Displays the version history of a node in a [Version Manager component](version-manager.component.md) +Displays the version history of a node in a Version Manager component ### Basic Usage diff --git a/docs/version-manager.component.md b/docs/content-services/version-manager.component.md similarity index 95% rename from docs/version-manager.component.md rename to docs/content-services/version-manager.component.md index 7bef06ab9d..67b8a8ae26 100644 --- a/docs/version-manager.component.md +++ b/docs/content-services/version-manager.component.md @@ -8,7 +8,7 @@ Displays the version history of a node with the ability to upload a new version. ![\#f03c15](https://placehold.it/15/f03c15/000000?text=+) `This component is still in experimental phase, it has several limitations which will be resolved soon.` -![Version Manager](docassets/images/version-manager.png) +![Version Manager](../docassets/images/version-manager.png) ## Basic Usage diff --git a/docs/webscript.component.md b/docs/content-services/webscript.component.md similarity index 97% rename from docs/webscript.component.md rename to docs/content-services/webscript.component.md index 9d12f3c2ba..e2e91636d7 100644 --- a/docs/webscript.component.md +++ b/docs/content-services/webscript.component.md @@ -80,7 +80,7 @@ This sample Web Scripts reside in your Alfresco Server. You can access the folde ``` -![Custom columns](docassets/images/HTML.png) +![Custom columns](../docassets/images/HTML.png) ### Webscript View DATATABLE example @@ -137,7 +137,7 @@ data: [ that will render the following table -![Custom columns](docassets/images/datatable.png) +![Custom columns](../docassets/images/datatable.png) ### Webscript View JSON example diff --git a/docs/core/data-column.component.md b/docs/core/data-column.component.md index 917e46417a..21081f3996 100644 --- a/docs/core/data-column.component.md +++ b/docs/core/data-column.component.md @@ -156,7 +156,7 @@ In the Example below we will prepend `Hi!` to each file and folder name in the l ``` -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](../content-services/tag-node-list.component.md) component with the document list. ```html @@ -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) +- [Document list component](../content-services/document-list.component.md) - [Datatable component](../datatable.component.md) - [Task list component](../task-list.component.md) diff --git a/docs/core/deleted-nodes-api.service.md b/docs/core/deleted-nodes-api.service.md index 650c6c639a..7d797525f6 100644 --- a/docs/core/deleted-nodes-api.service.md +++ b/docs/core/deleted-nodes-api.service.md @@ -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](../content-services/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) diff --git a/docs/file-draggable.directive.md b/docs/core/file-draggable.directive.md similarity index 96% rename from docs/file-draggable.directive.md rename to docs/core/file-draggable.directive.md index 2ef531c2ae..41cf463cf2 100644 --- a/docs/file-draggable.directive.md +++ b/docs/core/file-draggable.directive.md @@ -77,4 +77,4 @@ export class SomeComponent implements OnInit { ## See also -- [Upload Drag Area component](upload-drag-area.component.md) +- [Upload Drag Area component](../content-services/upload-drag-area.component.md) diff --git a/docs/node.service.md b/docs/core/node.service.md similarity index 98% rename from docs/node.service.md rename to docs/core/node.service.md index 0541c8e679..4741fa56d1 100644 --- a/docs/node.service.md +++ b/docs/core/node.service.md @@ -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](core/deleted-nodes-api.service.md) +- [Deleted nodes api service](deleted-nodes-api.service.md) diff --git a/docs/nodes-api.service.md b/docs/core/nodes-api.service.md similarity index 90% rename from docs/nodes-api.service.md rename to docs/core/nodes-api.service.md index 4d5e9581c4..e4e61a08f9 100644 --- a/docs/nodes-api.service.md +++ b/docs/core/nodes-api.service.md @@ -57,7 +57,7 @@ The Nodes Api Service has methods for getting information about nodes and managing them within the repository (creating, deleting, etc). Other lower level interfaces to the ACS nodes API are also available - see the -[Alfresco Api service](alfresco-api.service.md), the +[Alfresco Api service](../alfresco-api.service.md), the [Alfresco JS API docs](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api) and the [REST API Explorer](https://api-explorer.alfresco.com/api-explorer/#/nodes) @@ -93,8 +93,8 @@ modification dates, etc. Also, the `id` and `parentId` properties contain the no ID strings for the current node and its enclosing folder. Sometimes, a MinimalNode is provided directly, for example, the `folderNode` property -of a [Document List component](document-list.component.md) or the data context of a -[Document List row](document-list.component.md#underlying-node-object). In these cases, +of a [Document List component](../content-services/document-list.component.md) or the data context of a +[Document List row](../content-services/document-list.component.md#underlying-node-object). In these cases, you might pass the `id` or `parentId` as a [route parameter](https://angular.io/guide/router) to a page describing the node in full detail. The component receiving the node ID can use the Nodes Api service to "decode" the ID string into a MinimalNodeEntryEntity: @@ -135,8 +135,8 @@ page in the Alfresco JS API docs for more information. ### Getting folder node contents The `getNodeChildren` method returns the contents of a folder -as a list of items. See the [Paging section](document-library.model.md#paging) -of [Document Library model](document-library.model.md) for +as a list of items. See the [Paging section](../content-services/document-library.model.md#paging) +of [Document Library model](../content-services/document-library.model.md) for more information about the structure of the list. Also, the [getNodeChildren](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodesApi.md#getNodeChildren) page in the Alfresco JS API gives more information about the structure of the @@ -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](core/deleted-nodes-api.service.md) get a list of all items currently in the trashcan. +[Deleted Nodes Api service](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](core/deleted-nodes-api.service.md) -- [Document list component](document-list.component.md) +- [Document library model](../content-services/document-library.model.md) +- [Deleted nodes api service](deleted-nodes-api.service.md) +- [Document list component](../content-services/document-list.component.md) - [Node service](node.service.md) diff --git a/docs/renditions.service.md b/docs/core/renditions.service.md similarity index 94% rename from docs/renditions.service.md rename to docs/core/renditions.service.md index 4e125df120..ca3f0970b6 100644 --- a/docs/renditions.service.md +++ b/docs/core/renditions.service.md @@ -37,7 +37,7 @@ repeated use. More information about renditions is available in the In the Renditions service methods, the `nodeId` is a string identifying the content node that the rendition applies to. This can be obtained from -[Document List component](document-list.component.md) events and various other places +[Document List component](../content-services/document-list.component.md) events and various other places in the ADF API. The `encoding` identifies the conversion performed by the rendition. See the diff --git a/docs/search-configuration.interface.md b/docs/core/search-configuration.interface.md similarity index 98% rename from docs/search-configuration.interface.md rename to docs/core/search-configuration.interface.md index 4134f80a9c..3c48543c5a 100644 --- a/docs/search-configuration.interface.md +++ b/docs/core/search-configuration.interface.md @@ -88,5 +88,5 @@ described below. ## See also -- [Search component](search.component.md) +- [Search component](../content-services/search.component.md) - [Search configuration service](search-configuration.service.md) diff --git a/docs/search-configuration.service.md b/docs/core/search-configuration.service.md similarity index 94% rename from docs/search-configuration.service.md rename to docs/core/search-configuration.service.md index 484a1290cf..a124c98748 100644 --- a/docs/search-configuration.service.md +++ b/docs/core/search-configuration.service.md @@ -26,5 +26,5 @@ example code. ## See also -- [Search component](search.component.md) +- [Search component](../content-services/search.component.md) - [Search configuration interface](search-configuration.interface.md) diff --git a/docs/viewer.component.md b/docs/core/viewer.component.md similarity index 96% rename from docs/viewer.component.md rename to docs/core/viewer.component.md index edd5c25676..08e71740ec 100644 --- a/docs/viewer.component.md +++ b/docs/core/viewer.component.md @@ -114,7 +114,7 @@ Using with file url: ### Integrating with the Document List component Below is the most simple integration of the Viewer and -[Document List](document-list.component.md) components within your custom component: +[Document List](../content-services/document-list.component.md) components within your custom component: ```html ``` -![Open with](docassets/images/viewer-open-with.png) +![Open with](../docassets/images/viewer-open-with.png) ### Custom "More actions" menu @@ -403,7 +403,7 @@ You can enable a custom "More actions" menu by providing at least one action ins ``` -![More actions](docassets/images/viewer-more-actions.png) +![More actions](../docassets/images/viewer-more-actions.png) ### Extending the Viewer @@ -453,4 +453,4 @@ You can define multiple `adf-viewer-extension` templates if required: ## See also -- [Document List component](document-list.component.md) \ No newline at end of file +- [Document List component](../content-services/document-list.component.md) \ No newline at end of file diff --git a/docs/datatable.component.md b/docs/datatable.component.md index 002925a79b..bf68f2b4a7 100644 --- a/docs/datatable.component.md +++ b/docs/datatable.component.md @@ -483,5 +483,5 @@ and do corresponding actions. - [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) +- [Document list component](content-services/document-list.component.md) diff --git a/docs/infinite-pagination.component.md b/docs/infinite-pagination.component.md index 76dc484d28..10d6658346 100644 --- a/docs/infinite-pagination.component.md +++ b/docs/infinite-pagination.component.md @@ -61,5 +61,5 @@ See the [Pagination component](pagination.component.md) for more information abo ## See also -- [Document list component](document-list.component.md) +- [Document list component](content-services/document-list.component.md) - [Pagination component](pagination.component.md) diff --git a/docs/start-process.component.md b/docs/start-process.component.md index 072e515ac9..3b83403f7a 100644 --- a/docs/start-process.component.md +++ b/docs/start-process.component.md @@ -116,7 +116,7 @@ const formValues: FormValues = { ``` Note that in the object above, the key `file` is the name of the attach file field in the start form of the process. The value of the `file` property must be a -[MinimalNodeEntryEntity](document-library.model.md): +[MinimalNodeEntryEntity](content-services/document-library.model.md): ```html