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

Content shape alternate targeting a specific item with ContentItemId (#15572) #16679

Conversation

dmourtzoukos
Copy link

@dmourtzoukos dmourtzoukos commented Sep 6, 2024

This pull request enhances the templating system for content items by adding support for templates based on ContentItemId and updating the documentation to reflect these changes. The most important changes include the addition of new template alternates in the Shapes.cs file and the corresponding updates in the documentation.

Enhancements to templating system:

Documentation updates:

Fixes #15572.

Introduce new template alternates in Shapes.cs for content items based on `ContentItemId`:
- `Content__[ContentItemId]`
- `Content_[DisplayType]__[ContentItemId]`

Update README.md to document the new alternates, including:
- Descriptions of when each template is called
- Examples of template filenames
- Notes on deprecation of `Id` based templates, recommending `ContentItemId` based templates instead
Copy link
Contributor

github-actions bot commented Sep 6, 2024

Thank you for submitting your first pull request, awesome! 🚀 If you haven't already, please take a moment to review our contribution guide. This guide provides helpful information to ensure your contribution aligns with our standards. A core team member will review your pull request.

@dmourtzoukos dmourtzoukos changed the title Content shape alternate targeting a specific item with ContentItemId #15572 Content shape alternate targeting a specific item with ContentItemId (#15572) Sep 6, 2024
@dmourtzoukos
Copy link
Author

Fixes following issue:
#15572

@dmourtzoukos dmourtzoukos marked this pull request as ready for review September 6, 2024 12:03
src/docs/reference/modules/Templates/README.md Outdated Show resolved Hide resolved
src/docs/reference/modules/Templates/README.md Outdated Show resolved Hide resolved
src/docs/reference/modules/Templates/README.md Outdated Show resolved Hide resolved
@hishamco hishamco requested a review from Piedone September 6, 2024 12:09
@Piedone
Copy link
Member

Piedone commented Sep 6, 2024

I'm out until Harvest and won't be able to review, trust your judgement @hishamco.

Copy link
Member

@Piedone Piedone left a comment

Choose a reason for hiding this comment

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

I didn't review the PR, but am only adding the release notes note.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor

This pull request has merge conflicts. Please resolve those before requesting a review.

@hishamco
Copy link
Member

Please resolve the conflict

@dmourtzoukos
Copy link
Author

Please resolve the conflict

Conflicts have been resolved.

@Piedone
Copy link
Member

Piedone commented Oct 21, 2024

I'm not reviewing but @hishamco please finish yours.

@MikeAlhayek
Copy link
Member

@dmourtzoukos If you please add notes about this change in https://github.com/OrchardCMS/OrchardCore/blob/main/src/docs/releases/3.0.0.md I will merge it for you. Please add the note and request my review so I can merge it.

@sebastienros
Copy link
Member

Do we really need this since we have alias and route shapes? I am thinking this would just create extraneous alternates for every single content item that would probably be unnecessary.

@MikeAlhayek
Copy link
Member

@sebastienros same feeling here. However, others seems to want it. If it is not really needed, I rather not add it

@sebastienros
Copy link
Member

others seems to want it

The issues were created before we had alias/route alternates, maybe we should ask again.

@MichaelPetrinolis
Copy link
Contributor

You are right, now that we have alternates by alias this PR has no added value.
Do you agree to modify the alternate based on the localization set, so that a simple template can be applied to a specific content item on any locale? This cannot be achieved by alias or autoroute alternates, as they are unique

@sebastienros
Copy link
Member

@MichaelPetrinolis can you file an issue? Also here is a previous mention of this, check the whole thread there are other alternatives. #5033 (comment)

It's not that easy though, perf implications (even more that this PR)

@Piedone
Copy link
Member

Piedone commented Dec 21, 2024

Yeah, this is not really needed anymore, but thank you @dmourtzoukos! Sorry that things shifted around in the meantime, but we'd welcome any further improvements/issue fixes from you in the future.

Closed #15572.

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.

Content shape alternate targeting a specific item with ContentItemId
7 participants