Skip to content

IBX-11549: name.help translation key described in Dev-doc#3294

Open
julitafalcondusza wants to merge 4 commits into
5.0from
IBX-11549
Open

IBX-11549: name.help translation key described in Dev-doc#3294
julitafalcondusza wants to merge 4 commits into
5.0from
IBX-11549

Conversation

@julitafalcondusza

@julitafalcondusza julitafalcondusza commented Jul 16, 2026

Copy link
Copy Markdown
Contributor
Question Answer
JIRA Ticket (https://github.com/ibexa/fieldtype-page/pull/199)
Versions 5.0
Edition Experience, Commerce

New name.help translation key described in Dev-doc:

  • page_blocks.md - mentioned in the Block configuration table, added section explaining new translation key
  • react_app_block.md - mentioned in the React App Block configuration table

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Code samples are working
  • Added link to this PR in relevant JIRA ticket or code PR

@github-actions

Copy link
Copy Markdown

Preview of modified files

Preview of modified Markdown:

Comment thread docs/content_management/pages/page_blocks.md
@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown

Summary

Status Count
🔍 Total 761797
🔗 Unique 15028
✅ Successful 6317
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 755370
❓ Unknown 0
🚫 Errors 110
⛔ Unsupported 0

Errors per input

Errors in site/release_notes/ez_platform_v1.10.0/index.html

Errors in site/release_notes/ez_platform_v1.11.0/index.html

Errors in site/release_notes/ez_platform_v1.13.0_lts/index.html

Errors in site/release_notes/ez_platform_v1.9.0/index.html

Errors in site/release_notes/ez_platform_v3.0/index.html

Errors in site/release_notes/ez_platform_v3.0_deprecations/index.html

Errors in site/release_notes/ez_platform_v3.1/index.html

Errors in site/release_notes/ibexa_dxp_v3.2/index.html

Errors in site/release_notes/ibexa_dxp_v4.0/index.html

Errors in site/release_notes/ibexa_dxp_v4.1/index.html

Errors in site/release_notes/ibexa_dxp_v4.2/index.html

Errors in site/release_notes/ibexa_dxp_v4.3/index.html

Errors in site/release_notes/ibexa_dxp_v4.4/index.html

Errors in site/templating/twig_function_reference/recommendations_twig_functions/index.html

Full Github Actions output

@mnocon mnocon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment, and the YAML example needs to be fixed

Comment thread docs/content_management/pages/page_blocks.md Outdated
@julitafalcondusza julitafalcondusza requested a review from mnocon July 16, 2026 12:01

@mnocon mnocon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@julitafalcondusza julitafalcondusza added Wait with merge PRs that shouldn't be merged instantly and removed Needs DOC review labels Jul 16, 2026

@adriendupuis adriendupuis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it can be something else than translation key if working only in English or prototyping. Not sure about "array", it sounds more "PHP associative array"-ish than YAML


For a full example of block configuration, see [Create custom Page block](create_custom_page_block.md).

### Block name help text

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Block name help text
### Block name and help


### Block name help text

The `name` setting accepts either a single translation key, or an array with `text` and `help` keys.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The `name` setting accepts either a single translation key, or an array with `text` and `help` keys.
The `name` setting accepts either a single translation key, an hard coded string of text that won't be translated, or an object with `text` and `help` property keys.

```

- `text` - corresponds to the block name.
- `help` - is an optional translation key whose translation is rendered as a helper text under the **Name** field in the block configuration form.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optionally a screenshot to show how it's rendered? Maybe from a built-in block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Wait with merge PRs that shouldn't be merged instantly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants