-
Notifications
You must be signed in to change notification settings - Fork 86
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**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.
There was a problem hiding this comment.
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?:
**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)`).** |
After a small discussion with @alongosz it looks like the |
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