Updating and internationalizing documentation
- FDR
- Offline
In your fork you could simply commit the changes directly, and after that create a pull request to the main deviationTx/deviation repository.
So now you can merge it, and create a pull request to deviation.
You can learn more about the docker environment here:
www.deviationtx.com/wiki/development/docker
Note, that since you have an own GitHub fork, you need to create the docker container pointing to your existing GitHub directory outside the docker...
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
Yes it is my fork and I have asked to merge the pull request.
Hope this is correct.
Please Log in or Create an account to join the conversation.
- FDR
- Offline
You have merged your own pull request into your own repository, but you still need to create a new pull request to the deviationTx/deviation repository.
Just go to your repo, and click on the Pull request link on the upper right, under the buttons.
All the default values should be right, and the results would look like this:
github.com/DeviationTX/deviation/compare...er...Morlacus:master
Then click on the big green button to create the new pull request, and that's it...
Please Log in or Create an account to join the conversation.
- FDR
- Offline
What file naming convention do I need for the translated images?
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
1- Thanks for your help
I hope I did correctly for the french language update.
2- just seen your last post about translated images. Is it possible to change the images of the translated manual to provide images showing images of the TX using the language of the translation ?
Please Log in or Create an account to join the conversation.
- FDR
- Offline
Goebish can check better if it is valid, and will merge it.
It is possible to use translated images, which I plan to make, but forgot how should I name them, so they can be recognized...
Please Log in or Create an account to join the conversation.
- FDR
- Offline
<base_name>.<language>.<extension>
For example if the original filename is:
curve_deadband.png
curve_deadband.fr.png
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
I know I am not in charge but putting translated images in 'language' sub directory seems to me more practical and easy.Moeder wrote: Sorry for the late reply. Yes, this is the default behavior. We could also change it to look for translated images in subdirectories named by language if you think it is preferable.
Please Log in or Create an account to join the conversation.
- FDR
- Offline
So far I've only uploaded a few, so I can easily change them to the subdir structure if you wish...
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
Please Log in or Create an account to join the conversation.
- FDR
- Offline
Now I'm translating the SVGs, then will continue with the B&W images.
Actually most of the SVGs are outdated, and so far I haven't tried to replace the image in them, only translated the text in the boxes...
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
Once image are created and in the same format and size as the original ones, what would be the process to add them ?
Please Log in or Create an account to join the conversation.
- FDR
- Offline
Save as 8bit PNGs without transparency so save space, and name them as the original was, but with the added language tag, like this:
<original_name>.<language>.<extension>
For example:
model_menu.fr.png
To upload them there are more ways, just like in case of the language file were:
1. You can go into the image directory of the source, for example:
github.com/DeviationTX/deviation-manual/...es/devo8/ch_advanced
Then click on the "Upload file" button on the upper right, choose your files, gice a commit message (and a description if you like), choose the "Create a new branch for this commit and start a pull request." option, and press the "Commit changes" button.
2. If you have a GitHub fork of the deviation-manual repository, and an up-to-date local repository, then simply add the proper imager into the appropriate foldes, use "git add ." to include them, make a commit to your repo, push your changes back to your fork, and then make a pull request from there to the main deviationTx/deviation-manual repository.
The SVG files are harder. So far I only translated the additional texts in the boxes, which are simple XML content. You can use any editor (like notepad++) to edit them, and check the result in a browser.
So far I had no luck with the SVG editors, but I haven't yet gave up on them...
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
Please Log in or Create an account to join the conversation.
- FDR
- Offline
Moeder wrote: In HTML builds, after make html-release the files en.zip, fr.zip etc. Are found in html-devo8 (or 10), each zip contains the subdirectory html-devo8-en and so on.
...
We can change the output process in Makefile if you prefer something else for the upload script.
@Moeder:
Could you change the name of the HTML zip files in the build script to match the directory name they contain?
So they would called like for example: html-devo8-en.zip
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
Didn't cross check though, did it on my mobile phone
Please Log in or Create an account to join the conversation.
- FDR
- Offline
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
I still think we should make nicer pdf filenames.
Please Log in or Create an account to join the conversation.
- Home
- Forum
- Development
- Development
- Updating and internationalizing documentation