Documentation build (#6762)

* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
2025-07-24 17:32:15 +00:00 · 2021-03-03 14:08:15 +00:00
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
--- a/docs/core/directives/check-allowable-operation.directive.md
+++ b/docs/core/directives/check-allowable-operation.directive.md
@@ -11,14 +11,14 @@ Selectively disables an HTML element or Angular component.

 ## Contents

-*   [Basic Usage](#basic-usage)
-*   [Class members](#class-members)
-    *   [Properties](#properties)
-*   [Details](#details)
-    *   [HTML element example](#html-element-example)
-    *   [Angular component example](#angular-component-example)
-    *   [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface)
-    *   [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component)
+-   [Basic Usage](#basic-usage)
+-   [Class members](#class-members)
+    -   [Properties](#properties)
+-   [Details](#details)
+    -   [HTML element example](#html-element-example)
+    -   [Angular component example](#angular-component-example)
+    -   [Implementing the NodeAllowableOperationSubject interface](#implementing-the-nodeallowableoperationsubject-interface)
+    -   [Defining your component as an EXTENDIBLE_COMPONENT parent component](#defining-your-component-as-an-extendible_component-parent-component)

 ## Basic Usage

@@ -41,7 +41,7 @@ Selectively disables an HTML element or Angular component.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Nodes to check permission for. |
 | permission | `string` | null | Node permission to check (create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions). |

@@ -52,8 +52,8 @@ by taking a collection of [`NodeEntry`](https://github.com/Alfresco/alfresco-js-

 The decorated element will be disabled if:

-*   there are no nodes in the collection
-*   at least one of the nodes does not have the required permission
+-   there are no nodes in the collection
+-   at least one of the nodes does not have the required permission

 ### HTML element example

--- a/docs/core/directives/clipboard.directive.md
+++ b/docs/core/directives/clipboard.directive.md
@@ -26,10 +26,10 @@ Copies text to the clipboard.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | message | `string` |  | Translation key or message for snackbar notification. |
 | placeholder | `string` |  | Translation key or message for the tooltip. |
-| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)`  \|  `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) |  | Reference to the HTML element containing the text to copy. |
+| target | [`HTMLInputElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)` \| `[`HTMLTextAreaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextAreaElement) |  | Reference to the HTML element containing the text to copy. |

 ## Details

@@ -42,4 +42,4 @@ the user hovers the mouse over the element. You can also provide a snackbar mess

 ## See also

-*   [Clipboard service](../../core/services/clipboard.service.md)
+-   [Clipboard service](../../core/services/clipboard.service.md)
--- a/docs/core/directives/context-menu.directive.md
+++ b/docs/core/directives/context-menu.directive.md
@@ -48,7 +48,7 @@ export class MyComponent implements OnInit {
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | enabled | `boolean` | false | Is the menu enabled? |
 | links | `any[]` |  | Items for the menu. |

--- a/docs/core/directives/highlight.directive.md
+++ b/docs/core/directives/highlight.directive.md
@@ -26,7 +26,7 @@ Adds highlighting to selected sections of an HTML element's content.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | classToApply | `string` | "adf-highlight" | CSS class used to apply highlighting. |
 | search | `string` | "" | Text to highlight. |
 | selector | `string` | "" | Class selector for highlightable elements. |
@@ -70,5 +70,5 @@ property:

 ## See also

-*   [Text highlight pipe](../pipes/text-highlight.pipe.md)
-*   [Highlight transform service](../services/highlight-transform.service.md)
+-   [Text highlight pipe](../pipes/text-highlight.pipe.md)
+-   [Highlight transform service](../services/highlight-transform.service.md)
--- a/docs/core/directives/infinite-select-scroll.directive.md
+++ b/docs/core/directives/infinite-select-scroll.directive.md
@@ -26,5 +26,5 @@ Load more options to select component if API returns more items
 ### Events

 | Name | Type | Description |
-| --- | --- | --- |
-| scrollEnd | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`Event`](https://developer.mozilla.org/en-US/docs/Web/API/Event)`>` | Emitted when scroll reaches the last item. |
+| ---- | ---- | ----------- |
+| scrollEnd | `any` | Emitted when scroll reaches the last item. |
--- a/docs/core/directives/logout.directive.md
+++ b/docs/core/directives/logout.directive.md
@@ -20,9 +20,9 @@ Logs the user out when the decorated element is clicked.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | enableRedirect | `boolean` | true | Enable redirecting after logout |
-| redirectUri | `string` | "/login" | URI to redirect to after logging out. |
+| redirectUri | `string` |  | URI to redirect to after logging out. |

 ## Kerberos

@@ -34,4 +34,4 @@ See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructi

 ## See also

-*   [Login component](../components/login.component.md)
+-   [Login component](../components/login.component.md)
--- a/docs/core/directives/node-delete.directive.md
+++ b/docs/core/directives/node-delete.directive.md
@@ -29,14 +29,14 @@ Deletes multiple files and folders.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash |
 | selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` |  | Array of nodes to delete. |

 ### Events

 | Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
 | delete | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the nodes have been deleted. |

 ## Details
@@ -46,4 +46,4 @@ this action will delete the file permanently.

 ## See also

-*   [Node Restore directive](node-restore.directive.md)
+-   [Node Restore directive](node-restore.directive.md)
--- a/docs/core/directives/node-download.directive.md
+++ b/docs/core/directives/node-download.directive.md
@@ -30,6 +30,6 @@ Allows folders and/or files to be downloaded, with multiple nodes packed as a '.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
-| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`  \|  `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` |  | Nodes to download. |
-| version | `VersionEntry` |  | Node's version to download. |
+| ---- | ---- | ------------- | ----------- |
+| nodes | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)` \| `[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` |  | Nodes to download. |
+| version | [`VersionEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/VersionEntry.md) |  | Node's version to download. |
--- a/docs/core/directives/node-favorite.directive.md
+++ b/docs/core/directives/node-favorite.directive.md
@@ -42,13 +42,13 @@ export class MyComponent {
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. |

 ### Events

 | Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
 | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting fails. |
 | toggle | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the favorite setting is complete. |

@@ -75,9 +75,9 @@ which also lets you add extra styling to the element:

 The directive behaves as follows:

-*   If there are no favorite nodes in the selection, then all are marked as favorites
-*   If there are one or more favorite nodes in the selection, then only those that are not
+-   If there are no favorite nodes in the selection, then all are marked as favorites
+-   If there are one or more favorite nodes in the selection, then only those that are not
    favorites are marked
-*   If all nodes in the selection are favorites, then they all have their favorite status removed
+-   If all nodes in the selection are favorites, then they all have their favorite status removed

 See the **Demo Shell** for examples of usage.
--- a/docs/core/directives/node-restore.directive.md
+++ b/docs/core/directives/node-restore.directive.md
@@ -49,13 +49,13 @@ Restores deleted nodes to their original location.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | selection | [`DeletedNodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/DeletedNodeEntry.md)`[]` |  | Array of deleted nodes to restore. |

 ### Events

 | Name | Type | Description |
-| --- | --- | --- |
+| ---- | ---- | ----------- |
 | restore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`RestoreMessageModel`](../../../lib/core/directives/node-restore.directive.ts)`>` | Emitted when restoration is complete. |

 ## Details
@@ -69,4 +69,4 @@ been restored. The property specifies the route path where the list of nodes are

 ## See Also

-*   [Node delete directive](node-delete.directive.md)
+-   [Node delete directive](node-delete.directive.md)
--- a/docs/core/directives/upload.directive.md
+++ b/docs/core/directives/upload.directive.md
@@ -22,12 +22,12 @@ Uploads content in response to file drag and drop.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | accept | `string` |  | (Click mode only) MIME type filter for files to accept. |
 | data | `any` |  | Data to upload. |
 | directory | `boolean` |  | (Click mode only) Toggles uploading of directories. |
 | enabled | `boolean` | true | Enables/disables uploading. |
-| mode | `string[]` | \['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. |
+| mode | `string[]` | ['drop'] | Upload mode. Can be "drop" (receives dropped files) or "click" (clicking opens a file dialog). Both modes can be active at once. |
 | multiple | `boolean` |  | Toggles multiple file uploads. |

 ## Details
@@ -65,8 +65,8 @@ value or expression:

 The [Upload directive](upload.directive.md) supports two modes:

-*   **drop** mode, where the decorated element acts like a drop zone for files (enabled by default)
-*   **click** mode, where the decorated element invokes a file dialog to select files or folders.
+-   **drop** mode, where the decorated element acts like a drop zone for files (enabled by default)
+-   **click** mode, where the decorated element invokes a file dialog to select files or folders.

 You can also use both modes together:

@@ -80,9 +80,9 @@ You can also use both modes together:

 In click mode you can provide extra attributes for the file dialog:

-*   **directory**, enables directory selection
-*   **multiple**, enables multiple file/folder selection
-*   **accept**, filters the content accepted
+-   **directory**, enables directory selection
+-   **multiple**, enables multiple file/folder selection
+-   **accept**, filters the content accepted

 ```html
 <div style="width: 50px; height: 50px; background-color: brown"
--- a/docs/core/directives/version-compatibility.directive.md
+++ b/docs/core/directives/version-compatibility.directive.md
@@ -22,7 +22,7 @@ Enables/disables components based on ACS version in use.
 ### Properties

 | Name | Type | Default value | Description |
-| --- | --- | --- | --- |
+| ---- | ---- | ------------- | ----------- |
 | version | `void` |  | Minimum version required for component to work correctly . |

 ## Details