diff --git a/.github/styles/UmbracoDocs/Acronyms.yml b/.github/styles/UmbracoDocs/Acronyms.yml index b12f92cede9..ac681a2fefb 100644 --- a/.github/styles/UmbracoDocs/Acronyms.yml +++ b/.github/styles/UmbracoDocs/Acronyms.yml @@ -5,7 +5,7 @@ scope: text ignorecase: false # Ensures that the existence of 'first' implies the existence of 'second'. # Require leading whitespace to avoid matching on URL substrings eg https://www.youtube.com/embed/OUD-PbWESAs?rel=0 -first: '\s\b([A-Z]{3,5})\b' +first: '\b([A-Z]{3,5})\b' second: '([A-Z]{3,5}): (?:\b[A-Z][a-z]+ )+|(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' # ... with the exception of these: exceptions: @@ -84,5 +84,3 @@ exceptions: - DHL - UUI - MDN - - UFM - - XSS diff --git a/10/umbraco-cms/extending/health-check/guides/macroerrors.md b/10/umbraco-cms/extending/health-check/guides/macroerrors.md index c4d793b0fdb..3782334f013 100644 --- a/10/umbraco-cms/extending/health-check/guides/macroerrors.md +++ b/10/umbraco-cms/extending/health-check/guides/macroerrors.md @@ -5,7 +5,7 @@ # Health check: Macro errors -_Checks to make sure macro errors are not set to throw a YSOD (yellow screen of death), which would prevent certain or all pages from loading completely._ +_Checks to make sure macro errors are not set to throw a Yellow Screen Of Death (YSOD). This could prevent certain or all pages from loading._ ## How to fix this health check diff --git a/13/umbraco-cms/extending/health-check/README.md b/13/umbraco-cms/extending/health-check/README.md index b80491b4cab..e59345e5456 100644 --- a/13/umbraco-cms/extending/health-check/README.md +++ b/13/umbraco-cms/extending/health-check/README.md @@ -87,7 +87,7 @@ namespace Umbraco.Cms.Core.HealthChecks.Checks.Configuration; [HealthCheck( "D0F7599E-9B2A-4D9E-9883-81C7EDC5616F", "Macro errors", - Description = "Checks to make sure macro errors are not set to throw a YSOD (yellow screen of death), which would prevent certain or all pages from loading completely.", + Description = "Checks to make sure macro errors are not set to throw a Yellow Screen Of Death (YSOD), which would prevent certain or all pages from loading completely.", Group = "Configuration")] public class MacroErrorsCheck : AbstractSettingsCheck { diff --git a/14/umbraco-cms/reference/umbraco-flavored-markdown.md b/14/umbraco-cms/reference/umbraco-flavored-markdown.md index 02a80a96dac..c9aa518f8f2 100644 --- a/14/umbraco-cms/reference/umbraco-flavored-markdown.md +++ b/14/umbraco-cms/reference/umbraco-flavored-markdown.md @@ -10,12 +10,11 @@ Using Markdown for labels provides basic text formatting. It natively supports t UFM is built on top of [GitHub Flavored Markdown](https://github.github.com/gfm/) and [CommonMark](https://spec.commonmark.org/) specifications. The implementation for Umbraco 14 has been developed as an extension to the [Marked library](https://marked.js.org/). - ## Syntax The essence of the UFM syntax is curly brackets with a marker prefix. -``` +```markdown { } ``` @@ -32,13 +31,12 @@ The curly brackets indicate that the UFM syntax should be processed. The `=` mar With this example, the syntax `{= bodyText }` would be processed and rendered as the following markup: -``` +```js ``` The internal working of the `ufm-label-value` component would then be able to access the property's value using the [Context API](../extending/backoffice-setup/working-with-data/context-api). - ## Available UFM components As for Umbraco 14.1.0, the following UFM components are available to use. @@ -48,31 +46,30 @@ As for Umbraco 14.1.0, the following UFM components are available to use. | Label Value | `=` | `{=bodyText}` | `` | | Localize | `#` | `{#general_name}` | `` | - More UFM components will be available in upcoming Umbraco releases. If you wish to develop your own custom UFM component, you can use the `ufmComponent` extension type: -``` +```json { - type: 'ufmComponent', - alias: 'My.CustomUfmComponent', - name: 'My Custom UFM Component', - api: () => import('./components/my-custom.component.js'), - meta: { - marker: '%', - }, + type: 'ufmComponent', + alias: 'My.CustomUfmComponent', + name: 'My Custom UFM Component', + api: () => import('./components/my-custom.component.js'), + meta: { + marker: '%', + }, } ``` The corresponding JavaScript/TypeScript API would contain a method to render the custom label/markup. -``` +```js export class MyCustomUfmComponentApi implements UmbUfmComponentBase { - render(token: Tokens.Generic) { - // You could do further regular expression/text processing here! - return ``; - } + render(token: Tokens.Generic) { + // You could do further regular expression/text processing here! + return ``; + } } export { MyCustomUfmComponentApi as api }; @@ -80,12 +77,11 @@ export { MyCustomUfmComponentApi as api }; Using the syntax `{% myCustomText }` would render the markup ``. Then inside the `ufm-custom-component` component code, you can perform any logic to render your required markup. - ## Post-processing and sanitization When the markdown has been converted to HTML, the markup will be run through post-processing sanitization to ensure security and consistency within the backoffice. -As of Umbraco 14, the [DOMPurify library](https://github.com/cure53/DOMPurify) is used to sanitize the markup and prevent XSS attacks. +As of Umbraco 14, the [DOMPurify library](https://github.com/cure53/DOMPurify) is used to sanitize the markup and prevent Cross-site scripting (XSS) attacks. The sanitized markup will be... @@ -93,12 +89,10 @@ The sanitized markup will be... - Anchor links will have their target set to `_blank` - Only web components that have a prefix of `ufm-`, `umb-` or `uui-` will be allowed to render - ## Using UFM in your own components If you would like to render UFM within your own web components in the Umbraco CMS backoffice, you can use the `umb-ufm-render` component: -``` +```js ``` -