Documentation maintenance

[kproth]

Question about the current state of documentation. I'm hoping to submit a Pull Request with some tweaks to VC Buttons and Cuelists related to external input, which I've mentioned a few times lately in the user forums. It includes a new option on the associated widget properties. I have already updated vcbutton.html and vccuelist.html accordingly in the source code, which appears to be included with v4 builds and accessed via the Question Mark icon in the toolbar. But I see there's a separate qlcplus-docs repository for the online documentation (https://github.com/mcallegari/qlcplus-docs/tree/main).

Is it correct to include changes to (for example) "resources/docs/html_en_EN/vcbutton.html" with my code change PR, and then queue up a second change for the qlcplus-docs repo if/when the main PR is accepted?

[mcallegari]

Internal documentation will be removed.
Official docs will be either online (https://docs.qlcplus.org/v4) or in a released PDF.
All change requests should be submitted to GitHub:
https://github.com/mcallegari/qlcplus-docs

[sbenejam]

Massimo, Is the new documentation system ready to translate it into other languages?.

[mcallegari]

Massimo, Is the new documentation system ready to translate it into other languages?.

Hi, I think so. I did experiment with v4 vs v5 docs and it is possible. In theory I could setup all combinations between languages and QLC+ versions.
Would you volounteer to make the Spanish version? That would be huge!

[sbenejam]

I have done some tests with OmegaT and it seems that the implementation to translate markdown files is good, and machine translation helps a lot and I just have to review some words and sentences. I think I could try to make the versions in Catalan and Spanish. But let me make some tests before.

[GGGss]

Keep us posted with your results. I can take care of the Dutch translation.

[mcallegari]

Thanks guys!

[sbenejam]

Fredje, The programs I have installed in my laptop running Ubuntu 22.04 to translate the documentation are these:
OmegaT translation memory tool: http://omegat.org/download
Neural Machine Translation tools from Softcatala.org: https://github.com/Softcatala/nmt-softcatala
I'm used too some resources from Softcatala such as Translation Memories, Terminology, etc. https://www.softcatala.org
In the OmegaT I have activated in Automatic Translations "MyMemory" and "Apertium". In the Apertium section I pointed the URL to the nmt-softcatala service running on my laptop. http://localhost:8700

[sbenejam]

Massimo, I created a new branch called "cat" in my qlcplus-docs fork. There are some translations already made from the first chapters. It seems that the files translated and exported from OmegaT will work without the need to edit them later.
I'm looking if I can do some tests on a local web server. To be able to compare it with the QLC+ documentation of the web.
In case you want to review it.
https://github.com/sbenejam/qlcplus-docs/tree/cat

[mcallegari]

Hi Santiago, happy new year!
i think the right way to translate MD docs is this:
- fork the current qlcplus-doc repo
- duplicate all *.md files and name them .XX.md where XX is QLC+ version and country code. Example: v4_ca, v4_de, etc
- submit a pull request

In this way picture resources are shared between translations, unless you need a translated picture then you should upload a duplicate file ending in v4_XX.png

If you want we can make a test to see if the above works. Please send a pull request of a single page of your choice and I'll setup the language and include the page online.
Thanks!

[sbenejam]

Hi Massimo, happy new year. I'll try to send a pull request after rename the translated files as you explained.

[sbenejam]

Hi Massimo, I'm looking how to duplicate and rename the .md files in the pages folder. I see that there are files with the following names:
chapter.md -> chapter.v4_ca.md
chapter.v4.md -> chapter.v4.v4_ca.md
chapter.v5.md -> not renaming now
docs.md -> docs.v4_ca.md
default.v4.md -> default.v4.v4_ca.md
Is this correct?. Or Would you like to add "_ca" or "_es" to those who already have .v4 as part of their name?

[mcallegari]

Those with v4 already in the name should be renamed just adding the language code:
chapter.v4.md -> chapter.v4_ca.md

[DavidGrc]

Hi, and happy new year. I don't know how , but maybe i would be able to take care of french translation, if it can help.

[Yestalgia]

Hi, and happy new year. I don't know how , but maybe i would be able to take care of french translation, if it can help.

Maybe just hold off until the first pull request gets closed. I think we're going to learn a lot from sbenejam's work.

[sbenejam]

Hi, and happy new year. I don't know how , but maybe i would be able to take care of french translation, if it can help.

Maybe just hold off until the first pull request gets closed. I think we're going to learn a lot from sbenejam's work.

I finished translating 6 - Simple Desk chapter a while ago, tomorrow I will start chapter 7 - Virtual Console.
The truth is that automatic translation with OmegaT saves you a lot of work of typing, you just have to check small syntax and translation errors.
Once the translation has been completed, I will have to review the tables and other markers that with OmegaT are sometimes not equal to the original.

[mcallegari]

Thanks Santiago.
Can you please translate also Main Window?
https://docs.qlcplus.org/v4_ca/main-window

[sbenejam]

Hi Massimo, I've already translated it. I have not yet sent it to my Git repository. I hadn't translated it yet when I uploaded the first translations.

[sbenejam]

Hi Massimo,
I have completed the translation of all QLC+ documentation into Catalan. I need to review links to other pages and sections of the same page. I'll edit them directly in my git repository and check that the links are the right ones.
When I have checked, I'll send a pull request.
Afterwards I'll start the translation into Spanish from the Catalan version. I think it will be faster than from the English version.

[mcallegari]

Awesome, thanks!