From 6dc758889f8d5fb4451c3379a40a68cec8962baa Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Tue, 13 Mar 2018 17:29:07 +0000 Subject: [PATCH] [ADF-2463] Moved doc files to subfolders (#3073) --- docs/README.md | 58 +++++++++---------- docs/core/accordion.component.md | 2 +- .../form-field-validator.interface.md | 5 +- docs/{ => core}/form-field.component.md | 0 docs/{ => core}/form-field.model.md | 8 +-- docs/{ => core}/form-list.component.md | 0 docs/{ => core}/form-rendering.service.md | 6 +- docs/{ => core}/form.component.md | 9 ++- docs/{ => core}/form.service.md | 0 docs/{ => core}/start-form.component.md | 8 +-- docs/extensibility.md | 6 +- docs/filter.model.md | 2 +- docs/insights/widget.component.md | 2 +- .../apps-list.component.md | 4 +- .../checklist.component.md | 0 .../comment-list.component.md | 2 +- .../comments.component.md | 2 +- .../create-process-attachment.component.md | 2 +- .../create-task-attachment.component.md | 2 +- .../people-list.component.md | 5 +- .../people-search.component.md | 0 .../people.component.md | 10 ++-- .../process-attachment-list.component.md | 6 +- .../process-audit.directive.md | 2 +- .../process-comments.component.md | 0 .../process-content.service.md | 0 .../process-filter.service.md | 0 .../process-filters.component.md | 4 +- .../process-instance-details.component.md | 0 .../process-instance-header.component.md | 2 +- .../process-instance-tasks.component.md | 0 .../process-list.component.md | 7 +-- .../{ => process-services}/process.service.md | 0 docs/versionIndex.md | 54 ++++++++--------- 34 files changed, 103 insertions(+), 105 deletions(-) rename docs/{ => core}/form-field-validator.interface.md (96%) rename docs/{ => core}/form-field.component.md (100%) rename docs/{ => core}/form-field.model.md (94%) rename docs/{ => core}/form-list.component.md (100%) rename docs/{ => core}/form-rendering.service.md (95%) rename docs/{ => core}/form.component.md (97%) rename docs/{ => core}/form.service.md (100%) rename docs/{ => core}/start-form.component.md (92%) rename docs/{ => process-services}/apps-list.component.md (93%) rename docs/{ => process-services}/checklist.component.md (100%) rename docs/{ => process-services}/comment-list.component.md (95%) rename docs/{ => process-services}/comments.component.md (92%) rename docs/{ => process-services}/create-process-attachment.component.md (92%) rename docs/{ => process-services}/create-task-attachment.component.md (91%) rename docs/{ => process-services}/people-list.component.md (92%) rename docs/{ => process-services}/people-search.component.md (100%) rename docs/{ => process-services}/people.component.md (83%) rename docs/{ => process-services}/process-attachment-list.component.md (90%) rename docs/{ => process-services}/process-audit.directive.md (92%) rename docs/{ => process-services}/process-comments.component.md (100%) rename docs/{ => process-services}/process-content.service.md (100%) rename docs/{ => process-services}/process-filter.service.md (100%) rename docs/{ => process-services}/process-filters.component.md (95%) rename docs/{ => process-services}/process-instance-details.component.md (100%) rename docs/{ => process-services}/process-instance-header.component.md (91%) rename docs/{ => process-services}/process-instance-tasks.component.md (100%) rename docs/{ => process-services}/process-list.component.md (95%) rename docs/{ => process-services}/process.service.md (100%) diff --git a/docs/README.md b/docs/README.md index 4f9cac1e1b..edd92fd165 100644 --- a/docs/README.md +++ b/docs/README.md @@ -57,10 +57,10 @@ for more information about installing and using the source code. | [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) | -| [Form field component](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](form-list.component.md) | Shows APS forms as a list. | [Source](../lib/core/form/components/form-list.component.ts) | -| [Form component](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) | -| [Start form component](start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.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) | +| [Start form component](core/start-form.component.md) | Displays the Start Form for a process. | [Source](../lib/core/form/components/start-form.component.ts) | | [Text mask component](core/text-mask.component.md) | Implements text field input masks. | [Source](../lib/core/form/components/widgets/text/text-mask.component.ts) | | [Info drawer layout component](core/info-drawer-layout.component.md) | Displays a sidebar-style information panel. | [Source](../lib/core/info-drawer/info-drawer-layout.component.ts) | | [Info drawer component](core/info-drawer.component.md) | Displays a sidebar-style information panel with tabs. | [Source](../lib/core/info-drawer/info-drawer.component.ts) | @@ -93,7 +93,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Form field model](form-field.model.md) | Contains the value and metadata for a field of an [ADF Form](form.component.md). | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | +| [Form field model](core/form-field.model.md) | Contains the value and metadata for a field of a Form component. | [Source](../lib/core/form/components/widgets/core/form-field.model.ts) | | [Comment process model](core/comment-process.model.md) | Represents a comment added to a Process Services task or process instance. | [Source](../lib/core/models/comment-process.model.ts) | | [Product version model](core/product-version.model.md) | Contains version and license information classes for Alfresco products. | [Source](../lib/core/models/product-version.model.ts) | | [User process model](core/user-process.model.md) | Represents a Process Services user. | [Source](../lib/core/models/user-process.model.ts) | @@ -117,10 +117,10 @@ for more information about installing and using the source code. | ---- | ----------- | ----------- | | [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) | -| [Form rendering service](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](form.service.md) | Implements Process Services form methods | [Source](../lib/core/form/services/form.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) | -| [Process content service](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) | +| [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) | @@ -164,8 +164,8 @@ 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](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [Form Field Validator interface](form-field-validator.interface.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | +| [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) | [(Back to Contents)](#contents) @@ -250,24 +250,24 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Apps list component](apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/app-list/apps-list.component.ts) | -| [Create process attachment component](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](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-attachment-list.component.md) | Displays attached documents on a specified process instance | [Source](../lib/process-services/attachment/process-attachment-list.component.ts) | +| [Apps list component](process-services/apps-list.component.md) | Shows all available apps. | [Source](../lib/process-services/app-list/apps-list.component.ts) | +| [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) | -| [Comment list component](comment-list.component.md) | Shows a list of comments. | [Source](../lib/process-services/comments/comment-list.component.ts) | -| [Comments component](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-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) | -| [People component](people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/components/people/people.component.ts) | -| [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/components/people-list/people-list.component.ts) | -| [People search component](people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/components/people-search/people-search.component.ts) | -| [Process filters component](process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/process-list/components/process-filters.component.ts) | -| [Process instance details component](process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) | -| [Process instance header component](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-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-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) | +| [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) | +| [People component](process-services/people.component.md) | Displays users involved with a specified task | [Source](../lib/process-services/people/components/people/people.component.ts) | +| [People list component](process-services/people-list.component.md) | Shows a list of users (people). | [Source](../lib/process-services/people/components/people-list/people-list.component.ts) | +| [People search component](process-services/people-search.component.md) | Searches users/people. | [Source](../lib/process-services/people/components/people-search/people-search.component.ts) | +| [Process filters component](process-services/process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../lib/process-services/process-list/components/process-filters.component.ts) | +| [Process instance details component](process-services/process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../lib/process-services/process-list/components/process-instance-details.component.ts) | +| [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) | -| [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../lib/process-services/task-list/components/checklist.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 filters component](task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/task-list/components/task-filters.component.ts) | @@ -278,7 +278,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Process audit directive](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) | +| [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) | ## Models @@ -292,8 +292,8 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Process filter service](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.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) | +| [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) | diff --git a/docs/core/accordion.component.md b/docs/core/accordion.component.md index ef99d53417..eba710b67b 100644 --- a/docs/core/accordion.component.md +++ b/docs/core/accordion.component.md @@ -44,7 +44,7 @@ properties (title, selection status, etc). ### Example -You can use an accordion menu to wrap a [process filter](../process-filters.component.md), as shown in +You can use an accordion menu to wrap a [process filter](../process-services/process-filters.component.md), as shown in the following example: ```html diff --git a/docs/form-field-validator.interface.md b/docs/core/form-field-validator.interface.md similarity index 96% rename from docs/form-field-validator.interface.md rename to docs/core/form-field-validator.interface.md index 30f5299324..6c813665e2 100644 --- a/docs/form-field-validator.interface.md +++ b/docs/core/form-field-validator.interface.md @@ -4,8 +4,7 @@ Status: Active --- # FormFieldValidator interface -Defines how the input fields of [ADF Form](form.component.md) and -[ADF Task Details](task-details.component.md) components are validated. +Defines how the input fields of Form and Task Details components are validated. ## Basic Usage @@ -146,7 +145,7 @@ custom validator set: If you now run the application and try to enter "admin" in one of the text fields (either optional or required), you should see the following error: -![](docassets/images/demo-validator.png) +![](../docassets/images/demo-validator.png) ## See also diff --git a/docs/form-field.component.md b/docs/core/form-field.component.md similarity index 100% rename from docs/form-field.component.md rename to docs/core/form-field.component.md diff --git a/docs/form-field.model.md b/docs/core/form-field.model.md similarity index 94% rename from docs/form-field.model.md rename to docs/core/form-field.model.md index d3ca1fbb11..640e7bb693 100644 --- a/docs/form-field.model.md +++ b/docs/core/form-field.model.md @@ -4,7 +4,7 @@ Status: Active --- # Form Field model -Contains the value and metadata for a field of an [ADF Form](form.component.md). +Contains the value and metadata for a field of a Form component. ## Properties @@ -60,11 +60,11 @@ You will need to use the properties of `FormFieldModel` if you want to implement custom widgets. Aside from the `value` property (which contains the data value entered into the field), there are also a few other fields that are used for specific types of data. For example, the `currency` property holds the currency symbol to be displayed next to the value -(such as the dollar sign $) and the `dateDisplayFormat` defines how the elements of a date/time will be arranged. See the [Form Extensibility and Customization](extensibility.md) for more information about creating custom widgets. +(such as the dollar sign $) and the `dateDisplayFormat` defines how the elements of a date/time will be arranged. See the [Form Extensibility and Customization](../extensibility.md) for more information about creating custom widgets. ### Validation -A [Form](form.component.md) or [Task Details](task-details.component.md) component can +A [Form](form.component.md) or [Task Details](../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 @@ -93,7 +93,7 @@ contains full details about how the REST calls work, along with a worked example ## See also -- [Extensibility](extensibility.md) +- [Extensibility](../extensibility.md) - [FormFieldValidator](form-field-validator.interface.md) - [Form rendering service](form-rendering.service.md) - [Form component](form.component.md) diff --git a/docs/form-list.component.md b/docs/core/form-list.component.md similarity index 100% rename from docs/form-list.component.md rename to docs/core/form-list.component.md diff --git a/docs/form-rendering.service.md b/docs/core/form-rendering.service.md similarity index 95% rename from docs/form-rendering.service.md rename to docs/core/form-rendering.service.md index 6b1b84b2b8..051c118d05 100644 --- a/docs/form-rendering.service.md +++ b/docs/core/form-rendering.service.md @@ -19,7 +19,7 @@ Maps an APS form field type string onto the corresponding form widget component - `override` - The new resolver will only replace an existing one if this parameter is true - `resolveComponentType(model: DynamicComponentModel, defaultValue: Type<{}> = this.defaultValue): Type<{}>` Finds the component type that is needed to render a form field. - - `model` - \[Form field model](form-field.model.md) for the field to render + - `model` - [Form field model](form-field.model.md) for the field to render - `defaultValue` - Default type returned for field types that are not yet mapped. ## Details @@ -90,11 +90,11 @@ formRenderingService.setComponentTypeResolver('text', newResolver, true); You would typically use this to replace an existing widget with your own custom version that implements a modified layout or responds differently when the data is entered. See the -[Form Extensibility and Customisation](extensibility.md) guide for further details and examples +[Form Extensibility and Customisation](../extensibility.md) guide for further details and examples of this technique. ## See also -- [Extensibility](extensibility.md) +- [Extensibility](../extensibility.md) - [Form field model](form-field.model.md) - [Form component](form.component.md) diff --git a/docs/form.component.md b/docs/core/form.component.md similarity index 97% rename from docs/form.component.md rename to docs/core/form.component.md index 26874c5504..408ba97a94 100644 --- a/docs/form.component.md +++ b/docs/core/form.component.md @@ -240,7 +240,7 @@ also implement your own custom validators to replace or extend the set. See the #### Render form by using form definition JSON -Please give a look to the [demo-form](docassets/demo-form.json) as a sample of form definition JSON. +Please give a look to the [demo-form](../docassets/demo-form.json) as a sample of form definition JSON. The component below with the form definition JSON assigned to the variable `formDefinitionJSON`, shows how a form is rendered by using form definition JSON. @@ -288,7 +288,7 @@ You subscribe to the `formFieldValueChanged` event and check whether event is ra The result should be as following: -![](docassets/images/form-service-sample-01.png) +![](../docassets/images/form-service-sample-01.png) #### Listen all form Events @@ -331,14 +331,13 @@ Using the CSS you can target any outcome ID and change the style as in this exam } ``` -![](docassets/images/form-style-sample.png) +![](../docassets/images/form-style-sample.png) ## See also -- [Stencils](stencils.md) - [FormFieldValidator](form-field-validator.interface.md) -- [Extensibility](extensibility.md) +- [Extensibility](../extensibility.md) - [Form rendering service](form-rendering.service.md) - [Form field model](form-field.model.md) diff --git a/docs/form.service.md b/docs/core/form.service.md similarity index 100% rename from docs/form.service.md rename to docs/core/form.service.md diff --git a/docs/start-form.component.md b/docs/core/start-form.component.md similarity index 92% rename from docs/start-form.component.md rename to docs/core/start-form.component.md index 8a4d1124f4..8c4e762838 100644 --- a/docs/start-form.component.md +++ b/docs/core/start-form.component.md @@ -6,7 +6,7 @@ Status: Active Displays the Start Form for a process. -![Start Form screenshot](docassets/images/ProcessStartForm.png) +![Start Form screenshot](../docassets/images/ProcessStartForm.png) ## Basic Usage @@ -62,15 +62,15 @@ 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](../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. The `outcomeClick` event is passed a string containing the ID of the outcome button that the user clicked. You can pass this value to the `startProcess` method (defined in the -[Process service](process.service.md)) when activating the process, if necessary. +[Process service](../process-services/process.service.md)) when activating the process, if necessary. ## See also -- [Process service](process.service.md) +- [Process service](../process-services/process.service.md) diff --git a/docs/extensibility.md b/docs/extensibility.md index a5eed9d25a..193ad74df8 100644 --- a/docs/extensibility.md +++ b/docs/extensibility.md @@ -259,7 +259,7 @@ At runtime you should now see your custom Angular component rendered in place of ## See Also -- [Form field model](form-field.model.md) -- [Form rendering service](form-rendering.service.md) -- [Form component](form.component.md) +- [Form field model](core/form-field.model.md) +- [Form rendering service](core/form-rendering.service.md) +- [Form component](core/form.component.md) - [Widget component](insights/widget.component.md) diff --git a/docs/filter.model.md b/docs/filter.model.md index 10232fbaa0..361143b339 100644 --- a/docs/filter.model.md +++ b/docs/filter.model.md @@ -68,6 +68,6 @@ class TaskQueryRequestRepresentationModel implements TaskQueryRequestRepresentat ## See also -- [Process filters component](process-filters.component.md) +- [Process filters component](process-services/process-filters.component.md) - [Task filters component](task-filters.component.md) - [Apps process service](apps-process.service.md) diff --git a/docs/insights/widget.component.md b/docs/insights/widget.component.md index 6a09db0d72..27ce4a802e 100644 --- a/docs/insights/widget.component.md +++ b/docs/insights/widget.component.md @@ -26,7 +26,7 @@ export class CustomEditorComponent extends WidgetComponent {} | Name | Type | Default | Description | | ---- | ---- | ------- | ----------- | | readOnly | boolean | false | Does the widget show a read-only value? (ie, can't be edited) | -| field | [FormFieldModel](../form-field.model.md) | | Data to be displayed in the field | +| field | [FormFieldModel](../core/form-field.model.md) | | Data to be displayed in the field | ## Details diff --git a/docs/apps-list.component.md b/docs/process-services/apps-list.component.md similarity index 93% rename from docs/apps-list.component.md rename to docs/process-services/apps-list.component.md index 0b9adf11cc..5cc034dfcb 100644 --- a/docs/apps-list.component.md +++ b/docs/process-services/apps-list.component.md @@ -6,7 +6,7 @@ Status: Active Shows all available apps. -![how-filter-apps](docassets/images/how-filter-apps.png) +![how-filter-apps](../docassets/images/how-filter-apps.png) ## Basic Usage @@ -60,7 +60,7 @@ If you want to show some specific apps you can specify them through the filtersA In this specific case only the Tasks app, the app with deploymentId 15037 and the app with "my app name" will be shown. -![how-filter-apps](docassets/images/how-filter-apps.png) +![how-filter-apps](../docassets/images/how-filter-apps.png) You can use inside the filter one of the following property diff --git a/docs/checklist.component.md b/docs/process-services/checklist.component.md similarity index 100% rename from docs/checklist.component.md rename to docs/process-services/checklist.component.md diff --git a/docs/comment-list.component.md b/docs/process-services/comment-list.component.md similarity index 95% rename from docs/comment-list.component.md rename to docs/process-services/comment-list.component.md index 987a380dcd..9887f7962a 100644 --- a/docs/comment-list.component.md +++ b/docs/process-services/comment-list.component.md @@ -6,7 +6,7 @@ Status: Active Shows a list of comments. -![ADF Comment List](docassets/images/adf-comment-list.png) +![ADF Comment List](../docassets/images/adf-comment-list.png) ## Basic Usage diff --git a/docs/comments.component.md b/docs/process-services/comments.component.md similarity index 92% rename from docs/comments.component.md rename to docs/process-services/comments.component.md index 3f545e4c5e..d949e4b793 100644 --- a/docs/comments.component.md +++ b/docs/process-services/comments.component.md @@ -6,7 +6,7 @@ Status: Active Displays comments from users involved in a specified task and allows an involved user to add a comment to the task. -![adf-comments](docassets/images/adf-comments.png) +![adf-comments](../docassets/images/adf-comments.png) ## Basic Usage diff --git a/docs/create-process-attachment.component.md b/docs/process-services/create-process-attachment.component.md similarity index 92% rename from docs/create-process-attachment.component.md rename to docs/process-services/create-process-attachment.component.md index 1bd95fd77a..377f5b6400 100644 --- a/docs/create-process-attachment.component.md +++ b/docs/process-services/create-process-attachment.component.md @@ -6,7 +6,7 @@ Status: Active Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance -![process-create-attachment](docassets/images/process-create-attachment.png) +![process-create-attachment](../docassets/images/process-create-attachment.png) ## Basic Usage diff --git a/docs/create-task-attachment.component.md b/docs/process-services/create-task-attachment.component.md similarity index 91% rename from docs/create-task-attachment.component.md rename to docs/process-services/create-task-attachment.component.md index e96446ac67..e8dc8826b4 100644 --- a/docs/create-task-attachment.component.md +++ b/docs/process-services/create-task-attachment.component.md @@ -6,7 +6,7 @@ Status: Active Displays Upload Component (Drag and Click) to upload the attachment to a specified task -![task-create-attachment](docassets/images/task-create-attachment.png) +![task-create-attachment](../docassets/images/task-create-attachment.png) ## Basic Usage diff --git a/docs/people-list.component.md b/docs/process-services/people-list.component.md similarity index 92% rename from docs/people-list.component.md rename to docs/process-services/people-list.component.md index f48b8fd8f9..a174478d80 100644 --- a/docs/people-list.component.md +++ b/docs/process-services/people-list.component.md @@ -6,7 +6,7 @@ Status: Active Shows a list of users (people). -![ADF People List](docassets/images/adf-people-list.png) +![ADF People List](../docassets/images/adf-people-list.png) ## Basic Usage @@ -64,7 +64,8 @@ In the component template use the people list component: ``` -Note that the people list component is based on the [Datatable component](datatable.component.md). +Note that the people list component is based on the +[Datatable component](../datatable.component.md). ### Properties diff --git a/docs/people-search.component.md b/docs/process-services/people-search.component.md similarity index 100% rename from docs/people-search.component.md rename to docs/process-services/people-search.component.md diff --git a/docs/people.component.md b/docs/process-services/people.component.md similarity index 83% rename from docs/people.component.md rename to docs/process-services/people.component.md index 9f757e2268..559cff40f5 100644 --- a/docs/people.component.md +++ b/docs/process-services/people.component.md @@ -30,7 +30,7 @@ Displays users involved with a specified task ``` -![activiti-people](docassets/images/activiti_people.png) +![activiti-people](../docassets/images/activiti_people.png) ### Properties @@ -62,7 +62,7 @@ In this way will be easy customize the people component to involve the user with ``` -![involve-people-single-click-and-close-search](docassets/images/involve-people-single-click-and-close-search.gif) +![involve-people-single-click-and-close-search](../docassets/images/involve-people-single-click-and-close-search.gif) ### Involve People single click without close search @@ -75,7 +75,7 @@ In this way will be easy customize the people component to involve the user with ``` -![involve-people-single-click-without-close-search](docassets/images/involve-people-single-click-without-close-search.gif) +![involve-people-single-click-without-close-search](../docassets/images/involve-people-single-click-without-close-search.gif) ### Involve People double click and close search @@ -88,7 +88,7 @@ In this way will be easy customize the people component to involve the user with ``` -![involve-people-double-click-and-close-search](docassets/images/involve-people-double-click-and-close-search.gif) +![involve-people-double-click-and-close-search](../docassets/images/involve-people-double-click-and-close-search.gif) ### Involve People double double without close search @@ -101,4 +101,4 @@ In this way will be easy customize the people component to involve the user with ``` -![involve-people-double-click-without-close-search](docassets/images/involve-people-double-click-without-close-search.gif) +![involve-people-double-click-without-close-search](../docassets/images/involve-people-double-click-without-close-search.gif) diff --git a/docs/process-attachment-list.component.md b/docs/process-services/process-attachment-list.component.md similarity index 90% rename from docs/process-attachment-list.component.md rename to docs/process-services/process-attachment-list.component.md index 635cf959e7..e047154cc4 100644 --- a/docs/process-attachment-list.component.md +++ b/docs/process-services/process-attachment-list.component.md @@ -6,7 +6,7 @@ Status: Active Displays attached documents on a specified process instance -![process-attachment-list-sample](docassets/images/process-attachment-list.png) +![process-attachment-list-sample](../docassets/images/process-attachment-list.png) ## Basic Usage @@ -19,7 +19,7 @@ Displays attached documents on a specified process instance If the List is empty, a default no content template is displayed. -![default-no-content-template-sample](docassets/images/default-no-content-template.png) +![default-no-content-template-sample](../docassets/images/default-no-content-template.png) Make sure to override the UploadService with the ProcessUploadService @@ -80,4 +80,4 @@ If we want user to be able to upload attachments for empty lists, We can wrap ou If the List is empty, the custom no-content template we passed is displayed. -![custom-no-content-drag-drop-template-sample](docassets/images/custom-no-content-drag-drop-template.png) +![custom-no-content-drag-drop-template-sample](../docassets/images/custom-no-content-drag-drop-template.png) diff --git a/docs/process-audit.directive.md b/docs/process-services/process-audit.directive.md similarity index 92% rename from docs/process-audit.directive.md rename to docs/process-services/process-audit.directive.md index 5088546701..e110864c3d 100644 --- a/docs/process-audit.directive.md +++ b/docs/process-services/process-audit.directive.md @@ -6,7 +6,7 @@ Status: Active Fetches the Process Audit information in the pdf or json format. -![adf-process-audit-directive](docassets/images/adf-process-audit-directive.png) +![adf-process-audit-directive](../docassets/images/adf-process-audit-directive.png) ## Basic Usage diff --git a/docs/process-comments.component.md b/docs/process-services/process-comments.component.md similarity index 100% rename from docs/process-comments.component.md rename to docs/process-services/process-comments.component.md diff --git a/docs/process-content.service.md b/docs/process-services/process-content.service.md similarity index 100% rename from docs/process-content.service.md rename to docs/process-services/process-content.service.md diff --git a/docs/process-filter.service.md b/docs/process-services/process-filter.service.md similarity index 100% rename from docs/process-filter.service.md rename to docs/process-services/process-filter.service.md diff --git a/docs/process-filters.component.md b/docs/process-services/process-filters.component.md similarity index 95% rename from docs/process-filters.component.md rename to docs/process-services/process-filters.component.md index 9a6afb75dd..3b851aaa37 100644 --- a/docs/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -69,9 +69,9 @@ You can use inside the filterParam one of the properties defined by [FilterParam ### How to create an accordion menu with the processes filter -The process filter often works well as an item in an accordion menu. See the [Accordion component](core/accordion.component.md) +The process filter often works well as an item in an accordion menu. See the [Accordion component](../core/accordion.component.md) 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-instance-details.component.md b/docs/process-services/process-instance-details.component.md similarity index 100% rename from docs/process-instance-details.component.md rename to docs/process-services/process-instance-details.component.md diff --git a/docs/process-instance-header.component.md b/docs/process-services/process-instance-header.component.md similarity index 91% rename from docs/process-instance-header.component.md rename to docs/process-services/process-instance-header.component.md index 168f972aaf..751bdb40c3 100644 --- a/docs/process-instance-header.component.md +++ b/docs/process-services/process-instance-header.component.md @@ -6,7 +6,7 @@ Status: Active Sub-component of the process details component, which renders some general information about the selected process. -![adf-process-instance-header](docassets/images/adf-process-instance-header-attachment.png) +![adf-process-instance-header](../docassets/images/adf-process-instance-header-attachment.png) ## Basic Usage diff --git a/docs/process-instance-tasks.component.md b/docs/process-services/process-instance-tasks.component.md similarity index 100% rename from docs/process-instance-tasks.component.md rename to docs/process-services/process-instance-tasks.component.md diff --git a/docs/process-list.component.md b/docs/process-services/process-list.component.md similarity index 95% rename from docs/process-list.component.md rename to docs/process-services/process-list.component.md index b7034618fa..667c77b37d 100644 --- a/docs/process-list.component.md +++ b/docs/process-services/process-list.component.md @@ -130,9 +130,8 @@ adf-process-instance-list also supports pagination and the same can be used as s | success | Emitted when the list of process instances has been loaded successfully from the server | | error | Emitted when an error is encountered loading the list of process instances from the server | -``` ## See also -- [Data column component](data-column.component.md) -- [DataTableAdapter](datatable-adapter.interface.md) -- [Pagination component](pagination.component.md) \ No newline at end of file +- [Data column component](../core/data-column.component.md) +- [DataTableAdapter](../datatable-adapter.interface.md) +- [Pagination component](../pagination.component.md) \ No newline at end of file diff --git a/docs/process.service.md b/docs/process-services/process.service.md similarity index 100% rename from docs/process.service.md rename to docs/process-services/process.service.md diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 190934e809..ece07e6312 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -35,7 +35,7 @@ ADF version in which they were introduced. See the - [Analytics report list component](insights/analytics-report-list.component.md) - [Analytics component](insights/analytics.component.md) - [App config service](core/app-config.service.md) -- [Apps list component](apps-list.component.md) +- [Apps list component](process-services/apps-list.component.md) - [Apps process service](apps-process.service.md) - [Auth guard bpm service](core/auth-guard-bpm.service.md) - [Auth guard ecm service](core/auth-guard-ecm.service.md) @@ -46,19 +46,19 @@ ADF version in which they were introduced. See the - [Breadcrumb component](breadcrumb.component.md) - [Card view update service](core/card-view-update.service.md) - [Card view component](core/card-view.component.md) -- [Checklist component](checklist.component.md) -- [Comment list component](comment-list.component.md) +- [Checklist component](process-services/checklist.component.md) +- [Comment list component](process-services/comment-list.component.md) - [Comment process model](core/comment-process.model.md) - [Comment process service](core/comment-process.service.md) -- [Comments component](comments.component.md) +- [Comments component](process-services/comments.component.md) - [Content action component](content-action.component.md) - [Content node selector component](content-node-selector.component.md) - [Content service](core/content.service.md) - [Content widget](content.widget.md) - [Context menu directive](core/context-menu.directive.md) - [Cookie service](core/cookie.service.md) -- [Create process attachment component](create-process-attachment.component.md) -- [Create task attachment component](create-task-attachment.component.md) +- [Create process attachment component](process-services/create-process-attachment.component.md) +- [Create task attachment component](process-services/create-task-attachment.component.md) - [Data column component](core/data-column.component.md) - [Datatable component](datatable.component.md) - [Deleted nodes api service](core/deleted-nodes-api.service.md) @@ -79,12 +79,12 @@ ADF version in which they were introduced. See the - [Folder actions service](folder-actions.service.md) - [Folder create directive](folder-create.directive.md) - [Folder edit directive](folder-edit.directive.md) -- [Form field component](form-field.component.md) -- [Form field model](form-field.model.md) -- [Form list component](form-list.component.md) -- [Form rendering service](form-rendering.service.md) -- [Form component](form.component.md) -- [Form service](form.service.md) +- [Form field component](core/form-field.component.md) +- [Form field model](core/form-field.model.md) +- [Form list component](core/form-list.component.md) +- [Form rendering service](core/form-rendering.service.md) +- [Form component](core/form.component.md) +- [Form service](core/form.service.md) - [Highlight transform service](core/highlight-transform.service.md) - [Highlight directive](core/highlight.directive.md) - [Host settings component](host-settings.component.md) @@ -108,22 +108,22 @@ ADF version in which they were introduced. See the - [Page title service](core/page-title.service.md) - [Pagination component](pagination.component.md) - [People content service](core/people-content.service.md) -- [People list component](people-list.component.md) +- [People list component](process-services/people-list.component.md) - [People process service](core/people-process.service.md) -- [People search component](people-search.component.md) -- [People component](people.component.md) +- [People search component](process-services/people-search.component.md) +- [People component](process-services/people.component.md) - [Permissions style model](permissions-style.model.md) -- [Process attachment list component](process-attachment-list.component.md) -- [Process audit directive](process-audit.directive.md) -- [Process comments component](process-comments.component.md) -- [Process content service](process-content.service.md) -- [Process filter service](process-filter.service.md) -- [Process filters component](process-filters.component.md) -- [Process instance details component](process-instance-details.component.md) -- [Process instance header component](process-instance-header.component.md) -- [Process instance tasks component](process-instance-tasks.component.md) -- [Process list component](process-list.component.md) -- [Process service](process.service.md) +- [Process attachment list component](process-services/process-attachment-list.component.md) +- [Process audit directive](process-services/process-audit.directive.md) +- [Process comments component](process-services/process-comments.component.md) +- [Process content service](process-services/process-content.service.md) +- [Process filter service](process-services/process-filter.service.md) +- [Process filters component](process-services/process-filters.component.md) +- [Process instance details component](process-services/process-instance-details.component.md) +- [Process instance header component](process-services/process-instance-header.component.md) +- [Process instance tasks component](process-services/process-instance-tasks.component.md) +- [Process list component](process-services/process-list.component.md) +- [Process service](process-services/process.service.md) - [Product version model](core/product-version.model.md) - [Rating component](rating.component.md) - [Rating service](rating.service.md) @@ -136,7 +136,7 @@ ADF version in which they were introduced. See the - [Site model](site.model.md) - [Sites dropdown component](sites-dropdown.component.md) - [Sites service](core/sites.service.md) -- [Start form component](start-form.component.md) +- [Start form component](core/start-form.component.md) - [Start process component](start-process.component.md) - [Start task component](start-task.component.md) - [Storage service](core/storage.service.md)