From 3734151338e8d6a4229c6d76d4eb689b48296481 Mon Sep 17 00:00:00 2001 From: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com> Date: Fri, 11 Dec 2020 16:37:49 +0000 Subject: [PATCH] Remove escaped characters (#6451) --- docs/core/components/sidenav-layout.component.md | 2 +- docs/core/directives/highlight.directive.md | 4 ++-- docs/core/services/content.service.md | 4 ++-- .../core/services/highlight-transform.service.md | 4 ++-- docs/core/services/sites.service.md | 16 ++++++++-------- docs/core/services/thumbnail.service.md | 2 +- .../process-attachment-list.component.md | 2 +- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/core/components/sidenav-layout.component.md b/docs/core/components/sidenav-layout.component.md index 4ce3c00943..6d3f8420ac 100644 --- a/docs/core/components/sidenav-layout.component.md +++ b/docs/core/components/sidenav-layout.component.md @@ -126,7 +126,7 @@ Beside the template context's **isMenuMinimized** variable, another way to liste | Name | Type | Default | Description | | -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- | -| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)\ | true | Another way to listen to menu open/closed state | +| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)<boolean> | true | Another way to listen to menu open/closed state | Every time the menu state is changed, the following values are emitted: diff --git a/docs/core/directives/highlight.directive.md b/docs/core/directives/highlight.directive.md index 331c7ea354..128f1e6636 100644 --- a/docs/core/directives/highlight.directive.md +++ b/docs/core/directives/highlight.directive.md @@ -52,8 +52,8 @@ If the search string contain spaces then each section between the spaces will be treated as a separate item to highlight. For example, you could use this to highlight all occurrences of words in a list. -The highlighting works by adding an HTML \ element around the -selected text. The \ includes a CSS class; this defaults to +The highlighting works by adding an HTML <span> element around the +selected text. The <span> includes a CSS class; this defaults to "adf-highlight" but you can supply your own class using the `adf-highlight-class` property: diff --git a/docs/core/services/content.service.md b/docs/core/services/content.service.md index c06b6ecc93..0dec622430 100644 --- a/docs/core/services/content.service.md +++ b/docs/core/services/content.service.md @@ -73,7 +73,7 @@ some cases by viewing it directly in the browser via a special URL that referenc the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob). For example, you could use the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) interface to construct an image in the [PNG format](https://en.wikipedia.org/wiki/Portable_Network_Graphics). Since PNG is a format the browser can display, you could use the [Blob's](https://developer.mozilla.org/en-US/docs/Web/API/Blob) URL in an -\ element to view the image within the page. Alternatively, you could let +<img> element to view the image within the page. Alternatively, you could let the user download it as a PNG file. The `downloadBlob` method starts a download of the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) data to the `filename` @@ -85,7 +85,7 @@ for details of how a [Blob's](https://developer.mozilla.org/en-US/docs/Web/API/B Use `createdTrustedUrl` to generate a URL string for a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob). The URL refers to the [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) as though it were a file but it is actually an object stored in memory, so it does not persist across browser sessions. This URL can be used much like any -other, so you could use it for the `src` attribute of an \ element or the +other, so you could use it for the `src` attribute of an <img> element or the `href` of a download link. Note that while the URL is 'trusted', the data it contains is not necessarily trustworthy unless you can vouch for it yourself; be careful that the data doesn't expose your app to diff --git a/docs/core/services/highlight-transform.service.md b/docs/core/services/highlight-transform.service.md index 78b93f0cb0..d49de0a940 100644 --- a/docs/core/services/highlight-transform.service.md +++ b/docs/core/services/highlight-transform.service.md @@ -26,10 +26,10 @@ A typical use case for this service is to display the results from a search engi An excerpt of a retrieved document can be shown with the matching search terms highlighted to indicate where they were found. -The service works by adding HTML \ elements around all sections of text +The service works by adding HTML <span> elements around all sections of text that match the `search` string. You can specify multiple search strings at once by separating them with spaces, so passing "Apple Banana Cherry" in `search` will -highlight any of those words individually. The \ element includes a +highlight any of those words individually. The <span> element includes a `class` attribute which defaults to "highlight" but you can pass any class name you like using the `wrapperClass` parameter. diff --git a/docs/core/services/sites.service.md b/docs/core/services/sites.service.md index 4ce1a51d7d..f00733631d 100644 --- a/docs/core/services/sites.service.md +++ b/docs/core/services/sites.service.md @@ -23,13 +23,13 @@ Accesses and manipulates sites from a Content Services repository. Create a site membership for group * *siteId:* `string` - The identifier of a site. * *siteMembershipBodyCreate:* [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md) - The Group to add and its role - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable<SiteGroupEntry> * **createSiteMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>`
Creates a site membership for person **personId** on site **siteId**. * *siteId:* `string` - The identifier of a site * *siteMembershipBodyCreate:* [`SiteMembershipBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyCreate.md) - The person to add and their role * *opts:* `any` - (Optional) Optional parameters - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - Observable<SiteMemberEntry> * **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a site. * *siteId:* `string` - Site to delete @@ -39,7 +39,7 @@ Accesses and manipulates sites from a Content Services repository. Delete a group membership for site * *siteId:* `string` - The identifier of a site. * *groupId:* `string` - The authorityId of a group. - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Observable<void> * **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Delete a site membership * *siteId:* `string` - The identifier of a site. @@ -61,7 +61,7 @@ Accesses and manipulates sites from a Content Services repository. Get information about site membership of group * *siteId:* `string` - The identifier of a site. * *groupId:* `string` - The authorityId of a group. - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable<SiteGroupEntry> * **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|Function>`
Gets a list of all a site's members. * *siteId:* `string` - ID of the target site @@ -82,12 +82,12 @@ Accesses and manipulates sites from a Content Services repository. List group membership for site * *siteId:* `string` - The identifier of a site. * *opts:* `any` - (Optional) Options supported by JS-API - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - Observable<SiteGroupPaging> * **listSiteMemberships**(siteId: `string`, opts: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`
Gets a list of all a site's members. * *siteId:* `string` - ID of the target site * *opts:* `any` - Optional parameters supported by JS-API - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - Observable<SiteMemberPaging> * **rejectSiteMembershipRequest**(siteId: `string`, inviteeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipRequestWithPersonPaging.md)`>`
Reject site membership requests. * *siteId:* `string` - The identifier of a site. @@ -99,14 +99,14 @@ Accesses and manipulates sites from a Content Services repository. * *siteId:* `string` - The identifier of a site. * *groupId:* `string` - The authorityId of a group. * *siteMembershipBodyUpdate:* [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md) - The group new role - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteGroupEntry.md)`>` - Observable<SiteGroupEntry> * **updateSiteMembership**(siteId: `string`, personId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>`
Update a site membership * *siteId:* `string` - The identifier of a site. * *personId:* `string` - The identifier of a person. * *siteMembershipBodyUpdate:* [`SiteMembershipBodyUpdate`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMembershipBodyUpdate.md) - The persons new role * *opts:* `any` - (Optional) Optional parameters - * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - Observable\ + * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberEntry.md)`>` - Observable<SiteMemberEntry> ## Details diff --git a/docs/core/services/thumbnail.service.md b/docs/core/services/thumbnail.service.md index 2f2aa71081..4b1a905bd7 100644 --- a/docs/core/services/thumbnail.service.md +++ b/docs/core/services/thumbnail.service.md @@ -53,7 +53,7 @@ and icons is shown in the table below: ### Mat-icon All the ADF icons for MIME types are now registered into the [`MatIconRegistry`](https://material.angular.io/components/icon/api), so you can use all -the icons via the \ tag: +the icons via the <mat-icon> tag: ```javascript import { ThumbnailService } from '@alfresco/adf-core'; diff --git a/docs/process-services/components/process-attachment-list.component.md b/docs/process-services/components/process-attachment-list.component.md index 0bea774e95..6bc294953d 100644 --- a/docs/process-services/components/process-attachment-list.component.md +++ b/docs/process-services/components/process-attachment-list.component.md @@ -78,7 +78,7 @@ A default template will be used if you don't supply a custom one to override it: You can wrap the attachment list with an [Upload Drag Area component](../../content-services/components/upload-drag-area.component.md) to let the user upload attachments to empty lists. When you do this, you can also supply -a custom *no content template* (using \) to invite the user to add their attachments: +a custom *no content template* (using <adf-empty-list>) to invite the user to add their attachments: