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.

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

IBX-9030: Add content name pattern examples #2513

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented Oct 8, 2024

Question Answer
JIRA Ticket IBX-9030
Versions master, 4.6 (3.3?)
Edition All

Add several content name pattern examples, from simple to advanced, an a notice about special characters (encountered in IBX-8897)

Preview: https://ez-systems-developer-documentation--2513.com.readthedocs.build/en/2513/administration/content_organization/content_types/#content-type-metadata

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

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

Thank you, I like the examples!

One comment about the special usage, because I think it can be made clearer.

- `nickname`: "*Bob*"
- Generated content name: "*Bob*"

**Notice that you won't be able to obtain a vertical bar `|` or parentheses in the generated names as they are special characters.**
Copy link
Contributor

@mnocon mnocon Oct 9, 2024

Choose a reason for hiding this comment

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

Suggested change
**Notice that you won't be able to obtain a vertical bar `|` or parentheses in the generated names as they are special characters.**
**The grouping`(`, `)` symbols used together are treated as special keywords and can only be used together as such, without the possibility to use them as standard characters. **

Nitpick: I believe you can obtain them in the generated names - if the fields contain them, they just cannot be part of the pattern in other meaning than the "special one"

I did some tests and it looks like you can use the | symbol in its standard meaning - only the grouping is not allowed.

CT settings:
Zrzut ekranu 2024-10-9 o 13 57 21

Content:
Zrzut ekranu 2024-10-9 o 13 57 29

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mnocon
OK for removing pipe and being clearer about parentheses.
I'm adding an example of what could go wrong so one could even search for "EZMETAGROUP_0" and find this explanation. What do you think about the following phrasing?:

Suggested change
**Notice that you won't be able to obtain a vertical bar `|` or parentheses in the generated names as they are special characters.**
**Notice that the grouping parentheses (characters `(`and `)`) are always treated as special characters, and can't be used as standard characters (unexpected text would appear in between like `(EZMETAGROUP_0)`).**

@Sztig
Copy link

Sztig commented Oct 9, 2024

After a small discussion with @alongosz it looks like the () should not be parsed outside angle brackets <> and it might be a regression, I will check on 3.3 where it was reported to work as intended and if the bug not happens there then I will proceed with it as a new bug. Maybe we should wait with pushing the documentation till it is resolved.

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

Successfully merging this pull request may close these issues.

3 participants