Hans, et al, I don't mean for this email to take anything away from the 9 month effort you and the team has put into making the docs more cohesive, as well as translatable. Thank you to everyone on the team.
Unfortunately, the latest commit breaks a few things: 1. Building for anyone running the official ISO with the official distro (Buster), whether or not they are building the docs as well. 2. The buildbot for package installs. Additionally, I would like to suggest that whether or not the translated documents are built or not should be controlled by a switch/option when you set the option to build for HTML, PDF, or BOTH. There may be no need for most developers to build the translated docs 99% of the time. I frequently build the HTML docs when making changes to the documents to ensure it looks correct, and I didn't break anything. It takes long enough as it is, waiting 2-4 hours to verify a change looks as it should is simply unacceptable, especially when the English documents are considered the master. Thanks again, Greg On Sat, Jun 4, 2022 at 5:35 AM Hans Unzner <hansunz...@gmail.com> wrote: > Dear all, > > the documentation build system of LinuxCNC is now enhanced to support > GNU gettext, which in turn is supported by online translation > communities. It now uses the po4a system to generate POT and PO files > from the English documentation. LinuxCNC is already present in Weblate > for the translation of the graphical user interfaces, and now a > sub-project for the docs can be found there as well: > https://hosted.weblate.org/projects/linuxcnc/linuxcnc-docs/ > > Thanks to Petter Reinholdtsen (@petterreinholdtsen), Jérémie Tarot > (@silopolis) and Steffen Möller (@smoe) for their great work and > engagement! > > The Spanish and French translations were synced with the English > documentation in order to transfer the previous translations as closely > as possible. > But all these translations need to be confirmed/verified in order to be > shown on the website. > Translations to other languages need to start from scratch or find the > corresponding paragraphs in earlier versions of the LinuxCNC documentation. > > From now on, all documentation should be performed for the English > pages only. Those shying away from writing in English, we suggest to > just choose a language they are comfortable with and put them into the > English docs. We will then find someone to perform the translation to > English. > > While syncing, we found that the formatting of the document was often > superior in the translation, while the content was typically improved > only in the English - with exceptions. We have done our best to sync > towards a symbiosis of best from translations and the original. So > please pay attention to the English docs as well in case anything has > changed to the worse. > > Work on "getting docs into Weblate" started about 9 months ago, and, > admittedly, this took much longer than any of us anticipated. We > admittedly thus made a few compromises to finish this up and to bring > the docs into Weblate. > To get those done we would appreciate some help: > * Style: Authors (and translators) have different styles to enumerate, > define, warn, narrate, describe tables/figures, reference ... at some > point the community should decide how the community wants it. Jérémie is > preparing a respective style guide. > * Verification: While syncing between languages, we may have messed > something up. It shouldn't be anything serious, but this all needs a > review. A series of whitespace-corrections are still being prepared for > QtVCP in particular. For reference and comparison, the version of the > docs before the Weblate-related work started: > https://hansu.github.io/linuxcnc-doc/16736d86 > * Build-time: Whenever a translation is not available, the original > English text will be used. So every language will get a full set of > documentation and that increases the build time, which is almost two > hours now. We need to decide what to do for the CI or find other ways to > optimize the build time since with an increasing number of languages > that build time will increase - otherwise, with one additional language > per continent, we would be at >4 hours build time just to fix a comma. > > Cheers, > Hans > (@hansu) > > > > _______________________________________________ > Emc-developers mailing list > Emc-developers@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/emc-developers > _______________________________________________ Emc-developers mailing list Emc-developers@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/emc-developers
