mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-06 09:09:38 +03:00
Translating with keys to import/export #5437
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @FranciscoBigWings on GitHub (Sep 27, 2025).
Describe the feature you'd like
Hello,
Im have checked this project for a while but there’s something I miss in this and other similar projects. Ease to translate and maintain translated texts.
If it would be possible to create the context where each text or paragraph is organised as one key with the possibility to export the whole thing, it would be so easy to import into something like Tolgee to translate it painlessly.
Does anyone have an alternative or better solution to maintain locales?
Describe the benefits this would bring to existing BookStack users
Easier and semi-automatic translation of texts
Can the goal of this request already be achieved via other means?
No
Have you searched for an existing open/closed issue?
How long have you been using BookStack?
Not using yet, just scoping
Additional context
No response
@ssddanbrown commented on GitHub (Sep 27, 2025):
Hi @FranciscoBigWings,
To be honest, that sounds like something which would be a little too use-case specific to be worth supporting in a platform like this.
There's a general wider request in regards to localization open here: #569
Otherwise, we do technically ensure each "block" of content is assigned a unique ID on save, which remains semi-stable across edits, which could potentially be used for this kind of process, but may not be a friendly/easy-to-read ID, and the format is HTML so could get quite complex in terms of nesting/structure.
@FranciscoBigWings commented on GitHub (Sep 27, 2025):
Thanks for checking my proposal. I think that translations are really needed in general when working with documentation specially if you prepare for external views and not only inside an organisation.
Maybe organising the texts or paragraphs in keys might sound as an overkill but that’s how you translate an app for example. Otherwise you end up crazy translating every term and text.
Specially the translation job is not related, normally, to the same person doing the documentation so it would make sense to be able to export it. If you want to translate within an app you would need to create a profile for translation and not allowed to edit for example.
Those are my recommendations from my experience
@ssddanbrown commented on GitHub (Sep 30, 2025):
Okay, if the existing IDs set on each block aren't good enough, there can be possibilities by using the API to go over each section and set a more relevant ID name. Or perhaps the logical theme system could be used to update content upon save if you didn't want to build something external.
Otherwise I'd generally see the existing issue #569 as a precursor to this (To generally provide content translation support). So I'm therefore going to close this one off as out of scope, at least for now.