inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove escaped characters (#6451)

Browse Source
This commit is contained in:
Mark Hulbert
2020-12-11 16:37:49 +00:00
committed by GitHub
parent b405da8312
commit 3734151338
7 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/core/components/sidenav-layout.component.md
View File

@@ -126,7 +126,7 @@ Beside the template context's **isMenuMinimized** variable, another way to liste
| Name | Type | Default | Description | | Name | Type | Default | Description |
| -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- | | -------------- | ----------------------------------------------------------------------------- | ------- | ----------------------------------------------- |
| menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)\<boolean> | true | Another way to listen to menu open/closed state | | menuOpenState$ | [`Observable`](http://reactivex.io/documentation/observable.html)&lt;boolean> | true | Another way to listen to menu open/closed state |
Every time the menu state is changed, the following values are emitted: Every time the menu state is changed, the following values are emitted:

4
docs/core/directives/highlight.directive.md
View File

@@ -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 be treated as a separate item to highlight. For example, you could use this to
highlight all occurrences of words in a list. highlight all occurrences of words in a list.
The highlighting works by adding an HTML \<span> element around the The highlighting works by adding an HTML &lt;span> element around the
selected text. The \<span> includes a CSS class; this defaults to selected text. The &lt;span> includes a CSS class; this defaults to
"adf-highlight" but you can supply your own class using the `adf-highlight-class` "adf-highlight" but you can supply your own class using the `adf-highlight-class`
property: property:

4
docs/core/services/content.service.md
View File

@@ -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 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 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 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
\<img> element to view the image within the page. Alternatively, you could let &lt;img> element to view the image within the page. Alternatively, you could let
the user download it as a PNG file. 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` 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 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, 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 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 \<img> element or the other, so you could use it for the `src` attribute of an &lt;img> element or the
`href` of a download link. Note that while the URL is 'trusted', the data it contains `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 is not necessarily trustworthy unless you can vouch for it yourself; be careful that
the data doesn't expose your app to the data doesn't expose your app to

4
docs/core/services/highlight-transform.service.md
View File

@@ -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 An excerpt of a retrieved document can be shown with the matching search terms
highlighted to indicate where they were found. highlighted to indicate where they were found.
The service works by adding HTML \<span> elements around all sections of text The service works by adding HTML &lt;span> elements around all sections of text
that match the `search` string. You can specify multiple search strings at once by 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 separating them with spaces, so passing "Apple Banana Cherry" in `search` will
highlight any of those words individually. The \<span> element includes a highlight any of those words individually. The &lt;span> element includes a
`class` attribute which defaults to "highlight" but you can pass any class name `class` attribute which defaults to "highlight" but you can pass any class name
you like using the `wrapperClass` parameter. you like using the `wrapperClass` parameter.

16
docs/core/services/sites.service.md
View File

@@ -23,13 +23,13 @@ Accesses and manipulates sites from a Content Services repository.
Create a site membership for group Create a site membership for group
* *siteId:* `string` - The identifier of a site. * *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 * *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\<SiteGroupEntry> * **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&lt;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)`>`<br/> * **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)`>`<br/>
Creates a site membership for person **personId** on site **siteId**. Creates a site membership for person **personId** on site **siteId**.
* *siteId:* `string` - The identifier of a site * *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 * *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 * *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\<SiteMemberEntry> * **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&lt;SiteMemberEntry>
* **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> * **deleteSite**(siteId: `string`, permanentFlag: `boolean` = `true`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes a site. Deletes a site.
* *siteId:* `string` - Site to delete * *siteId:* `string` - Site to delete
@@ -39,7 +39,7 @@ Accesses and manipulates sites from a Content Services repository.
Delete a group membership for site Delete a group membership for site
* *siteId:* `string` - The identifier of a site. * *siteId:* `string` - The identifier of a site.
* *groupId:* `string` - The authorityId of a group. * *groupId:* `string` - The authorityId of a group.
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Observable\<void> * **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` - Observable&lt;void>
* **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/> * **deleteSiteMembership**(siteId: `string`, personId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
Delete a site membership Delete a site membership
* *siteId:* `string` - The identifier of a site. * *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 Get information about site membership of group
* *siteId:* `string` - The identifier of a site. * *siteId:* `string` - The identifier of a site.
* *groupId:* `string` - The authorityId of a group. * *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\<SiteGroupEntry> * **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&lt;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>`<br/> * **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>`<br/>
Gets a list of all a site's members. Gets a list of all a site's members.
* *siteId:* `string` - ID of the target site * *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 List group membership for site
* *siteId:* `string` - The identifier of a site. * *siteId:* `string` - The identifier of a site.
* *opts:* `any` - (Optional) Options supported by JS-API * *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\<SiteGroupPaging> * **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&lt;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)`>`<br/> * **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)`>`<br/>
Gets a list of all a site's members. Gets a list of all a site's members.
* *siteId:* `string` - ID of the target site * *siteId:* `string` - ID of the target site
* *opts:* `any` - Optional parameters supported by JS-API * *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\<SiteMemberPaging> * **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&lt;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)`>`<br/> * **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)`>`<br/>
Reject site membership requests. Reject site membership requests.
* *siteId:* `string` - The identifier of a site. * *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. * *siteId:* `string` - The identifier of a site.
* *groupId:* `string` - The authorityId of a group. * *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 * *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\<SiteGroupEntry> * **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&lt;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)`>`<br/> * **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)`>`<br/>
Update a site membership Update a site membership
* *siteId:* `string` - The identifier of a site. * *siteId:* `string` - The identifier of a site.
* *personId:* `string` - The identifier of a person. * *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 * *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 * *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\<SiteMemberEntry> * **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&lt;SiteMemberEntry>
## Details ## Details

2
docs/core/services/thumbnail.service.md
View File

@@ -53,7 +53,7 @@ and icons is shown in the table below:
### Mat-icon ### 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 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 \<mat-icon> tag: the icons via the &lt;mat-icon> tag:
```javascript ```javascript
import { ThumbnailService } from '@alfresco/adf-core'; import { ThumbnailService } from '@alfresco/adf-core';

2
docs/process-services/components/process-attachment-list.component.md
View File

@@ -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 You can wrap the attachment list with an
[Upload Drag Area component](../../content-services/components/upload-drag-area.component.md) [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 to let the user upload attachments to empty lists. When you do this, you can also supply
a custom *no content template* (using \<adf-empty-list>) to invite the user to add their attachments: a custom *no content template* (using &lt;adf-empty-list>) to invite the user to add their attachments:
<!-- {% raw %} --> <!-- {% raw %} -->