From 5c63b7c0f86d11e843cbf6391862b5122422fea9 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Tue, 19 Mar 2019 22:17:30 +0000 Subject: [PATCH] [ADF-4252] Added doc link fixing tool (#4461) * [ADF-4252] Added basic fixer for link and image URLs * [ADF-4252] Added full check to link fixing tool * [ADF-4252] Manually replaced http Github doc URLs * [ADF-4252] Fixed rel note doc links with tool --- docs/release-notes/RelNote161.md | 30 ++++---- docs/release-notes/RelNote170.md | 42 +++++------ docs/release-notes/RelNote180.md | 20 ++--- docs/release-notes/RelNote190.md | 22 +++--- docs/release-notes/RelNote200.md | 94 ++++++++++++------------ docs/release-notes/RelNote210.md | 38 +++++----- docs/release-notes/RelNote220.md | 22 +++--- docs/release-notes/RelNote230.md | 26 +++---- docs/release-notes/RelNote240.md | 40 +++++----- docs/release-notes/RelNote250.md | 26 +++---- docs/release-notes/RelNote260.md | 20 ++--- docs/release-notes/RelNote300.md | 96 ++++++++++++------------ tools/doc/doctool.config.json | 3 +- tools/doc/mqDefs.js | 29 ++++++++ tools/doc/mqDefs.ts | 37 ++++++++++ tools/doc/tools/gqIndex.js | 30 +------- tools/doc/tools/gqIndex.ts | 35 +-------- tools/doc/tools/linkFixer.js | 96 ++++++++++++++++++++++++ tools/doc/tools/linkFixer.ts | 122 +++++++++++++++++++++++++++++++ tools/doc/tsconfig.json | 5 +- 20 files changed, 527 insertions(+), 306 deletions(-) create mode 100644 tools/doc/tools/linkFixer.js create mode 100644 tools/doc/tools/linkFixer.ts diff --git a/docs/release-notes/RelNote161.md b/docs/release-notes/RelNote161.md index d3d22ae8af..6e43800c37 100644 --- a/docs/release-notes/RelNote161.md +++ b/docs/release-notes/RelNote161.md @@ -38,7 +38,7 @@ The release can be found on GitHub at [this link.](https://github.com/Alfresco/a The roadmap for ADF is taking form, and we have a high focus on bringing in engaging design and UX, as well as add more and more content capabilities into ADF. -Our focus while developing ADF 1.6.1 has been improving the Document List, Improved Preview, Finalize the design of the [Login component,](../core/login.component.md) External configuration, Performance enhancements for development, improvements in forms as well as paving the way for editing metadata and using forms for content. +Our focus while developing ADF 1.6.1 has been improving the Document List, Improved Preview, Finalize the design of the [Login component,](../core/components/login.component.md) External configuration, Performance enhancements for development, improvements in forms as well as paving the way for editing metadata and using forms for content. This release builds on last month's contains bug fixes and new feature. See the list below for major details. @@ -53,9 +53,9 @@ Below the most relevant features of this release. - New extension support in viewer - Extend TypeScript definitions for JS-API - ADF Card View -- [Task Header Component](../process-services/task-header.component.md) -- Process and [Task attachment list component](../process-services/task-attachment-list.component.md) -- Add [people Component](../process-services/people.component.md) +- [Task Header Component](../process-services/components/task-header.component.md) +- Process and [Task attachment list component](../process-services/components/task-attachment-list.component.md) +- Add [people Component](../process-services/components/people.component.md) - Breadcrumb root path personalisation - [`Form`](../../lib/process-services/task-list/models/form.model.ts) events bus - [`Form`](../../lib/process-services/task-list/models/form.model.ts) render independent from APS @@ -67,7 +67,7 @@ Below the most relevant features of this release. ![](images/Screen+Shot+2017-06-29+at+00.12.55.png) -_The ng2-alfresco-viewer if the [renditions service](../core/renditions.service.md) can convert the unsupported document in PDF will show a pop up with the double possibility to Download the file or convert it to PDF._ +_The ng2-alfresco-viewer if the [renditions service](../core/services/renditions.service.md) can convert the unsupported document in PDF will show a pop up with the double possibility to Download the file or convert it to PDF._ ### 2. Datatable loading state @@ -174,11 +174,11 @@ Result: This component was already present in the previous ADF versions but we changed the design and improve the code. -With this component, you can easily involve a person into a task. The component itself is composed of two different component, the [search component,](../content-services/search.component.md) the [people list component](../process-services/people-list.component.md). +With this component, you can easily involve a person into a task. The component itself is composed of two different component, the [search component,](../content-services/components/search.component.md) the [people list component](../process-services/components/people-list.component.md). -The [search component](../content-services/search.component.md) has the goal to find a person not involved and show the results in a list. The list is always a [data table component](../../lib/core/datatable/components/datatable/datatable.component.ts) with the action menu disabled. +The [search component](../content-services/components/search.component.md) has the goal to find a person not involved and show the results in a list. The list is always a [data table component](../../lib/core/datatable/components/datatable/datatable.component.ts) with the action menu disabled. -The [people list component](../process-services/people-list.component.md) shows all the people involved in a task in a list. +The [people list component](../process-services/components/people-list.component.md) shows all the people involved in a task in a list. The component is a wrapper of the data-table component with a custom action i.e. Remove the person from the list. @@ -279,13 +279,13 @@ And the underlying component controller code can be as follows: #### Parsing form definitions -The [`FormService`](../core/form.service.md) got a new API to parse form definitions from JSON into the [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) instances without using [`Form`](../../lib/process-services/task-list/models/form.model.ts) Component like it was previously. +The [`FormService`](../core/services/form.service.md) got a new API to parse form definitions from JSON into the [`FormModel`](../../lib/core/form/components/widgets/core/form.model.ts) instances without using [`Form`](../../lib/process-services/task-list/models/form.model.ts) Component like it was previously. formService.parseForm(formDefinitionJSON) #### Controlling outcome actions -It is now possible to control what happens when end users click the form outcome buttons, like Save, Complete, etc. The [`FormService`](../core/form.service.md) gets a new cancellable event called "executeOutcome" for that purpose. +It is now possible to control what happens when end users click the form outcome buttons, like Save, Complete, etc. The [`FormService`](../core/services/form.service.md) gets a new cancellable event called "executeOutcome" for that purpose. export class FormDemoComponent implements OnInit { @@ -315,7 +315,7 @@ By default, all application settings are stored in the "app.config.json" file in You can get more details on application configuration in the following articles: - [Demo App Readme](../..//demo-shell/README.md#application-settings-server-side) -- [AppConfigService Readme](../core/app-config.service.md) +- [AppConfigService Readme](../core/services/app-config.service.md) ### 13. Proxy settings and CORS @@ -369,10 +369,10 @@ Below you can find a detailed list of tickets addressed in the new release. For - \[[ADF-622](https://issues.alfresco.com/jira/browse/ADF-622)] - Extend TypeScript definitions for JS-API - \[[ADF-631](https://issues.alfresco.com/jira/browse/ADF-631)] - Viewer - Should play also the mp3 file - \[[ADF-667](https://issues.alfresco.com/jira/browse/ADF-667)] - It should be possible to disable row selection in Document List -- \[[ADF-710](https://issues.alfresco.com/jira/browse/ADF-710)] - Create a [Process Attachment List component](../process-services/process-attachment-list.component.md) +- \[[ADF-710](https://issues.alfresco.com/jira/browse/ADF-710)] - Create a [Process Attachment List component](../process-services/components/process-attachment-list.component.md) - \[[ADF-712](https://issues.alfresco.com/jira/browse/ADF-712)] - Task Attachment - Provide a way to attach a new content - \[[ADF-713](https://issues.alfresco.com/jira/browse/ADF-713)] - Process Attachment - Provide a way to attach a new content -- \[[ADF-793](https://issues.alfresco.com/jira/browse/ADF-793)] - Convert to PDF the document that the [renditions service](../core/renditions.service.md) provide +- \[[ADF-793](https://issues.alfresco.com/jira/browse/ADF-793)] - Convert to PDF the document that the [renditions service](../core/services/renditions.service.md) provide - \[[ADF-804](https://issues.alfresco.com/jira/browse/ADF-804)] - Add proxy configuration in demo shell - \[[ADF-843](https://issues.alfresco.com/jira/browse/ADF-843)] - [`Form`](../../lib/process-services/task-list/models/form.model.ts) events bus - \[[ADF-845](https://issues.alfresco.com/jira/browse/ADF-845)] - Breadcrumb path personalisation @@ -411,7 +411,7 @@ Below you can find a detailed list of tickets addressed in the new release. For - \[[ADF-737](https://issues.alfresco.com/jira/browse/ADF-737)] - Analytics report - Should expose the Models - \[[ADF-739](https://issues.alfresco.com/jira/browse/ADF-739)] - Viewer within tasks and processes does not display all supported file extensions. - \[[ADF-759](https://issues.alfresco.com/jira/browse/ADF-759)] - Cannot use script.sh with node 8.0.0 and npm 5.0. -- \[[ADF-765](https://issues.alfresco.com/jira/browse/ADF-765)] - [Rating Component](../content-services/rating.component.md) is not working. +- \[[ADF-765](https://issues.alfresco.com/jira/browse/ADF-765)] - [Rating Component](../content-services/components/rating.component.md) is not working. - \[[ADF-766](https://issues.alfresco.com/jira/browse/ADF-766)] - "Remove" file option within the Attachment list is not working. - \[[ADF-779](https://issues.alfresco.com/jira/browse/ADF-779)] - Broken thumbnails are displayed in Processes Attachment list. - \[[ADF-781](https://issues.alfresco.com/jira/browse/ADF-781)] - Folder content is not uploaded if a folder with the same name already exists @@ -423,7 +423,7 @@ Below you can find a detailed list of tickets addressed in the new release. For - \[[ADF-833](https://issues.alfresco.com/jira/browse/ADF-833)] - Data table - single and double click - \[[ADF-842](https://issues.alfresco.com/jira/browse/ADF-842)] - Error is received in console log when a form is completed - \[[ADF-883](https://issues.alfresco.com/jira/browse/ADF-883)] - [`UserInfo`](../../lib/content-services/document-list/models/document-library.model.ts) - Build errors -- \[[ADF-884](https://issues.alfresco.com/jira/browse/ADF-884)] - [`FormComponent`](../core/form.component.md) - Compilation error +- \[[ADF-884](https://issues.alfresco.com/jira/browse/ADF-884)] - [`FormComponent`](../core/components/form.component.md) - Compilation error - \[[ADF-893](https://issues.alfresco.com/jira/browse/ADF-893)] - Create Attachment Task/Process - Compilation error - \[[ADF-897](https://issues.alfresco.com/jira/browse/ADF-897)] - ActivitiPeopleList - use the prexif adf - \[[ADF-906](https://issues.alfresco.com/jira/browse/ADF-906)] - data property on activiti-form component do not react on changes - 2007 Github diff --git a/docs/release-notes/RelNote170.md b/docs/release-notes/RelNote170.md index e97ff19ed2..272311d50a 100644 --- a/docs/release-notes/RelNote170.md +++ b/docs/release-notes/RelNote170.md @@ -42,7 +42,7 @@ The release can be found on GitHub at [this link.](https://github.com/Alfresco/a ## Goals for this release -In the ADF 1.7 release we've had a big focus on Content capabilities. We brought in a new design for the Document List and the Uploader. Quite a few changes has made its way in to the release, breadcrumbs now has multiple modes (drop down and normal) and has been separated from the document list. The [pagination component](../core/pagination.component.md) is now separated from the document list and has a new design too, and we've added toolbars to the document list. We will continue this effort to split up into more granular components and improve the design. +In the ADF 1.7 release we've had a big focus on Content capabilities. We brought in a new design for the Document List and the Uploader. Quite a few changes has made its way in to the release, breadcrumbs now has multiple modes (drop down and normal) and has been separated from the document list. The [pagination component](../core/components/pagination.component.md) is now separated from the document list and has a new design too, and we've added toolbars to the document list. We will continue this effort to split up into more granular components and improve the design. We have introduced a "Copy and Move" component that integrates into the document list. The idea is to use the same picker for both forms and document list, i.e use it to select content in a form, or select the destination to copy or move items into. This is still work in progress as some of the features in the picker, such as search highlight didn't make it in time for code freeze. We will continue to improve this in the next release. @@ -57,7 +57,7 @@ Below the most relevant features of this release: - ADF prefix - Copy and Move Component - Dropdown sites/favorites Component -- [Toolbar Component](../core/toolbar.component.md) +- [Toolbar Component](../core/components/toolbar.component.md) - Upload Component New design - Upload ignore list configuration service - Start Task New design @@ -66,7 +66,7 @@ Below the most relevant features of this release: - Login new property - TaskDetails - DueDate and Description editable - Configuration back end service hostname feature -- [User Preferences Service](../core/user-preferences.service.md) +- [User Preferences Service](../core/services/user-preferences.service.md) - Search results highlighting properties - Change document list style rows based on permissions - APS Audit REST API in the JS API @@ -225,7 +225,7 @@ Developers have now a possibility storing and retrieving user preferences for ei } } -The [`UserPreferencesService`](../core/user-preferences.service.md) provides an API needed to store preferences based on different profiles. You can now have multiple users on the same machine with different set of preferences (like pagination size, authentication type, etc). +The [`UserPreferencesService`](../core/services/user-preferences.service.md) provides an API needed to store preferences based on different profiles. You can now have multiple users on the same machine with different set of preferences (like pagination size, authentication type, etc). ### 14. Search results highlighting properties @@ -242,7 +242,7 @@ You can now customize the document list style row based on the permissions of th ### 16. APS Audit REST API in the JS API -Two new methods has been added into the alfresco-js-api to support retrieve the audit informations inside the [process service](../process-services/process.service.md): +Two new methods has been added into the alfresco-js-api to support retrieve the audit informations inside the [process service](../process-services/services/process.service.md): | API | Name | HTTP method | URL | Description | | --- | ---- | ----------- | --- | ----------- | @@ -256,15 +256,15 @@ For further details about those endepoints please refer to the [official documen In the ng2-alfresco-core component, there are a lot of services that you can use out of the box outside our component and you can find the complete list [here](https://github.com/Alfresco/alfresco-ng2-components/tree/master/ng2-components#services) The list below is the list of the new services added in 1.7.0: -- [`DeletedNodesApiService`](../core/deleted-nodes-api.service.md) -- [`FavoritesApiService`](../core/favorites-api.service.md) -- [`NodesApiService`](../core/nodes-api.service.md) +- [`DeletedNodesApiService`](../core/services/deleted-nodes-api.service.md) +- [`FavoritesApiService`](../core/services/favorites-api.service.md) +- [`NodesApiService`](../core/services/nodes-api.service.md) - PeopleApiService - SearchApiService -- [`SharedLinksApiService`](../core/shared-links-api.service.md) +- [`SharedLinksApiService`](../core/services/shared-links-api.service.md) - SitesApiService -- [`ThumbnailService`](../core/thumbnail.service.md) -- [`SearchService`](../core/search.service.md) +- [`ThumbnailService`](../core/services/thumbnail.service.md) +- [`SearchService`](../core/services/search.service.md) ### 18. Code Contribution Guide and CLA @@ -335,7 +335,7 @@ Release Notes - Apps Development Framework - Version 1.7. - \[[ADF-195](https://issues.alfresco.com/jira/browse/ADF-195)] - fix 'change detection crash' when using router multiple times - 1550 Github - \[[ADF-334](https://issues.alfresco.com/jira/browse/ADF-334)] - "$" symbol on a currency/amount field is shown against the label - 1707 Github -- \[[ADF-523](https://issues.alfresco.com/jira/browse/ADF-523)] - [Search Component](../content-services/search.component.md) - Unable to delete a file +- \[[ADF-523](https://issues.alfresco.com/jira/browse/ADF-523)] - [Search Component](../content-services/components/search.component.md) - Unable to delete a file - \[[ADF-733](https://issues.alfresco.com/jira/browse/ADF-733)] - Activiti start process - AppId should not be mandatory - \[[ADF-770](https://issues.alfresco.com/jira/browse/ADF-770)] - Wrong highlight is displayed around options within DocumentList. - \[[ADF-778](https://issues.alfresco.com/jira/browse/ADF-778)] - "Upload Dialog" displays files that were previously uploaded on a different account. @@ -358,11 +358,11 @@ Release Notes - Apps Development Framework - Version 1.7. - \[[ADF-1048](https://issues.alfresco.com/jira/browse/ADF-1048)] - Multiple files attached to a task within a form are not displayed - \[[ADF-1056](https://issues.alfresco.com/jira/browse/ADF-1056)] - [`Form`](../../lib/process-services/task-list/models/form.model.ts) List Component does not display the forms of the user - \[[ADF-1068](https://issues.alfresco.com/jira/browse/ADF-1068)] - Files can be uploaded using drag and drop when 'enable file' is unchecked -- \[[ADF-1070](https://issues.alfresco.com/jira/browse/ADF-1070)] - [User preferences service](../core/user-preferences.service.md) does not restore prefix on page reload. +- \[[ADF-1070](https://issues.alfresco.com/jira/browse/ADF-1070)] - [User preferences service](../core/services/user-preferences.service.md) does not restore prefix on page reload. - \[[ADF-1072](https://issues.alfresco.com/jira/browse/ADF-1072)] - Unsupported type of file attached to a task or process can not be converted to pdf - \[[ADF-1078](https://issues.alfresco.com/jira/browse/ADF-1078)] - [Tasks] - Task Details are displayed inside Task Filters list. - \[[ADF-1079](https://issues.alfresco.com/jira/browse/ADF-1079)] - [Process Services] - Not able to start a process. -- \[[ADF-1081](https://issues.alfresco.com/jira/browse/ADF-1081)] - Scroll bar is missing in [comments component](../core/comments.component.md) +- \[[ADF-1081](https://issues.alfresco.com/jira/browse/ADF-1081)] - Scroll bar is missing in [comments component](../core/components/comments.component.md) - \[[ADF-1097](https://issues.alfresco.com/jira/browse/ADF-1097)] - File with unaccepted extension is uploaded when 'Format' is set to 'All files' - \[[ADF-1134](https://issues.alfresco.com/jira/browse/ADF-1134)] - [Document List] Selection events not raised for certain scenarios - \[[ADF-1138](https://issues.alfresco.com/jira/browse/ADF-1138)] - Start Task [`Form`](../../lib/process-services/task-list/models/form.model.ts) Assignee dropdown show null value inside @@ -382,7 +382,7 @@ Release Notes - Apps Development Framework - Version 1.7. - \[[ADF-1199](https://issues.alfresco.com/jira/browse/ADF-1199)] - `MinimalNodeEntryEntity` is missing the "allowableOperations" property - \[[ADF-1200](https://issues.alfresco.com/jira/browse/ADF-1200)] - The URL validation error message is still displayed after changing the invalid url with a valid one - \[[ADF-1201](https://issues.alfresco.com/jira/browse/ADF-1201)] - 508 Compliance Resolution for the App tiles. - 2131 Github -- \[[ADF-1216](https://issues.alfresco.com/jira/browse/ADF-1216)] - The included packages are not displayed in [About Component](../core/about.component.md) if the user is logged only on Content Services +- \[[ADF-1216](https://issues.alfresco.com/jira/browse/ADF-1216)] - The included packages are not displayed in [About Component](../core/components/about.component.md) if the user is logged only on Content Services - \[[ADF-1228](https://issues.alfresco.com/jira/browse/ADF-1228)] - Task Details - The People and Involve component are not aligned - \[[ADF-1229](https://issues.alfresco.com/jira/browse/ADF-1229)] - Task Filter - Wrong task filter is selected when a new task is created @@ -390,14 +390,14 @@ Release Notes - Apps Development Framework - Version 1.7. - \[[ADF-112](https://issues.alfresco.com/jira/browse/ADF-112)] - Task Header in TaskDetails component shows DueDate but is not editable - \[[ADF-402](https://issues.alfresco.com/jira/browse/ADF-402)] - Process Diagram Widget - Show the current process state -- \[[ADF-487](https://issues.alfresco.com/jira/browse/ADF-487)] - Info tab should show [Content Service](../core/content.service.md) and [Process service](../process-services/process.service.md) information +- \[[ADF-487](https://issues.alfresco.com/jira/browse/ADF-487)] - Info tab should show [Content Service](../core/services/content.service.md) and [Process service](../process-services/services/process.service.md) information - \[[ADF-858](https://issues.alfresco.com/jira/browse/ADF-858)] - Provide ability to attach multiple files on process Form- 1988 Github - \[[ADF-917](https://issues.alfresco.com/jira/browse/ADF-917)] - Upload ignore list files configuration - \[[ADF-955](https://issues.alfresco.com/jira/browse/ADF-955)] - Custom icons for selected rows -- \[[ADF-960](https://issues.alfresco.com/jira/browse/ADF-960)] - Allow changing copyright section for [Login component](../core/login.component.md) -- \[[ADF-967](https://issues.alfresco.com/jira/browse/ADF-967)] - Evaluate "hostname" and "port" in the [app config service](../core/app-config.service.md) +- \[[ADF-960](https://issues.alfresco.com/jira/browse/ADF-960)] - Allow changing copyright section for [Login component](../core/components/login.component.md) +- \[[ADF-967](https://issues.alfresco.com/jira/browse/ADF-967)] - Evaluate "hostname" and "port" in the [app config service](../core/services/app-config.service.md) - \[[ADF-968](https://issues.alfresco.com/jira/browse/ADF-968)] - Dropdown sites and favorites -- \[[ADF-983](https://issues.alfresco.com/jira/browse/ADF-983)] - [User Preferences Service](../core/user-preferences.service.md) +- \[[ADF-983](https://issues.alfresco.com/jira/browse/ADF-983)] - [User Preferences Service](../core/services/user-preferences.service.md) - \[[ADF-1038](https://issues.alfresco.com/jira/browse/ADF-1038)] - Dropdown breadcrumbs - \[[ADF-1039](https://issues.alfresco.com/jira/browse/ADF-1039)] - Search results highlighting - \[[ADF-1040](https://issues.alfresco.com/jira/browse/ADF-1040)] - Change document list style rows based on permissions @@ -409,7 +409,7 @@ Release Notes - Apps Development Framework - Version 1.7. ### Task - \[[ADF-497](https://issues.alfresco.com/jira/browse/ADF-497)] - Improvement to task comment (activiti-comments) component - 1829 Github -- \[[ADF-506](https://issues.alfresco.com/jira/browse/ADF-506)] - Unify [thumbnail service](../core/thumbnail.service.md) across search and document list +- \[[ADF-506](https://issues.alfresco.com/jira/browse/ADF-506)] - Unify [thumbnail service](../core/services/thumbnail.service.md) across search and document list - \[[ADF-861](https://issues.alfresco.com/jira/browse/ADF-861)] - Add codelizer in ng2-alfresco-viewer ng2-alfresco-webscript - \[[ADF-862](https://issues.alfresco.com/jira/browse/ADF-862)] - Add codelizer in ng2-alfresco-login ng2-alfresco-search - \[[ADF-867](https://issues.alfresco.com/jira/browse/ADF-867)] - Add codelizer in demo-shell and genral build @@ -424,7 +424,7 @@ Release Notes - Apps Development Framework - Version 1.7. - \[[ADF-924](https://issues.alfresco.com/jira/browse/ADF-924)] - Upload Component - Import the logic/design from EFSS - \[[ADF-973](https://issues.alfresco.com/jira/browse/ADF-973)] - Remove demo projects from components folder - \[[ADF-992](https://issues.alfresco.com/jira/browse/ADF-992)] - Integrate SFS enhancements to Document List -- \[[ADF-993](https://issues.alfresco.com/jira/browse/ADF-993)] - Integrate SFS enhancements for [Toolbar component](../core/toolbar.component.md) +- \[[ADF-993](https://issues.alfresco.com/jira/browse/ADF-993)] - Integrate SFS enhancements for [Toolbar component](../core/components/toolbar.component.md) - \[[ADF-1002](https://issues.alfresco.com/jira/browse/ADF-1002)] - Attachment Task list - Add Drag and drop functionality - \[[ADF-1030](https://issues.alfresco.com/jira/browse/ADF-1030)] - Datatable - enable isLoading to show the spinner in all the components - \[[ADF-1044](https://issues.alfresco.com/jira/browse/ADF-1044)] - Activiti Comment - use the new design inside the demoshell diff --git a/docs/release-notes/RelNote180.md b/docs/release-notes/RelNote180.md index 7a1b848f3d..7c84949697 100644 --- a/docs/release-notes/RelNote180.md +++ b/docs/release-notes/RelNote180.md @@ -39,7 +39,7 @@ The release can be found on GitHub at [this link.](https://github.com/Alfresco/a ## Goals for this release -In the ADF 1.8 release we've introduced a number of new generic features, such as Info Drawer, theming capabilities and lots of form customizations and accessibility. The task list now works with the [pagination component](../core/pagination.component.md) and we have started the work to completely redesign the [viewer component](../core/viewer.component.md). +In the ADF 1.8 release we've introduced a number of new generic features, such as Info Drawer, theming capabilities and lots of form customizations and accessibility. The task list now works with the [pagination component](../core/components/pagination.component.md) and we have started the work to completely redesign the [viewer component](../core/components/viewer.component.md). We continue the effort to migrate to @angular/material, it will be a few more releases before we wrap up that work. The data table and document list continue to get new features and enhancements, with the new data sources and layout presets we open up possibilities for externalizing the layout and sources for the document list. This release builds on last month's contains bug fixes and new feature. See the list below for major details. @@ -51,7 +51,7 @@ Please report issues with this release in the [issue tracker](https://github.com Below the most relevant features of this release: - Theming ADF component -- [Info Drawer component](../core/info-drawer.component.md) +- [Info Drawer component](../core/components/info-drawer.component.md) - [`Form`](../../lib/process-services/task-list/models/form.model.ts) style component enhancements - Empty form template - Additional data sources input for Document List @@ -78,7 +78,7 @@ When you want more customization than a pre-built theme offers, you can create y ### 2. Info Drawer component -It is now possible to use the [Info Drawer component,](../core/info-drawer.component.md) which gives you a sidebar like look with tabbing support. For more information about the usage, check the documentation in the core package. +It is now possible to use the [Info Drawer component,](../core/components/info-drawer.component.md) which gives you a sidebar like look with tabbing support. For more information about the usage, check the documentation in the core package. ![](images/info-drawer.gif) @@ -105,7 +105,7 @@ New events that allow taking control over the [`Form`](../../lib/process-service validateForm: Subject validateFormField: Subject() -The [validateForm](../core/form.service.md) event is raised every time the entire [`Form`](../../lib/process-services/task-list/models/form.model.ts) is re-validated. This happens also every time a field value or some of the properties is changed (for example the "required" property). The [validateFormField](../core/form.service.md) event is raised every time a single [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field is re-validated. +The [validateForm](../core/services/form.service.md) event is raised every time the entire [`Form`](../../lib/process-services/task-list/models/form.model.ts) is re-validated. This happens also every time a field value or some of the properties is changed (for example the "required" property). The [validateFormField](../core/services/form.service.md) event is raised every time a single [`Form`](../../lib/process-services/task-list/models/form.model.ts) Field is re-validated. Both events are "cancellable", that means you can apply your own validation rules, change corresponding field validation state, or even prevent the default behaviour if needed. @@ -137,7 +137,7 @@ New "getFieldById" method to simplify certain scenarios when accessing multiple The [`Form`](../../lib/process-services/task-list/models/form.model.ts) now controls all Field validators. It becomes possible managing existing validator instances, replacing them, or extending form validation with custom rules and error messages. The "adf-form" component now also supports binding custom validator sets to the underlying [FormModel,](../../lib/core/form/components/widgets/core/form.model.ts) that allows defining validation sets in your code and binding via HTML. -You can read more details on the new Validation layer in the [`Form`](../../lib/process-services/task-list/models/form.model.ts) readme: [Form Field Validators](../core/form-field-validator.interface.md). The "demo shell" application has been also extended to demonstrate custom validators in action. You can check the code here: [Demo Field Validator](../core/form-field-validator.interface.md). +You can read more details on the new Validation layer in the [`Form`](../../lib/process-services/task-list/models/form.model.ts) readme: [Form Field Validators](../core/interfaces/form-field-validator.interface.md). The "demo shell" application has been also extended to demonstrate custom validators in action. You can check the code here: [Demo Field Validator](../core/interfaces/form-field-validator.interface.md). ### 7. DataTable Accessibility Improvements @@ -159,7 +159,7 @@ Further enhancements were implemented for the Copy & move dialog. From now, you ### 9. Download as a ZIP functionality -The ADF framework provides support for downloading nodes (Files and Folders) as "ZIP" archives. The **alfresco-js-api** library features new support for the [Downloads](https://api-explorer.alfresco.com/api-explorer/#/downloads) API. In addition, the Core library (ng2-alfresco-core) provides a ["DownloadZipDialogComponent"](../core/download-zip.service.md) that allows invoking "Download as Zip" dialogues from any place in your code. +The ADF framework provides support for downloading nodes (Files and Folders) as "ZIP" archives. The **alfresco-js-api** library features new support for the [Downloads](https://api-explorer.alfresco.com/api-explorer/#/downloads) API. In addition, the Core library (ng2-alfresco-core) provides a ["DownloadZipDialogComponent"](../core/services/download-zip.service.md) that allows invoking "Download as Zip" dialogues from any place in your code. ![](images/download-as-zip.gif) @@ -194,7 +194,7 @@ And the code behind in this case can be as follows: ### 11. Profile picture in Comments and Involved people -With the new ADF release, if the user has a profile picture, it will be shown inside the Comment/Involved [People component](../process-services/people.component.md): +With the new ADF release, if the user has a profile picture, it will be shown inside the Comment/Involved [People component](../process-services/components/people.component.md): ![involved people component with images](images/Screen+Shot+2017-09-05+at+11.31.50.png) @@ -529,7 +529,7 @@ Release Notes - Apps Development Framework - Version 1.8. - \[[ADF-1300](https://issues.alfresco.com/jira/browse/ADF-1300)] - Download as a ZIP functionality demo (5.2.1 repo) - \[[ADF-1318](https://issues.alfresco.com/jira/browse/ADF-1318)] - Create 'time ago' date converter - \[[ADF-1356](https://issues.alfresco.com/jira/browse/ADF-1356)] - Single configuration of i18n service per project -- \[[ADF-1372](https://issues.alfresco.com/jira/browse/ADF-1372)] - Provide support for custom tooltips for [Upload Button component](../content-services/upload-button.component.md) +- \[[ADF-1372](https://issues.alfresco.com/jira/browse/ADF-1372)] - Provide support for custom tooltips for [Upload Button component](../content-services/components/upload-button.component.md) - \[[ADF-1404](https://issues.alfresco.com/jira/browse/ADF-1404)] - Data Column enhancements for Document List - \[[ADF-1421](https://issues.alfresco.com/jira/browse/ADF-1421)] - Provide default column layout for Document List - \[[ADF-1427](https://issues.alfresco.com/jira/browse/ADF-1427)] - Show custom root in the breadcrumb even if node is not loaded @@ -539,13 +539,13 @@ Release Notes - Apps Development Framework - Version 1.8. ## Task - \[[ADF-1188](https://issues.alfresco.com/jira/browse/ADF-1188)] - Upload drag drop component - Add a property to disable the component -- \[[ADF-1306](https://issues.alfresco.com/jira/browse/ADF-1306)] - Process [Task Audit Directive](../process-services/task-audit.directive.md) +- \[[ADF-1306](https://issues.alfresco.com/jira/browse/ADF-1306)] - Process [Task Audit Directive](../process-services/directives/task-audit.directive.md) - \[[ADF-1309](https://issues.alfresco.com/jira/browse/ADF-1309)] - [`Pagination`](../../lib/content-services/document-list/models/document-library.model.ts) of task list - \[[ADF-714](https://issues.alfresco.com/jira/browse/ADF-714)] - Unify pagination across all components - \[[ADF-1116](https://issues.alfresco.com/jira/browse/ADF-1116)] - Task list without any status filter - \[[ADF-1139](https://issues.alfresco.com/jira/browse/ADF-1139)] - People Search - Provide a way to reset the search field when a user is selected - \[[ADF-852](https://issues.alfresco.com/jira/browse/ADF-852)] - [Form] Update [`Form`](../../lib/process-services/task-list/models/form.model.ts) widget to Material library -- \[[ADF-520](https://issues.alfresco.com/jira/browse/ADF-520)] - remove the debug button from [Analytics Component](../insights/analytics.component.md) +- \[[ADF-520](https://issues.alfresco.com/jira/browse/ADF-520)] - remove the debug button from [Analytics Component](../insights/components/analytics.component.md) - \[[ADF-157](https://issues.alfresco.com/jira/browse/ADF-157)] - upload dialog Wrong number on File Upload Count - 1511 Github - \[[ADF-569](https://issues.alfresco.com/jira/browse/ADF-569)] - Provide support to Undo uploaded files in the Upload component - \[[ADF-720](https://issues.alfresco.com/jira/browse/ADF-720)] - Review all the template use diff --git a/docs/release-notes/RelNote190.md b/docs/release-notes/RelNote190.md index b897b9a41b..6889541ad8 100644 --- a/docs/release-notes/RelNote190.md +++ b/docs/release-notes/RelNote190.md @@ -49,11 +49,11 @@ Below the most relevant features of this release: - Infinite scrolling - Requeue option added to adf-task-header - Tasklist now support multi-select -- [Page title service](../core/page-title.service.md) +- [Page title service](../core/services/page-title.service.md) - Viewer enhancements - Document List presets - Login redirect options -- [Logout directive](../core/logout.directive.md) +- [Logout directive](../core/directives/logout.directive.md) - Breadcrumb enhancements - Documentation @@ -100,7 +100,7 @@ The component also provides a new event **rowSelected** that contains all the se ### 4.Page Title Service -The 1.9.0 version features a new service ["PageTitleService"](../core/page-title.service.md) in the "ng2-alfresco-core" package. This service allows changing the title of the page (browser tab) on demand from the code. The format of the title is always "<Application Name> - <Title>" where "<Application Name>" is taken from the application configuration file: +The 1.9.0 version features a new service ["PageTitleService"](../core/services/page-title.service.md) in the "ng2-alfresco-core" package. This service allows changing the title of the page (browser tab) on demand from the code. The format of the title is always "<Application Name> - <Title>" where "<Application Name>" is taken from the application configuration file: { "application": { @@ -110,10 +110,10 @@ The 1.9.0 version features a new service ["PageTitleService"](../core/page-title ### 5.Viewer Enhancements -[Viewer component](../core/viewer.component.md) has been updated with improved UI and support for integration with Angular Router. +[Viewer component](../core/components/viewer.component.md) has been updated with improved UI and support for integration with Angular Router. The major features and improvements are: -- New [toolbar component](../core/toolbar.component.md) for all Viewer types +- New [toolbar component](../core/components/toolbar.component.md) for all Viewer types - Automatic PDF rendition fetching for various content types (".docx", ".pptx", etc.) - Floating action toolbar for the PDF viewer @@ -178,7 +178,7 @@ It is now possible to store layouts for Document List in the global application ### 7.Login redirect options -The [Login component](../core/login.component.md) provides a new **successRoute** property as a way to automatically redirect the user to the particular application route upon successful sign in. +The [Login component](../core/components/login.component.md) provides a new **successRoute** property as a way to automatically redirect the user to the particular application route upon successful sign in. @@ -190,7 +190,7 @@ You can turn any clickable HTML element or other Angular Component into a Logout ### 9.Breadcrumb enhancements -The [Breadcrumb component](../content-services/breadcrumb.component.md) exposes a new **rootId** property to allow you restricting the root element to a particular node. Component automatically trims the elements if full node path needs to be cut. You can use this together with the **root** property that allows renaming the root (first) element of the path. +The [Breadcrumb component](../content-services/components/breadcrumb.component.md) exposes a new **rootId** property to allow you restricting the root element to a particular node. Component automatically trims the elements if full node path needs to be cut. You can use this together with the **root** property that allows renaming the root (first) element of the path. @@ -261,7 +261,7 @@ Release Notes - Apps Development Framework - Version 1.9. - \[[ADF-1521](https://issues.alfresco.com/jira/browse/ADF-1521)] - Display value fields configured with process variables are not rendered in ADF 1.8. - \[[ADF-1523](https://issues.alfresco.com/jira/browse/ADF-1523)] - APS task form remains disabled when no custom outcome is provided in ADF 1.8. - \[[ADF-1525](https://issues.alfresco.com/jira/browse/ADF-1525)] - In APS forms, hyperlink fields are not rendered when configured with process variables -- \[[ADF-1526](https://issues.alfresco.com/jira/browse/ADF-1526)] - The [form component](../core/form.component.md) is not responsive in ADF 1.8. +- \[[ADF-1526](https://issues.alfresco.com/jira/browse/ADF-1526)] - The [form component](../core/components/form.component.md) is not responsive in ADF 1.8. - \[[ADF-1528](https://issues.alfresco.com/jira/browse/ADF-1528)] - [`Form`](../../lib/process-services/task-list/models/form.model.ts) renderer does not display generated documents - github 2303 - \[[ADF-1529](https://issues.alfresco.com/jira/browse/ADF-1529)] - Broken styles for toolbar buttons. - \[[ADF-1530](https://issues.alfresco.com/jira/browse/ADF-1530)] - [Viewer] Extension viewer doens't work anymore @@ -317,7 +317,7 @@ Release Notes - Apps Development Framework - Version 1.9. - \[[ADF-1643](https://issues.alfresco.com/jira/browse/ADF-1643)] - [Checklist] add checklist produce a consolo error - \[[ADF-1644](https://issues.alfresco.com/jira/browse/ADF-1644)] - Search Icon is not properly displayed - \[[ADF-1646](https://issues.alfresco.com/jira/browse/ADF-1646)] - [Settings] prefix icon is not aligned -- \[[ADF-1651](https://issues.alfresco.com/jira/browse/ADF-1651)] - Site List drop down from [Document List component](../content-services/document-list.component.md) does not display all sites +- \[[ADF-1651](https://issues.alfresco.com/jira/browse/ADF-1651)] - Site List drop down from [Document List component](../content-services/components/document-list.component.md) does not display all sites - \[[ADF-1653](https://issues.alfresco.com/jira/browse/ADF-1653)] - Suggestion list on people widget is still displayed after deleting all letters inside the input - \[[ADF-1654](https://issues.alfresco.com/jira/browse/ADF-1654)] - Cannot add a checklist within a task. - \[[ADF-1662](https://issues.alfresco.com/jira/browse/ADF-1662)] - [User info] name is not centered @@ -339,7 +339,7 @@ Release Notes - Apps Development Framework - Version 1.9. - \[[ADF-1477](https://issues.alfresco.com/jira/browse/ADF-1477)] - Automatic i18n support for breadcrumb root element - \[[ADF-1522](https://issues.alfresco.com/jira/browse/ADF-1522)] - Load Document List presets from the app.config file - \[[ADF-1524](https://issues.alfresco.com/jira/browse/ADF-1524)] - Provide support for route to redirect on successful Login -- \[[ADF-1613](https://issues.alfresco.com/jira/browse/ADF-1613)] - [Logout directive](../core/logout.directive.md) +- \[[ADF-1613](https://issues.alfresco.com/jira/browse/ADF-1613)] - [Logout directive](../core/directives/logout.directive.md) ## Task @@ -350,7 +350,7 @@ Release Notes - Apps Development Framework - Version 1.9. - \[[ADF-1249](https://issues.alfresco.com/jira/browse/ADF-1249)] - Remove mdl from ng2-activiti-diagrams - \[[ADF-1250](https://issues.alfresco.com/jira/browse/ADF-1250)] - Remove mdl from ng2-activiti-analytics - \[[ADF-1251](https://issues.alfresco.com/jira/browse/ADF-1251)] - Remove mdl from demo shell -- \[[ADF-1492](https://issues.alfresco.com/jira/browse/ADF-1492)] - Document List - Export [`ContentNodeSelectorComponent`](../content-services/content-node-selector.component.md) and [ContentNodeSelectorComponentData](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) +- \[[ADF-1492](https://issues.alfresco.com/jira/browse/ADF-1492)] - Document List - Export [`ContentNodeSelectorComponent`](../content-services/components/content-node-selector.component.md) and [ContentNodeSelectorComponentData](../../lib/content-services/content-node-selector/content-node-selector.component-data.interface.ts) - \[[ADF-1496](https://issues.alfresco.com/jira/browse/ADF-1496)] - Remove "Disable upload button when user has no permissions" switch. - \[[ADF-1504](https://issues.alfresco.com/jira/browse/ADF-1504)] - Rename UserInfoComponentModule to [`UserInfoModule`](../../lib/core/userinfo/userinfo.module.ts) - \[[ADF-1515](https://issues.alfresco.com/jira/browse/ADF-1515)] - Internationalization - ADF strings review diff --git a/docs/release-notes/RelNote200.md b/docs/release-notes/RelNote200.md index 2e90cbb1d1..26ba665fe2 100644 --- a/docs/release-notes/RelNote200.md +++ b/docs/release-notes/RelNote200.md @@ -66,7 +66,7 @@ Please note the only major version valid for the package @alfresco/adf-insights ## Goals for this release -While this release had a high focus on stabilization and bug fixes, we have also introduced new and enhanced features. These include a completely revamped [Viewer component,](../core/viewer.component.md) a new metadata component and file versioning. Also, ADF is now localized into 11 different languages. In total we have closed around 242 issues in JIRA. +While this release had a high focus on stabilization and bug fixes, we have also introduced new and enhanced features. These include a completely revamped [Viewer component,](../core/components/viewer.component.md) a new metadata component and file versioning. Also, ADF is now localized into 11 different languages. In total we have closed around 242 issues in JIRA. Since we follow [SEMVER](https://semver.org), we can only introduce breaking changes in major releases. We learned a lot and we needed to restructure and rename components to make things easier moving forward. You can see all the details about the breaking changes below. We have continued to expand and rewrite our documentation. We now have a new component catalog @@ -88,22 +88,22 @@ Below the most relevant features of this release: - Create Folder and Edit Folder dialogues - Editable file metadata - File versioning -- [Search Component](../content-services/search.component.md) refatoring +- [Search Component](../content-services/components/search.component.md) refatoring - Max file size constraints properties in Upload Button - Register Alfresco file type icons within the mat-icon -- [`LogService`](../core/log.service.md) configuration +- [`LogService`](../core/services/log.service.md) configuration - Favorite node Directive - Delete multiple nodes directive - Task Attachment list customizable template - CS and PS setting host component -- Complete [process service](../process-services/process.service.md) type definition in the alfresco-js-api +- Complete [process service](../process-services/services/process.service.md) type definition in the alfresco-js-api - Redirect to original path upon successful login - Task List override the default columns - Internationalization support ### 1. Viewer Enhancements -The [Viewer component](../core/viewer.component.md) has been enhanced with the following features: +The [Viewer component](../core/components/viewer.component.md) has been enhanced with the following features: - Automatic PDF renditions for APS content - Automatic PDF renditions for ACS content @@ -115,16 +115,16 @@ The [Viewer component](../core/viewer.component.md) has been enhanced with the f - Custom "traffic light" menu that you can fill with your own content - Ability to download the file previewed - Ability to hide/show any button on the toolbar -- Ability to hide, show or even replace entire [toolbar component](../core/toolbar.component.md) +- Ability to hide, show or even replace entire [toolbar component](../core/components/toolbar.component.md) ![](images/pastedImage_1.png) -It is now very simple to use the [Viewer component](../core/viewer.component.md) in an "Inline" mode on a separate page when using the Angular Router. +It is now very simple to use the [Viewer component](../core/components/viewer.component.md) in an "Inline" mode on a separate page when using the Angular Router. This allows you to have separate URLs for previewing content and later revisiting a file by navigating to a corresponding link. In addition, the "Overlay" mode has been stabilised. It now handles subsequent reopenings correctly. -You can find more details in the corresponding documentation: [Viewer Component](../core/viewer.component.md). +You can find more details in the corresponding documentation: [Viewer Component](../core/components/viewer.component.md). ### 2. Pagination Component and DocumentList integration @@ -137,7 +137,7 @@ ADF provides a lightweight integration with the DocumentList component out of th -For more details on custom pagination features see the following article: [Pagination Component](../core/pagination.component.md) +For more details on custom pagination features see the following article: [Pagination Component](../core/components/pagination.component.md) ### 3. Create Folder and Edit Folder dialogs @@ -158,8 +158,8 @@ In order to greatly simplify your development experience, two extra Angular dire For more details please refer to: -- [Folder Create directive](../content-services/folder-create.directive.md) -- [Folder Edit directive](../content-services/folder-edit.directive.md) +- [Folder Create directive](../content-services/directives/folder-create.directive.md) +- [Folder Edit directive](../content-services/directives/folder-edit.directive.md) ### 4. Editable file metadata @@ -179,7 +179,7 @@ You can now see and restore previous versions of a file node. This component can ### 6. Search Component refactoring -We have completely separated the documentlist component from the [search component](../content-services/search.component.md). We also support customizing the search result with any template you like and optionally creating your own custom search autocomplete. +We have completely separated the documentlist component from the [search component](../content-services/components/search.component.md). We also support customizing the search result with any template you like and optionally creating your own custom search autocomplete. The adf-search-control provides you with a standard input search with an pre-styled autocomplete table : @@ -219,16 +219,16 @@ This allows you to fetch the search result typed from the input/textarea element For more details please refer to: -- [Search Control Component](../content-services/search-control.component.md) -- [Search Component](../content-services/search.component.md) +- [Search Control Component](../content-services/components/search-control.component.md) +- [Search Component](../content-services/components/search.component.md) ### 7. Max file size constraints properties in Upload Button -The [upload button component](../content-services/upload-button.component.md) now provides a new parameter to disallow uploading files larger than a certain size (in bytes): +The [upload button component](../content-services/components/upload-button.component.md) now provides a new parameter to disallow uploading files larger than a certain size (in bytes): -For more details please refer to [Upload button documentation](../content-services/upload-button.component.md) +For more details please refer to [Upload button documentation](../content-services/components/upload-button.component.md) ### 8. Register Alfresco file type icons within the mat-icon @@ -241,7 +241,7 @@ All the ADF MIME type icons are now registered into the [MatIconRegistry](https: constructor(public thumbnailService: ThumbnailService) { } -To see the list of all supported MIME types please refer to [Thumbnail service documentation](../core/thumbnail.service.md). +To see the list of all supported MIME types please refer to [Thumbnail service documentation](../core/services/thumbnail.service.md). ### 9. LogService configuration @@ -252,11 +252,11 @@ By default the level is TRACE. If you want to silence all log output in ADF you "logLevel": " SILENT" } -The [log service](../core/log.service.md) provides 6 level of logs: TRACE, DEBUG, INFO, WARN, ERROR, SILENT. For more information please refer to [log service documentation.](../core/log.service.md) +The [log service](../core/services/log.service.md) provides 6 level of logs: TRACE, DEBUG, INFO, WARN, ERROR, SILENT. For more information please refer to [log service documentation.](../core/services/log.service.md) ### 10. Favorite node directive -The [NodeFavoriteDirective](../core/node-favorite.directive.md) instance can be bound to a button to retrieve and manage a favorites node list: +The [NodeFavoriteDirective](../core/directives/node-favorite.directive.md) instance can be bound to a button to retrieve and manage a favorites node list: