Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Minor design updates using callout #31398

Merged
merged 4 commits into from May 4, 2021
Merged

Docs: Minor design updates using callout #31398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ff539f3
Add callout to i18n Note
mkaz May 1, 2021
4930a2d
Add callout alert for experimental feature
mkaz May 1, 2021
a03709a
Add info callout for reserved slugs
mkaz May 1, 2021
fc5aa84
Add callout info and cleanup for ESNext syntax
mkaz May 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/getting-started/tutorials/create-block/block-anatomy.md
View file
Open in desktop
@@ -1,8 +1,10 @@
# Anatomy of a Block

At its simplest, a block in the WordPress block editor is a json object with a specific set of properties.
At its simplest, a block in the WordPress block editor is a JSON object with a specific set of properties.

**Note:** Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, review the [ESNext syntax documentation](/docs/how-to-guides/javascript/esnext-js.md) to familiarize yourself with the newer syntax used in modern JavaScript development.
<div class="callout callout-info">
<strong>Note:</strong> Block development uses ESNext syntax, this refers to the latest JavaScript standard. If this is unfamiliar, review the <a href="/docs/how-to-guides/javascript/esnext-js.md">ESNext syntax documentation</a> to familiarize yourself with the newer syntax.
</div>

The javascript part is done in the `src/index.js` file.

Expand Down
4 changes: 3 additions & 1 deletion docs/how-to-guides/internationalization.md
View file
Open in desktop
Expand Up @@ -99,7 +99,9 @@ Common functions available, these mirror their PHP counterparts are:
- `_n( '%s Comment', '%s Comments', numberOfComments, 'my-text-domain' )` - Translate and retrieve the singular or plural form based on the supplied number.
- `_x( 'Default', 'block style', 'my-text-domain' )` - Translate a certain string with some additional context.

**Note:** Every string displayed to the user should be wrapped in an i18n function.
<div class="callout callout-alert">
<strong>Note:</strong> Every string displayed to the user should be wrapped in an i18n function.
</div>

After all strings in your code is wrapped, the final step is to tell WordPress your JavaScript contains translations, using the [wp_set_script_translations()](https://developer.wordpress.org/reference/functions/wp_set_script_translations/) function.

Expand Down
4 changes: 3 additions & 1 deletion docs/how-to-guides/themes/theme-support.md
View file
Open in desktop
Expand Up @@ -240,7 +240,9 @@ As an example for the regular font size, a theme may provide the following class
}
```

**Note:** The slugs `default` and `custom` are reserved and cannot be used by themes.
<div class="callout callout-info">
<strong>Note:</strong> The slugs `default` and `custom` are reserved and cannot be used by themes.
</div>

### Disabling custom font sizes

Expand Down
4 changes: 3 additions & 1 deletion docs/reference-guides/block-api/block-annotations.md
View file
Open in desktop
@@ -1,6 +1,8 @@
# Annotations

**Note: This API is experimental, that means it is subject to non-backward compatible changes or removal in any future version.**
<div class="callout callout-alert">
<strong>Note:</strong> This API is experimental, that means it is subject to non-backward compatible changes or removal in any future version.
</div>

Annotations are a way to highlight a specific piece in a post created with the block editor. Examples of this include commenting on a piece of text and spellchecking. Both can use the annotations API to mark a piece of text.

Expand Down