Skip to content

Conversation

@stevepiercy
Copy link
Contributor

@stevepiercy stevepiercy commented Nov 27, 2025

@erral @jensens I started this PR from the comment in #1757 (review).

I'll revert these changes in that PR to separate these two matters so y'all can focus on what needs to be done. Thank you for your attention to this!


📚 Documentation preview 📚: https://plone6--1999.org.readthedocs.build/

@stevepiercy
Copy link
Contributor Author

Failing checks should be fixed in plone/plone.api#591 when it is merged and I update the git submodule tip for plone.api.

@stevepiercy stevepiercy moved this from New to Todo in Plone Documentation Nov 27, 2025
[`i18ndude`](https://pypi.org/project/i18ndude/) should be used to create a script which searches particular packages for translation strings.

If you have created your add-on using [bobtemplates.plone](https://pypi.org/project/bobtemplates.plone/), then you will already have a script `update.sh` inside your package and a script `update_locale` in your buildout to extract the messages from your code.
If you have created your add-on using [bobtemplates.plone](https://pypi.org/project/bobtemplates.plone/), then you will already have a script {file}`update.sh` inside your package and a script {file}`update_locale` in your {term}`buildout` to extract the messages from your code.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If you have created your add-on using [bobtemplates.plone](https://pypi.org/project/bobtemplates.plone/), then you will already have a script {file}`update.sh` inside your package and a script {file}`update_locale` in your {term}`buildout` to extract the messages from your code.
If you have created your add-on using [bobtemplates.plone](https://pypi.org/project/bobtemplates.plone/), then you will already have a script {file}`update.sh` inside your package and a script {file}`update_locale` in your {term}`buildout` to extract the messages from your code.
If you have created your add-on or projects using [cookieplone](https://github.com/plone/cookieplone), then you will already have a `make i18n` command in the `backend` folder that extracts the messages from your code.
This command will call `i18ndude` under the hood using `uvx`, without you needing to install it separatedly.


(translating-text-strings-installing-i18ndude-label)=

### Installing i18ndude
Copy link
Member

Choose a reason for hiding this comment

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

I would remove this entire section as we are ditching buildout. And add something like "You can run i18ndude using uvx i18ndude. "

@github-project-automation github-project-automation bot moved this from Todo to In Progress in Plone Documentation Nov 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

4 participants