Structure for translations
Since it's already in place I think it makes the most sense to continue using the structure started by linuxito, each language in it's own directory using two letter country codes.
I'm not sure about URL names being translated as we "might" break something with git, or characters might not be supported in browsers etc. Perhaps someone has a better idea about this than I do since I'm not bilingual.
In any case I have one idea to move the master branch into the newly made "en" directory, and create a frontpage where the user selects their language.
README.md would then become something like this:
It would mean to translate roughly what's on the current index page, so when you click these links it will go somewhere relevant. So that would be the front page which we could work on together so that the above doesn't all read in English.
@all Thoughts? Can we improve on that?
This weekend I will have a look at integrating what we have already into a single branch, so when we're done we can merge it to master.
-
I think English should be the default language with those links (Read documentation in x) in the front/main page somewhere.
And maybe that sentence should be translated in target language:
Read documentation in English
Leer la documentaci\xc3\xb3n en espa\xc3\xb1ol
Lesen Sie die Dokumentation auf Deutsch
...and the like.
Just my opinion.
Edited by Linuxito -
A second idea occurs to me.. to just have the links "Read in Spanish, Read in German," etc at the top of the index page.
Read in Spanish | Read in German etc
But obviously those links should read in those languages too. I like this a little better since a front page does feel a little redundant.
Edited by dev1fanboy -
Another idea might be to make visible these languages in the "tags" dropdown menu, giving access to them.
-
Her you are examples of different tags:
https://git.devuan.org/aitor_czr/linux-libre/tree/upstream/4.9.83
https://git.devuan.org/aitor_czr/linux-libre/tree/debian/4.9.83-1
The first one contains the upstream branch, and the second one contains also the debian branch. Both are accessible via the API of gitlab using the dropdown menu.
Edited by aitor_czr -
Oops, the branches "de", "el", "es", "pl" already exist in the menu, being "en" the master.
Edited by aitor_czr -
I'll have a look at formats this weekend, see what they would look like. The appearance is mostly for devuan.org which should present a little better, otherwise just normal links would be OK.
Edited by dev1fanboy -
I understand that all pages in git (incl. translations) should find their way on the main site ( https://www.devuan.org/os/documentation/dev1fanboy/ ). A nice and clear way to get the translated alternative to the pages, is to do what gnu.org does; a languages section on each page for all languages that a given page is translated to.
EDIT: gnu.org appends the language code to the name of each file (e.g. home.html -> home.el.html).
Alternatively, we could create files under a language path.
I realize that in git we currently have both.
This is related to Issue #75
Edited by Menelaos Maglis -
Hi Menelaos, your main proposal is similar to dev1fanboy's second idea (shared by me). On top of that, www.gnu.org gives you the option of choosing the default language, setting a cookie in your computer in order to give priority to your selection over the default language set in the preferences of your browser.
-
@aitor_czr , indeed, what we should also do, is to show a link to another language only if the given page is translated in that language. It works best if all pages are translated in a given language and any local links navigate to a page in the same language. Otherwise it should default to English.
A consequence of this proposal is that all pages in a given language should have language code suffix or live under a language directory, or both (is this necessary?). - related to issue #75
I am not sure about our infrastructure, so I cannot comment how this can be achieved in practice or how it will work with transfer between git and main site. @dev1fanboy or someone else please comment.
I am confused as to why we branch the master to languages (de, el, es, pl) containing all files from master, and then we create yet another subfolder (de/de, el/el etc..) where the actual translations happen. So far, I have done a few translations using the web interface, which makes the translation workflow awkward. It may be better with actually creating a local git repository.
I and possibly other newcomers need a translation primer to orient ourselves with the translation effort, facilities and best practices. - (Issue #62)
-
My main concern really is to keep maintenence work low, and to lessen the effort required to translate pages. So, my suggested layout below is mostly with that in mind.
About the infrastructure:
When pages are uploaded to devuan.org the links need to be converted so that they point to the correct location.
For example the network configuration page needs to point directly to where that page would be on the website.
/os/documentation/dev1fanboy/network-configuration
So this should be done just before the push there. At the moment, I am just editing this before it's pushed to the beta branch on the website to point to the appropriate links.
Layout:
I think many linkings on each page may increase the work. I believe the best way is to have the index.md to point to each translation area, which would redirect to "es", "de" etc.
URLs:
For the layout, It may be easier to also have the URLs in English and not append any "es" in the url name.
So links would stay the same regardless of language:
Informaci\xc3\xb3n general Allgemeine Information
And the index page would be the only exception to that rule.
I think this layout would be easiest the first time we push to the website with the translations. Based on this discussion I will create a mockup of some sort showing this, and a primer page on translations.
I'm open to further suggestions on this, but we should decide soon (say few days to a week) so we can start putting this all together according to the same standard.
Edited by dev1fanboy -
changed milestone to Include translations on Devuan.org
-
@dev1fanboy : better to separate the fields with a " | " symbol, as you suggested at first. It makes it more readable. Something like this:
Espa\xc3\xb1ol | Deutsche
PD: i'll finish the translations this afternoon
-
@aitor_czr having a look at that I found it didn't look as good, I'm also wondering how that would look in html.
I think the layout will break on devuan.org if the links would be at the top. At the bottom, I tried my initiial suggestion with
<sub>
which looked ok but also devuan.org will strip that part out. Anyway, I will upload that as a sample soon.Thanks :)
Edited by dev1fanboy -
mentioned in issue #82 (closed)
-
This is the sample of the original suggested layout (improved to move links to bottom)
https://git.devuan.org/dev1fanboy/Upgrade-Install-Devuan/blob/master/sample.md
Anyway, let me know what you think on this. Thanks, chillfan.
-
@dev1fanboy : i find it perfect; imho, only an extra intro would be needed between the end of the index and the begining of the links to the available translations. Thanks.
-
It's ok for me. But I would translate the language links into that language. For example "Auf Deutsch lesen".
-
OK, let's make these changes then. I will add a little extra into there and a heading for translations, then if we each put them in like:
Auf Deutsch lesen | Leer en Espanol etc
That should be it for structure.
Edited by dev1fanboy -
So here is the final page:
https://git.devuan.org/dev1fanboy/Upgrade-Install-Devuan/blob/development/README.md
Please update the link descriptions in this file on the development branch to read in your language as above. Then I'll merge the branch to master :)
Edited by dev1fanboy -
Updated the "Read in Greek" in the development branch.
I propose to optionally have the same section on the target translated page also, but there substitute the target language with a link back to the English page:
[Read in English](https://git.devuan.org/dev1fanboy/Upgrade-Install-Devuan/)
This way anyone landing accidentally on a translated page that cannot understand can find their way out :-)
-
I agree with that last, it would be best to let people navigate freely from each index page.
-
There are now also language directories under the master branch. Should we place our translations under master, or under a language branch?
-
@Jochen they should go under a directory named after your two letter language code. When you've completed a few documents you can make a merge request to master that will place them under master.
Edited by dev1fanboy -
Has been decided so should close
-
closed
-
reopened
-
I still do not know where to edit the translations. There is a development branch, as well as a branch per language. Should I edit the german translation in the branch "de", or in the branch "development"?
-
@Jochen I would just go ahead and work on the de branch. The branches named after the language you're working on are "your" branches, the development branch is just where you can put that together before merging to master
-
changed title from Struct ion for translations to Struct ure for translations
-
Note that development branch is not being used now, nor should we I think as it's better to just keep it simple.