- Posts: 796
Updating and internationalizing documentation
- Moeder
- Topic Author
- Offline
That's why I decided we just use the (not so) new cron feature from Travis. You can choose to trigger a build from any branch daily, weekly or monthly; the setup script will then check for $TRAVIS_EVENT_TYPE and only then push new translations to Github. We could also choose to only do the other builds when they are Github triggered, so the cron job is just used for updating the translations, which will in turn trigger a release build of the manual which will include the new translations.
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
Something else: we could limit individual manual builds to only being done if a certain percentage of translations is available in transifex (via tx pull --minimum-perc=MINIMUM_PERC), but I didn't want to make the build process to complex in the beginning.
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
www.transifex.com/deviationtx/deviation-manual/
Registering is free and fast and the whole site very well documented.
Morlacus wrote: But I am interested in translating documentation in french.
So I hope There will be a way to do it
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
I also have to think of a way to get title page translated.
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
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
github.com/DeviationTX/deviation/blob/ma.../fs/language/lang.fr
Please Log in or Create an account to join the conversation.
- vlad_vy
- Offline
- Posts: 3333
make language
Please Log in or Create an account to join the conversation.
- FDR
- Offline
First, congratulations for the completed german translation!
Second, we still have problems with uploading the documentations:
- The devo8 PDSs don't upload for a while because of this after_success condition:
after_success:
- if [[ "$TRAVIS_EVENT_TYPE" == "push" && "$MAKETARGET" == "latexpdf-release" && "$TARGET" == "devo10" ]]; then
make gettext; sphinx-intl -c source/conf.py-intl update -p build/locale; tx push -s;
export TARGET_VERSION=$(echo $TARGET | egrep -o '[[:digit:]]{1,2}');
export TARGET_PDF=$(echo "devo${TARGET_VERSION}manual*.pdf");
echo "Uploading Documentation - $TARGET_PDF";
utils/upload_documentation.pl -documentation -pdf build/pdf-$TARGET/$TARGET_PDF;
fi;
- The old PDF versions are not deleted from the Downloads section. I do delete them manually. I will take care of this...
- Despite I haven't done the HTML upload, we will need a different after_success upload section for them.
- Don't you think we should rather have a special target for the cron job to refresh the translations, instead bounding that to the devo10 PDF build?
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
After fixing the ifs (I just did another update on the PR) im back at 99 %...
I have to admit the model and protocol chapters were reeeeeally long and it was more of duty than joy to finish them
I inserted the devo10 condition because I thought it didn't make too much sense to do many 'make gettext' but it took a while for me to notice this killed the devo8 builds...
I will commit a change for a better .travis.yml
Please Log in or Create an account to join the conversation.
- Moeder
- Topic Author
- Offline
- Posts: 796
Things to do:
1.) There are a one or two tables which look bad now and that will have to be fixed
2.) Wrapping text around images is quite a hassle in LaTeX, I suggest we remove the floatimg macro and replace it with regular image commands in the rst's.
3.) Use Sphinx's figure-language-filename option to use language dependent images. Would you prefer having multiple folders within images or rather make the files imagename.XX.png where XX is language code?
4.) Rename to a better name before uploading PDFs
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
I have found some words which would need to be translated in french in the lang.fr file :
Trainer Sw ; Num Channels ; Momentary : Toggle ; Extend ; offset ; nbr mixer : Mixer ; Delay ;
How to propose a translation. Is there a max length for the translation ?
Where to ask explanations about the original manual ? Is there a sort of bug report for this ? or a specific topic ?
Example : I dont understand the sentence concerning scale in the complex mixer :
Note that while the scale value is limited to 100%, the mixer may provide a value larger than 100% if an offset is set or if the trim value is non-zero
In fact the scale can be fixed from -125 to +125 so what is the limit ?
Please Log in or Create an account to join the conversation.
- FDR
- Offline
github.com/DeviationTX/deviation-manual/issues
BTW that 100% limit is a mistake, probably it wasn't corrected when the scale value vas extended to +-125.
The language files are in the main repository:
github.com/DeviationTX/deviation/tree/master/src/fs/language
They should be corrected there, so the new builds could contain the changes.
make language
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
FDR wrote: The language files are in the main repository:
github.com/DeviationTX/deviation/tree/master/src/fs/language
They should be corrected there, so the new builds could contain the changes.Will get the needed changes into them...make language
Thanks for the reply. Once logged in Github what is the way to ask for or propose change ?
Help will be welcome.
Please Log in or Create an account to join the conversation.
- FDR
- Offline
- you can edit the content online on GitHub and make a pull request from there;
- fork the deviation-manual repository into your own, make the changes offline, commit them into your fork, and make a pull request from there.
If you plan a serious rewrite, the latter is better, but for small changes you can use the first:
Simply open the source file in the browser, for example like this:
github.com/DeviationTX/deviation-manual/...urce/ch_mainpage.rst
Click on the edit (pencil) icon on the upper right, edit the content, and when finished, select the "Create a new branch for this commit and start a pull request" option below, then press the "Commit changes" button.
While it is possible commit directly into the master branch, even so that is the default option, please don't do that.
This way others may check and approve your changes, or request changes to those before the commit can happen, and this helps to keep it clean and regulated...
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
I proposed an update of the lang.fr file in a pull request
Hope did correctly.
Please Log in or Create an account to join the conversation.
- FDR
- Offline
Actually I gave you a description about modifying the deviation-manual repository, but of course the main (repository) is the same.
However to see all the new language entries in the lang.fr file, you need to "make languages" in the docker development environment. It will update all the language files, but you can revert all but yours...
Please Log in or Create an account to join the conversation.
- Morlacus
- Offline
- Posts: 181
I am there (see attachment)
Can you give me more info on docker environment ?
Thanks
Please Log in or Create an account to join the conversation.
- Home
- Forum
- Development
- Development
- Updating and internationalizing documentation