From e33cb063711f682f8025c92aee6ddb62264a25f2 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 15 Mar 2018 15:41:09 +0000 Subject: [PATCH] [ADF-2463] Moved doc files to subfolders (#3081) --- docs/README.md | 58 ++++++++--------- .../document-library.model.md | 2 +- .../document-list.component.md | 10 +-- .../sites-dropdown.component.md | 2 +- docs/{ => core}/activiti-alfresco.service.md | 0 docs/{ => core}/alfresco-api.service.md | 0 docs/{ => core}/alfresco-content.service.md | 2 +- docs/{ => core}/authentication.service.md | 0 docs/{ => core}/boilerplate.component.md | 2 +- docs/{ => core}/boilerplate.service.md | 0 docs/{ => core}/content.widget.md | 0 docs/core/data-column.component.md | 10 +-- .../{ => core}/datatable-adapter.interface.md | 8 +-- docs/{ => core}/datatable.component.md | 16 ++--- docs/{ => core}/favorites-api.service.md | 0 docs/core/form-field.model.md | 2 +- docs/{ => core}/host-settings.component.md | 2 +- .../infinite-pagination.component.md | 4 +- docs/{ => core}/login.component.md | 10 +-- docs/{ => core}/logout.directive.md | 0 docs/core/nodes-api.service.md | 2 +- docs/{ => core}/pagination.component.md | 2 +- docs/{ => core}/search-api.service.md | 0 docs/{ => core}/site.model.md | 4 +- docs/core/sites.service.md | 4 +- docs/core/start-form.component.md | 2 +- docs/{ => core}/translation.service.md | 2 +- docs/{ => core}/upload.service.md | 0 docs/{ => core}/user-info.component.md | 0 docs/internationalization.md | 6 +- .../apps-process.service.md | 0 docs/{ => process-services}/filter.model.md | 2 +- docs/{ => process-services}/log.service.md | 0 .../process-services/people-list.component.md | 2 +- .../process-filters.component.md | 2 +- .../process-list.component.md | 4 +- .../select-apps-dialog.component.md | 2 +- .../start-process.component.md | 6 +- .../start-task.component.md | 2 +- .../task-attachment-list.component.md | 10 +-- .../task-audit.directive.md | 2 +- .../task-details.component.md | 0 .../task-details.model.md | 0 .../task-filter.service.md | 0 .../task-filters.component.md | 2 +- .../task-header.component.md | 2 +- .../task-list.component.md | 12 ++-- .../tasklist.service.md | 0 docs/versionIndex.md | 64 +++++++++---------- 49 files changed, 131 insertions(+), 131 deletions(-) rename docs/{ => core}/activiti-alfresco.service.md (100%) rename docs/{ => core}/alfresco-api.service.md (100%) rename docs/{ => core}/alfresco-content.service.md (95%) rename docs/{ => core}/authentication.service.md (100%) rename docs/{ => core}/boilerplate.component.md (96%) rename docs/{ => core}/boilerplate.service.md (100%) rename docs/{ => core}/content.widget.md (100%) rename docs/{ => core}/datatable-adapter.interface.md (94%) rename docs/{ => core}/datatable.component.md (96%) rename docs/{ => core}/favorites-api.service.md (100%) rename docs/{ => core}/host-settings.component.md (92%) rename docs/{ => core}/infinite-pagination.component.md (93%) rename docs/{ => core}/login.component.md (95%) rename docs/{ => core}/logout.directive.md (100%) rename docs/{ => core}/pagination.component.md (98%) rename docs/{ => core}/search-api.service.md (100%) rename docs/{ => core}/site.model.md (94%) rename docs/{ => core}/translation.service.md (98%) rename docs/{ => core}/upload.service.md (100%) rename docs/{ => core}/user-info.component.md (100%) rename docs/{ => process-services}/apps-process.service.md (100%) rename docs/{ => process-services}/filter.model.md (95%) rename docs/{ => process-services}/log.service.md (100%) rename docs/{ => process-services}/select-apps-dialog.component.md (90%) rename docs/{ => process-services}/start-process.component.md (95%) rename docs/{ => process-services}/start-task.component.md (92%) rename docs/{ => process-services}/task-attachment-list.component.md (86%) rename docs/{ => process-services}/task-audit.directive.md (93%) rename docs/{ => process-services}/task-details.component.md (100%) rename docs/{ => process-services}/task-details.model.md (100%) rename docs/{ => process-services}/task-filter.service.md (100%) rename docs/{ => process-services}/task-filters.component.md (96%) rename docs/{ => process-services}/task-header.component.md (96%) rename docs/{ => process-services}/task-list.component.md (92%) rename docs/{ => process-services}/tasklist.service.md (100%) diff --git a/docs/README.md b/docs/README.md index 2186c9b4aa..297817ab5d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -56,7 +56,7 @@ for more information about installing and using the source code. | [Accordion group component](core/accordion-group.component.md) | Adds a collapsible panel to an accordion menu. | [Source](../lib/core/collapsable/accordion-group.component.ts) | | [Accordion component](core/accordion.component.md) | Creates a collapsible accordion menu. | [Source](../lib/core/collapsable/accordion.component.ts) | | [Data column component](core/data-column.component.md) | Defines column properties for DataTable, Tasklist, Document List and other components. | [Source](../lib/core/data-column/data-column.component.ts) | -| [Datatable component](datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | +| [Datatable component](core/datatable.component.md) | Displays data as a table with customizable columns and presentation. | [Source](../lib/core/datatable/components/datatable/datatable.component.ts) | | [Form field component](core/form-field.component.md) | A form field in an APS form. | [Source](../lib/core/form/components/form-field/form-field.component.ts) | | [Form list component](core/form-list.component.md) | Shows APS forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | | [Form component](core/form.component.md) | Shows a Form from APS (see it live: [Form Quickstart](https://embed.plnkr.co/YSLXTqb3DtMhVJSqXKkE/)) | [Source](../lib/core/form/components/form.component.ts) | @@ -65,15 +65,15 @@ for more information about installing and using the source code. | [Info drawer layout component](core/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info drawer component](core/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | | [Language menu component](core/language-menu.component.md) | Displays all the languages that are present in the "app.config.json" or the default one (EN). | [Source](../lib/core/language-menu/language-menu.component.ts) | -| [Login component](login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | -| [Infinite pagination component](infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | -| [Pagination component](pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | -| [Host settings component](host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | +| [Login component](core/login.component.md) | Authenticates to Alfresco Content Services and Alfresco Process Services. | [Source](../lib/core/login/components/login.component.ts) | +| [Infinite pagination component](core/infinite-pagination.component.md) | Adds "infinite" pagination to the component it is used with. | [Source](../lib/core/pagination/infinite-pagination.component.ts) | +| [Pagination component](core/pagination.component.md) | Adds pagination to the component it is used with. | [Source](../lib/core/pagination/pagination.component.ts) | +| [Host settings component](core/host-settings.component.md) | Validates the URLs for ACS and APS and saves them in the user's local storage | [Source](../lib/core/settings/host-settings.component.ts) | | [Sidebar action menu component](core/sidebar-action-menu.component.md) | Displays a sidebar-action menu information panel. | [Source](../lib/core/sidebar/sidebar-action-menu.component.ts) | | [Toolbar divider component](core/toolbar-divider.component.md) | Divides groups of elements in a Toolbar with a visual separator. | [Source](../lib/core/toolbar/toolbar-divider.component.ts) | | [Toolbar title component](core/toolbar-title.component.md) | Supplies custom HTML to be included in a Toolbar component title. | [Source](../lib/core/toolbar/toolbar-title.component.ts) | | [Toolbar component](core/toolbar.component.md) | Simple container for headers, titles, actions and breadcrumbs. | [Source](../lib/core/toolbar/toolbar.component.ts) | -| [User info component](user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | +| [User info component](core/user-info.component.md) | Shows user information. | [Source](../lib/core/userinfo/components/user-info.component.ts) | | [Viewer component](core/viewer.component.md) | Displays content from an ACS repository. | [Source](../lib/core/viewer/components/viewer.component.ts) | ## Directives @@ -82,7 +82,7 @@ for more information about installing and using the source code. | ---- | ----------- | ----------- | | [Context menu directive](core/context-menu.directive.md) | Adds a context menu to a component. | [Source](../lib/core/context-menu/context-menu.directive.ts) | | [Highlight directive](core/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | -| [Logout directive](logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | +| [Logout directive](core/logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | | [Node delete directive](core/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) | | [Node favorite directive](core/node-favorite.directive.md) | Selectively toggles nodes as favorite | [Source](../lib/core/directives/node-favorite.directive.ts) | | [Node permission directive](core/node-permission.directive.md) | Selectively disables an HTML element or Angular component | [Source](../lib/core/directives/node-permission.directive.ts) | @@ -116,25 +116,25 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Card view update service](core/card-view-update.service.md) | Reports edits and clicks within fields of a Card View component. | [Source](../lib/core/card-view/services/card-view-update.service.ts) | -| [Activiti alfresco service](activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | +| [Activiti alfresco service](core/activiti-alfresco.service.md) | Gets Alfresco Repository folder content based on a Repository account configured in Alfresco Process Services (APS). | [Source](../lib/core/form/services/activiti-alfresco.service.ts) | | [Form rendering service](core/form-rendering.service.md) | Maps an APS form field type string onto the corresponding form widget component type. | [Source](../lib/core/form/services/form-rendering.service.ts) | | [Form service](core/form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.service.ts) | | [Node service](core/node.service.md) | Gets Alfresco Repository node metadata and creates nodes with metadata. | [Source](../lib/core/form/services/node.service.ts) | | [Process content service](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) | +| [Alfresco api service](core/alfresco-api.service.md) | Provides access to initialized **AlfrescoJSApi** instance. | [Source](../lib/core/services/alfresco-api.service.ts) | +| [Apps process service](process-services/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 to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | +| [Authentication service](core/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) | | [Deleted nodes api service](core/deleted-nodes-api.service.md) | Gets a list of Content Services nodes currently in the trash. | [Source](../lib/core/services/deleted-nodes-api.service.ts) | | [Discovery api service](core/discovery-api.service.md) | Gets version and license information for Process Services and Content Services. | [Source](../lib/core/services/discovery-api.service.ts) | -| [Favorites api service](favorites-api.service.md) | Gets a list of items a user has marked as their favorites. | [Source](../lib/core/services/favorites-api.service.ts) | +| [Favorites api service](core/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) | +| [Log service](process-services/log.service.md) | Provide a log functionality for your ADF application. | [Source](../lib/core/services/log.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) | @@ -146,8 +146,8 @@ for more information about installing and using the source code. | [Sites service](core/sites.service.md) | Accesses and manipulates sites from a Content Services repository. | [Source](../lib/core/services/sites.service.ts) | | [Storage service](core/storage.service.md) | Stores items in the form of key-value pairs. | [Source](../lib/core/services/storage.service.ts) | | [Thumbnail service](core/thumbnail.service.md) | Retrieves an SVG thumbnail image to represent a document type. | [Source](../lib/core/services/thumbnail.service.ts) | -| [Translation service](translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | -| [Upload service](upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | +| [Translation service](core/translation.service.md) | Supports localisation. | [Source](../lib/core/services/translation.service.ts) | +| [Upload service](core/upload.service.md) | Provides access to various APIs related to file upload features. | [Source](../lib/core/services/upload.service.ts) | | [User preferences service](core/user-preferences.service.md) | Stores preferences for components. | [Source](../lib/core/services/user-preferences.service.ts) | | [Bpm user service](core/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) | | [Ecm user service](core/ecm-user.service.md) | Gets information about a Content Services user. | [Source](../lib/core/userinfo/services/ecm-user.service.ts) | @@ -156,7 +156,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Content widget](content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) | +| [Content widget](core/content.widget.md) | Shows the content preview. | [Source](../lib/core/form/components/widgets/content/content.widget.ts) | @@ -164,7 +164,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [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) | +| [Data Table Adapter interface](core/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](core/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | @@ -254,7 +254,7 @@ for more information about installing and using the source code. | [Create process attachment component](process-services/create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../lib/process-services/attachment/create-process-attachment.component.ts) | | [Create task attachment component](process-services/create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../lib/process-services/attachment/create-task-attachment.component.ts) | | [Process attachment list component](process-services/process-attachment-list.component.md) | Displays attached documents on a specified process instance | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) | -| [Task attachment list component](task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) | +| [Task attachment list component](process-services/task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../lib/process-services/attachment/task-attachment-list.component.ts) | | [Comment list component](process-services/comment-list.component.md) | Shows a list of comments. | [Source](../lib/process-services/comments/comment-list.component.ts) | | [Comments component](process-services/comments.component.md) | Displays comments from users involved in a specified task and allows an involved user to add a comment to the task. | [Source](../lib/process-services/comments/comments.component.ts) | | [Process comments component](process-services/process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../lib/process-services/comments/process-comments.component.ts) | @@ -266,27 +266,27 @@ for more information about installing and using the source code. | [Process instance header component](process-services/process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../lib/process-services/process-list/components/process-instance-header.component.ts) | | [Process instance tasks component](process-services/process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../lib/process-services/process-list/components/process-instance-tasks.component.ts) | | [Process list component](process-services/process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services/process-list/components/process-list.component.ts) | -| [Start process component](start-process.component.md) | Starts a process. | [Source](../lib/process-services/process-list/components/start-process.component.ts) | +| [Start process component](process-services/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 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) | +| [Start task component](process-services/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](process-services/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](process-services/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) | +| [Task header component](process-services/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](process-services/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) | ## Directives | Name | Description | Source link | | ---- | ----------- | ----------- | | [Process audit directive](process-services/process-audit.directive.md) | Fetches the Process Audit information in the pdf or json format. | [Source](../lib/process-services/process-list/components/process-audit.directive.ts) | -| [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in the pdf or json format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) | +| [Task audit directive](process-services/task-audit.directive.md) | Fetches the Task Audit information in the pdf or json format. | [Source](../lib/process-services/task-list/components/task-audit.directive.ts) | ## Models | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) | -| [Task details model](task-details.model.md) | Information about a task. | [Source](../lib/process-services/task-list/models/task-details.model.ts) | +| [Filter model](process-services/filter.model.md) | Contains classes related to filters in Process Services. | [Source](../lib/process-services/task-list/models/filter.model.ts) | +| [Task details model](process-services/task-details.model.md) | Information about a task. | [Source](../lib/process-services/task-list/models/task-details.model.ts) | ## Services @@ -294,8 +294,8 @@ for more information about installing and using the source code. | ---- | ----------- | ----------- | | [Process filter service](process-services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) | | [Process service](process-services/process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) | -| [Task filter service](task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) | -| [Tasklist service](tasklist.service.md) | Manage Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) | +| [Task filter service](process-services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) | +| [Tasklist service](process-services/tasklist.service.md) | Manage Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) | diff --git a/docs/content-services/document-library.model.md b/docs/content-services/document-library.model.md index a2b508049d..44b86efad3 100644 --- a/docs/content-services/document-library.model.md +++ b/docs/content-services/document-library.model.md @@ -9,7 +9,7 @@ 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](../core/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 diff --git a/docs/content-services/document-list.component.md b/docs/content-services/document-list.component.md index d852519167..044116e795 100644 --- a/docs/content-services/document-list.component.md +++ b/docs/content-services/document-list.component.md @@ -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](../core/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. @@ -521,7 +521,7 @@ A custom set of columns might look like the following: ![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](../core/datatable.component.md), [Task List](../process-services/task-list.component.md) and other components: ```html @@ -801,10 +801,10 @@ This will give the following output: ## See also -- [Datatable component](../datatable.component.md) +- [Datatable component](../core/datatable.component.md) - [Data column component](../core/data-column.component.md) -- [Pagination component](../pagination.component.md) -- [Infinite pagination component](../infinite-pagination.component.md) +- [Pagination component](../core/pagination.component.md) +- [Infinite pagination component](../core/infinite-pagination.component.md) - [Sites dropdown component](sites-dropdown.component.md) - [Metadata indicators](../metadata-indicators.md) - [Document library model](document-library.model.md) diff --git a/docs/content-services/sites-dropdown.component.md b/docs/content-services/sites-dropdown.component.md index a925c60093..9e3ef889d4 100644 --- a/docs/content-services/sites-dropdown.component.md +++ b/docs/content-services/sites-dropdown.component.md @@ -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](../core/site.model.md) | Emitted when user selects a site. When default option is selected an empty model is emitted | diff --git a/docs/activiti-alfresco.service.md b/docs/core/activiti-alfresco.service.md similarity index 100% rename from docs/activiti-alfresco.service.md rename to docs/core/activiti-alfresco.service.md diff --git a/docs/alfresco-api.service.md b/docs/core/alfresco-api.service.md similarity index 100% rename from docs/alfresco-api.service.md rename to docs/core/alfresco-api.service.md diff --git a/docs/alfresco-content.service.md b/docs/core/alfresco-content.service.md similarity index 95% rename from docs/alfresco-content.service.md rename to docs/core/alfresco-content.service.md index 7a314585c2..82bbeeb487 100644 --- a/docs/alfresco-content.service.md +++ b/docs/core/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](content-services/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/authentication.service.md b/docs/core/authentication.service.md similarity index 100% rename from docs/authentication.service.md rename to docs/core/authentication.service.md diff --git a/docs/boilerplate.component.md b/docs/core/boilerplate.component.md similarity index 96% rename from docs/boilerplate.component.md rename to docs/core/boilerplate.component.md index a6e9502aa7..2c84efee52 100644 --- a/docs/boilerplate.component.md +++ b/docs/core/boilerplate.component.md @@ -2,7 +2,7 @@ Shows how to write a Markdown file for a component. -![Screenshot goes here if necessary](docassets/images/adf-toolbar-01.png) +![Screenshot goes here if necessary](../docassets/images/adf-toolbar-01.png) diff --git a/docs/datatable-adapter.interface.md b/docs/core/datatable-adapter.interface.md similarity index 94% rename from docs/datatable-adapter.interface.md rename to docs/core/datatable-adapter.interface.md index c1907ad16a..6ac55a3079 100644 --- a/docs/datatable-adapter.interface.md +++ b/docs/core/datatable-adapter.interface.md @@ -5,7 +5,7 @@ Status: Active # DataTableAdapter interface Defines how table data is supplied to [DataTable](datatable.component.md) -and [Tasklist](task-list.component.md) components. +and [Tasklist](../process-services/task-list.component.md) components. ## Properties @@ -37,7 +37,7 @@ Sort the table with a specified key and direction (ascending or descending). ## Details You can implement DataTableAdapter in your own class to display your data with the [DataTable](datatable.component.md) -and [Tasklist](task-list.component.md) components. +and [Tasklist](../process-services/task-list.component.md) components. This interface (along with other interfaces for column and row data) hides the details of your class from the caller, so you can store your data internally however you like. The DataTable library implements the interface in the [ObjectDataTableAdapter](#objectdatatableadapter) class which is the standard adapter for the Datatable component. The basic idea of DataTableAdapter is that the caller can request your class to return an array of column @@ -113,7 +113,7 @@ let data = new ObjectDataTableAdapter( ); ``` -![DataTable demo](docassets/images/datatable-demo.png) +![DataTable demo](../docassets/images/datatable-demo.png) If you don't specify the column array then the constructor will infer the layout of the columns from the structure of the row objects. The field names ('id' and 'name' in the example below) will be used @@ -151,5 +151,5 @@ let schema = ObjectDataTableAdapter.generateSchema(data); ## See also - [Datatable component](datatable.component.md) -- [Task list component](task-list.component.md) +- [Task list component](../process-services/task-list.component.md) \ No newline at end of file diff --git a/docs/datatable.component.md b/docs/core/datatable.component.md similarity index 96% rename from docs/datatable.component.md rename to docs/core/datatable.component.md index bf68f2b4a7..49f640d05c 100644 --- a/docs/datatable.component.md +++ b/docs/core/datatable.component.md @@ -6,7 +6,7 @@ Status: Active Displays data as a table with customizable columns and presentation. -![DataTable demo](docassets/images/datatable-demo.png) +![DataTable demo](../docassets/images/datatable-demo.png) See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/) @@ -196,7 +196,7 @@ onRowClick(event) { } ``` -![](docassets/images/datatable-dom-events.png) +![](../docassets/images/datatable-dom-events.png) ### Card view @@ -209,7 +209,7 @@ If you want to enable the card view mode you need to set to 'gallery' the input diff --git a/docs/favorites-api.service.md b/docs/core/favorites-api.service.md similarity index 100% rename from docs/favorites-api.service.md rename to docs/core/favorites-api.service.md diff --git a/docs/core/form-field.model.md b/docs/core/form-field.model.md index 640e7bb693..3069a60410 100644 --- a/docs/core/form-field.model.md +++ b/docs/core/form-field.model.md @@ -64,7 +64,7 @@ example, the `currency` property holds the currency symbol to be displayed next ### Validation -A [Form](form.component.md) or [Task Details](../task-details.component.md) component can +A [Form](form.component.md) or [Task Details](../process-services/task-details.component.md) component can be supplied with a set of validator objects. Each validator applies a particular kind of check to a field. A number of `FormFieldModel` properties are used by validators. For example, `minValue` and `maxValue` are used to check that a numeric value falls within an diff --git a/docs/host-settings.component.md b/docs/core/host-settings.component.md similarity index 92% rename from docs/host-settings.component.md rename to docs/core/host-settings.component.md index 090db65a3f..e95c0f61fb 100644 --- a/docs/host-settings.component.md +++ b/docs/core/host-settings.component.md @@ -6,7 +6,7 @@ Status: Active Validates the URLs for ACS and APS and saves them in the user's local storage -![Host settings](docassets/images/host-settings-component.png) +![Host settings](../docassets/images/host-settings-component.png) ## Basic Usage diff --git a/docs/infinite-pagination.component.md b/docs/core/infinite-pagination.component.md similarity index 93% rename from docs/infinite-pagination.component.md rename to docs/core/infinite-pagination.component.md index 10d6658346..8969f9c69c 100644 --- a/docs/infinite-pagination.component.md +++ b/docs/core/infinite-pagination.component.md @@ -6,7 +6,7 @@ Status: Active Adds "infinite" pagination to the component it is used with. -![Infinite Pagination screenshot](docassets/images/InfPagination.png) +![Infinite Pagination screenshot](../docassets/images/InfPagination.png) ## Basic Usage @@ -61,5 +61,5 @@ See the [Pagination component](pagination.component.md) for more information abo ## See also -- [Document list component](content-services/document-list.component.md) +- [Document list component](../content-services/document-list.component.md) - [Pagination component](pagination.component.md) diff --git a/docs/login.component.md b/docs/core/login.component.md similarity index 95% rename from docs/login.component.md rename to docs/core/login.component.md index a62a016a7e..ac776822f0 100644 --- a/docs/login.component.md +++ b/docs/core/login.component.md @@ -6,7 +6,7 @@ Status: Active Authenticates to Alfresco Content Services and Alfresco Process Services. -![Login component](docassets/images/custom-footer.png) +![Login component](../docassets/images/custom-footer.png) ## Contents @@ -89,7 +89,7 @@ export class AppComponent { ### Change footer content -![Login with custom footer](docassets/images/custom-footer.png) +![Login with custom footer](../docassets/images/custom-footer.png) You can replace the entire content in the footer of the login component with your custom content. @@ -101,7 +101,7 @@ You can replace the entire content in the footer of the login component with you ### Change header content -![Login with custom header](docassets/images/custom-header.png) +![Login with custom header](../docassets/images/custom-header.png) You can replace the entire content in the header of the login component with your custom content. @@ -126,7 +126,7 @@ This becomes handy in case you need to extend it with custom input fields handle Here's an example of custom content: -![Login with custom content](docassets/images/login-extra-content.png) +![Login with custom content](../docassets/images/login-extra-content.png) ### Custom logo and background @@ -141,7 +141,7 @@ It is possible changing logo and background images to custom values. Should give you something like the following: -![Login with custom logo and background](docassets/images/custom-login.png) +![Login with custom logo and background](../docassets/images/custom-login.png) Alternatively you can bind to your component properties and provide values dynamically if needed: diff --git a/docs/logout.directive.md b/docs/core/logout.directive.md similarity index 100% rename from docs/logout.directive.md rename to docs/core/logout.directive.md diff --git a/docs/core/nodes-api.service.md b/docs/core/nodes-api.service.md index e4e61a08f9..77568dcbff 100644 --- a/docs/core/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) diff --git a/docs/pagination.component.md b/docs/core/pagination.component.md similarity index 98% rename from docs/pagination.component.md rename to docs/core/pagination.component.md index e7625b0c67..f254782698 100644 --- a/docs/pagination.component.md +++ b/docs/core/pagination.component.md @@ -6,7 +6,7 @@ Status: Active Adds pagination to the component it is used with. -![](docassets/images/basic.png) +![](../docassets/images/basic.png) ## Basic Usage diff --git a/docs/search-api.service.md b/docs/core/search-api.service.md similarity index 100% rename from docs/search-api.service.md rename to docs/core/search-api.service.md diff --git a/docs/site.model.md b/docs/core/site.model.md similarity index 94% rename from docs/site.model.md rename to docs/core/site.model.md index b9776dc081..90390f334f 100644 --- a/docs/site.model.md +++ b/docs/core/site.model.md @@ -8,7 +8,7 @@ Provides information about a site in a Content Services repository. ## Details -`SiteModel` is returned by methods from the [Sites Api service](core/sites.service.md). +`SiteModel` is returned by methods from the [Sites Api service](sites.service.md). Also, the [`getSite`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitesApi.md#getSite) and @@ -46,4 +46,4 @@ class SiteMembersModel { ## See also -- [Sites service](core/sites.service.md) +- [Sites service](sites.service.md) diff --git a/docs/core/sites.service.md b/docs/core/sites.service.md index 11dc24a655..2ad4b3bd73 100644 --- a/docs/core/sites.service.md +++ b/docs/core/sites.service.md @@ -30,7 +30,7 @@ Accesses and manipulates sites from a Content Services repository. You can use `getSites` to get a list of all sites in the repository. The sites are returned as `Observable` (see -[Site Model](../site.model.md) for more information about this class). +[Site Model](site.model.md) for more information about this class). If you are only interested in a single site and you have its ID, you can use `getSite` to access it. Alternatively, you can use `getSiteContent` or `getSiteMembers` to extract just the `contents` and `members` properties @@ -49,4 +49,4 @@ for more information about the available options. ## See also -- [Site model](../site.model.md) +- [Site model](site.model.md) diff --git a/docs/core/start-form.component.md b/docs/core/start-form.component.md index 8c4e762838..0f42eef9f1 100644 --- a/docs/core/start-form.component.md +++ b/docs/core/start-form.component.md @@ -62,7 +62,7 @@ Displays the Start Form for a process. ## Details -The [Start Process component](../start-process.component.md) uses the Start Form component +The [Start Process component](../process-services/start-process.component.md) uses the Start Form component to display the [start form](http://docs.alfresco.com/process-services1.6/topics/none_start_event.html) for the process. diff --git a/docs/translation.service.md b/docs/core/translation.service.md similarity index 98% rename from docs/translation.service.md rename to docs/core/translation.service.md index 2e3c1c3ebe..297c3e0544 100644 --- a/docs/translation.service.md +++ b/docs/core/translation.service.md @@ -149,4 +149,4 @@ class MyComponent { ## See Also -- [Internationalization](internationalization.md) +- [Internationalization](../internationalization.md) diff --git a/docs/upload.service.md b/docs/core/upload.service.md similarity index 100% rename from docs/upload.service.md rename to docs/core/upload.service.md diff --git a/docs/user-info.component.md b/docs/core/user-info.component.md similarity index 100% rename from docs/user-info.component.md rename to docs/core/user-info.component.md diff --git a/docs/internationalization.md b/docs/internationalization.md index dbdc7687a7..ca55f300bf 100644 --- a/docs/internationalization.md +++ b/docs/internationalization.md @@ -71,7 +71,7 @@ notation (so `FORM.START_FORM.TITLE` would be the key for the "Start Form" string here). This is useful for grouping related messages and providing singular and plural versions, among other things. -The [Translation service](translation.service.md) defines the `get` method to +The [Translation service](core/translation.service.md) defines the `get` method to get the translation of a key in the current language. A simple component might contain code like this: @@ -146,7 +146,7 @@ component's `.ts` file: The built-in translations certainly won't cover everything you will need for your app but you can easily replace them with your own lists. This involves making copies of the existing lists in your app's folder and adding your -own keys. See the [Translation service](translation.service.md) page for +own keys. See the [Translation service](core/translation.service.md) page for full details and examples. ## Interpolations @@ -216,5 +216,5 @@ component to see if it has built-in support for i18n. ## See also -- [Translation service](translation.service.md) +- [Translation service](core/translation.service.md) - [Language Menu component](core/language-menu.component.md) diff --git a/docs/apps-process.service.md b/docs/process-services/apps-process.service.md similarity index 100% rename from docs/apps-process.service.md rename to docs/process-services/apps-process.service.md diff --git a/docs/filter.model.md b/docs/process-services/filter.model.md similarity index 95% rename from docs/filter.model.md rename to docs/process-services/filter.model.md index 361143b339..10232fbaa0 100644 --- a/docs/filter.model.md +++ b/docs/process-services/filter.model.md @@ -68,6 +68,6 @@ class TaskQueryRequestRepresentationModel implements TaskQueryRequestRepresentat ## See also -- [Process filters component](process-services/process-filters.component.md) +- [Process filters component](process-filters.component.md) - [Task filters component](task-filters.component.md) - [Apps process service](apps-process.service.md) diff --git a/docs/log.service.md b/docs/process-services/log.service.md similarity index 100% rename from docs/log.service.md rename to docs/process-services/log.service.md diff --git a/docs/process-services/people-list.component.md b/docs/process-services/people-list.component.md index a174478d80..60e5ed564c 100644 --- a/docs/process-services/people-list.component.md +++ b/docs/process-services/people-list.component.md @@ -65,7 +65,7 @@ In the component template use the people list component: ``` Note that the people list component is based on the -[Datatable component](../datatable.component.md). +[Datatable component](../core/datatable.component.md). ### Properties diff --git a/docs/process-services/process-filters.component.md b/docs/process-services/process-filters.component.md index 3b851aaa37..3eb7be3094 100644 --- a/docs/process-services/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -74,4 +74,4 @@ page for an example of how to do set this up. ## See also -- [Filter model](../filter.model.md) +- [Filter model](filter.model.md) diff --git a/docs/process-services/process-list.component.md b/docs/process-services/process-list.component.md index 667c77b37d..3a17877fef 100644 --- a/docs/process-services/process-list.component.md +++ b/docs/process-services/process-list.component.md @@ -133,5 +133,5 @@ adf-process-instance-list also supports pagination and the same can be used as s ## See also - [Data column component](../core/data-column.component.md) -- [DataTableAdapter](../datatable-adapter.interface.md) -- [Pagination component](../pagination.component.md) \ No newline at end of file +- [DataTableAdapter](../core/datatable-adapter.interface.md) +- [Pagination component](../core/pagination.component.md) \ No newline at end of file diff --git a/docs/select-apps-dialog.component.md b/docs/process-services/select-apps-dialog.component.md similarity index 90% rename from docs/select-apps-dialog.component.md rename to docs/process-services/select-apps-dialog.component.md index d27bbdb4c6..248d7499a1 100644 --- a/docs/select-apps-dialog.component.md +++ b/docs/process-services/select-apps-dialog.component.md @@ -6,7 +6,7 @@ Status: Active Show all available apps and return the selected app. -![select-apps-dialog](docassets/images/select-apps-dialog.png) +![select-apps-dialog](../docassets/images/select-apps-dialog.png) ## Basic Usage diff --git a/docs/start-process.component.md b/docs/process-services/start-process.component.md similarity index 95% rename from docs/start-process.component.md rename to docs/process-services/start-process.component.md index 3b83403f7a..6d0836332d 100644 --- a/docs/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -8,7 +8,7 @@ Last reviewed: 2018-03-13 Starts a process. -![adf-start-process ](docassets/images/startProcess.png) +![adf-start-process ](../docassets/images/startProcess.png) ## Basic Usage @@ -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](content-services/document-library.model.md): +[MinimalNodeEntryEntity](../content-services/document-library.model.md): ```html