Translating the documentation

[PurplePlums]

Expected behaviour

I would like to have the existing documentation integrated into Crowdin expansible for us to translate it into the used languages.

Actual behaviour

Please add it if possible

Steps to reproduce

Obviously it is not integrated in any CAT tool so far, and without one it would be hard to translate it.

Output from the debug section in the settings dialog

none

Expand

Relevant log output in the Log panel

Expand

[pbek]

Do you mean https://docs.qownnotes.org? The website is generated from markdown files from https://github.com/pbek/QOwnNotes/tree/develop/docs/content. It relies on readthedocs which is using mkdocs to generating the website. The markdown files can't be feeded into crowdin nor do I know a way to handle translations at all with readthedocs and mkdocs. 😬

[PurplePlums]

Trados is extremely flexible but we need to wait for the new version till 2021.
https://www.sdltrados.com/products/trados-studio/free-trial.html

[PurplePlums]

In the meanwhile you may want to take a look on the software; I’m going to need a license anyway only Trados19 is not available atm

[PurplePlums]

Look whether this is working; Trados organizes and imports a huge variety of sources, and is the most popular CAT tool available. Also costly but there will be a free trial (assuming with the relevant features end of this year. In the meanwhile let’s extend the matter

[pbek]

nor do I know a way to handle translations at all with readthedocs and mkdocs.

👀

[PurplePlums]

What about source code translation? You’d need to only once prepare the code so that the translatable parts are highlighted. So far it’s not too much, if no CAT tool can handle it.

[pbek]

To my knowledge readthedocs and mkdocs can't handle translations, means there is no sane way to make https://docs.qownnotes.org multilingual.

[PurplePlums]

Hey hey why.
Basically I did something similar once already to collect a bilingual text for training a Software.

All I think I need to do is making a single excel file with all the text, it’s still extendible and not much more work than going through a document for several languages from a CAT tool (this is why I seldom use CAT tools.)

So if it’s possible that different versions of the same matter be uploaded, the whole translation and the editing procedures will be applied easily.

Is it?

[PurplePlums]

A CAT tool like Smartling could do the most work and it would be easy to re-insert the translation into the source code, then there will be 60 more versions of the documentation - my question here is if THATs possible, I can arrange the translation.

For people who don’t speak languages it would definitely be helpful.

[PurplePlums]

https://www.deepl.com/en/docs-api/
Seems to cooperate with external sources, but also bringing on a link to the page(s) would do many a service, I assume.

[pbek]

Maybe we have a chance to get translated documentation. I'm currently working on recreating www.qownnotes.org with VuePress (static site generator with vue.js). I plan on integrating the documentation too there (there still is a loooot to do until I get there).

VuePress has support for multi-language: https://vuepress.vuejs.org/guide/i18n.html#site-level-i18n-config

[PurplePlums]

Sorry, that I don't understand where the link leads to and what's suggested there. In what way can I contribute a translation to the documentation, except copying the source code and rewriting the content in my languages?

[pbek]

I did not experiment with it yet. 😁

[PurplePlums]

OK the documentation looks awesome. Thank you for mentioning it. It’s like I said, it would be...

[PurplePlums]

Is it possible to start with something? :-) Thankyou!

[pbek]

I'm still torn apart in that regard. The only thing that I see is to translate every file in https://github.com/pbek/QOwnNotes/tree/develop/webpage/src directly. But there will no mechanism (like with crowdin) to tell that an English file was updated and needs new translation... so we would always generate misleading or obsolete documentation. 😢 Do you by chance know of a way to monitor all files in that folder?

[PurplePlums]

Here's the list of all cat tools:
https://www.polilingua.com/blog/post/cat_tools.htm

[PurplePlums]

Those might solve the issue, Trados is very strong, has a free licence for one month. However possibly another software could take over.

[pbek]

It would have to be something that runs in the web, is free for free open source projects and somehow integrates into github and with the file-structure vuepress has for translations...

[PurplePlums]

Runs in the web for future tasks, but we’d provide human made translations.

Deep L would be a good resource.

[PurplePlums]

Can you give me an example, so I can search for a tool that handles it?

[PurplePlums]

Maybe just translate and update...

[pbek]

The example is:

• All markdown files in https://github.com/pbek/QOwnNotes/tree/develop/webpage/src need to be monitored for changes.
• If changes are found some web interface need to show those changes and translators need to be notified that changes occurred.

There basically will be a different directory tree for each translation. And it would be great if those were in-sync with the English version of the webpage.

That's not an easy thing to do. 😬

[PurplePlums]

Would you like me to translate text in order to have them available?

[pbek]

Of course that would be great, but my issue with translated documentation is #1859 (comment) 😢

[PurplePlums]

Could content management systems be useful?

[pbek]

As long as the single source of truth are the files in https://github.com/pbek/QOwnNotes/tree/develop/webpage/src I don't care.