DarwinNE / FidoCadJ

FidoCadJ is a free user-friendly vector graphic editor for MacOSX, Linux, Windows and Android with a library of electronic symbols.
http://darwinne.github.io/FidoCadJ/
GNU General Public License v3.0
111 stars 40 forks source link

Dutch translation of the manual #212

Closed JoopN closed 1 year ago

JoopN commented 2 years ago

If I'm going to translate the manual then its not only the manual which has to be translated but also all pictures if there is a part of the menu visible. How are we going to do that? Taking a screenshot is not a problem if you can use the source of the picture, ie download the fcd file, load it into the nationalised version of FidoCadj and make a screenshot. But now the problem where to put in on Github?

JoopN commented 1 year ago

No, that`s not it. I can make a pull-request, but you get it all in the main branch and not in the directory /manual. I think you don't want it in the main branch. So or you set it right in your structure ie "/manual/Dutch-translation" and "/manual/Dutch-translation/images" and "/manual/Dutch-translation/images/icons" or I have to do something which doesn't go. I uploaded with this setup, but it seems of no value with the pull-request or it doesn't show right. All is going to your main branch at present state.

DarwinNE commented 1 year ago

You should just move the files you created under manual/, create the subdirectory where the images should go, make sure everything compiles correctly. You can work in the main branch, there is no need to create another branch for that.

JoopN commented 1 year ago

I'm not sure what you mean, I can't make sub-directories in your repository. This is what I get with pull-request pull-request

There is no way I can change "base:master", so when I do the request you get all in the "master" branch. And I think you don't want that.

DarwinNE commented 1 year ago

I do not understand, maybe there is a certain confusion between directories and branches. Those are two different things. First of all, you will always work on your local copy, then you stage, commit and push the changes to JoopN/FidoCadJ. Make sure you include the files in the right directory and subdirectory.

Then there are the Git branches. You can create a separate branch, or work on the master branch as you wish.

In a second moment you can do the pull request. For small modifications (or less small ones but that do not alter much the core code of FidoCadJ) it is OK to merge in the master branch. It will be my responsibility to review it to accept it or not. I may either ask you to modify something, or I will do the modifications myself, depending what requires less effort.

DarwinNE commented 1 year ago

Hello, I saw pull requests #230 #231 #232, but I haven't had the time to review them. Did you close them? Do you need more information? Even if the files are not in the right spot, I can move them.

JoopN commented 1 year ago

Yes, I did close them, should it stay open? I want to know if you can work with this, so if okay I can also upload the updated English en German manuals. #230 is the directory with the .tex, .pdf and .sh files. #231 is the sub-directory of #230 (but Github don't show it this way) with the images and #232 is the sub-directory of #231 with the icons. It compiles this way, but if it has to be arranged different then this can be set in the preamble. I have all on my home computer, so I can upload again in case of mishap or I can update the manuals with new additions to FidoCadJ. I don't have anything at home in French or Italian (dictionaries), so I can't help you there. I can do some tricks with Google, this could give a rough translation, but it certainly needs a re-reed/edit by someone who is native to those two languages. So this takes some work/time. Up to you.

DarwinNE commented 1 year ago

Yes, you should keep the pull request open if you want me to merge it. I would really like to move on with this project

Please proceed as follows: 1 - Put all the files manual_nl.tex and manuals_nl.pdf related to the Dutch translation of the manual in the "manuals" directory. 2 - Create a directory with a subdirectory "manual/dutch/pic" and put there all the pictures relevant to the Dutch translation only. 3 - Update the compile.sh file. 4 - Create a new pull request. 5 - Leave me some time (at least two weeks) so that I can review your contribution. I may ask you to correct something or I may choose to correct it myself if it is easier.

When the pull request related to the Dutch translation will be merged, you will do the same for the German translation. A not up-to-date French and Italian translation are available, but please do not touch them if you do not speak those languages.

For the update to the English version we are going to discuss later.

Please try to follow the order I described.

JoopN commented 1 year ago

Yes, you should keep the pull request open if you want me to merge it. I would really like to move on with this project

I re-opened the three pull requests

Please proceed as follows: 1 - Put all the files manual_nl.tex and manuals_nl.pdf related to the Dutch translation of the manual in the "manuals" directory. 2 - Create a directory with a subdirectory "manual/dutch/pic" and put there all the pictures relevant to the Dutch translation only.

Tried this before, don't have that choice.

3 - Update the compile.sh file. Not sure what you mean, but the file is setup to compile manual-nl.

A not up-to-date French and Italian translation are available, but please do not touch them if you do not speak those languages.

Had no intention to do that, my proposal was different.

For the update to the English version we are going to discuss later.

Updated English manual is the old manual plus additions, nothing changed in old text except for comments with one picture and one site which is not available anymore. Also pictures are updated to the same degree as in the other manuals. So,don't worry its totally different, its not.

JoopN commented 1 year ago

I have uploaded the German manual (3 files) strait in the manual directory (it was open this time). I made before the upload of the pictures a structure "German/pic" and upload the 42 pictures. I don't know what to do with the icons, you didn't use them with the Dutch translation as far as I can see. They are the same as in the English manual. But in the preamb the directory /images and /images/icons is used. I did setup this way and it will compile. The present structure is different. If you have time left can you change the text "Moved around Dutch manual files." in something like "Dutch manual files" or similar. Want to know if you want your updated English manual as "zip-file" or do you want it named different so you don't loose your origin on Github?

DarwinNE commented 1 year ago

I accepted the pull request #233 , thank you very much for the German translation! I have some questions, I will ask them in #227. You can cross-link to a particular issue from the pull request using the # character followed by the corresponding number. You can also use a more descriptive title for the pull request (that somewhat can describe the commits it contains). It will be easier to refer to it in the future.

For the Dutch manual, I only moved all the files, I do not have yet LaTeX installed on the computer I am currently using (I changed it recently) so I could not try to compile it. It should refer the Dutch pictures, of course in the directory /manual/netherlands/pic.

For the English manual, do not use the zip file. Just edit it, commit the changes, push them on the GitHub server and do another pull request. I will be able to see quite precisely all the changes you do. This is the advantage of version control software such as Git and GitHub will allow me to review the differences in the pull request. I may comment directly on the pull request and ask you to do some changes. It is quite practical.

JoopN commented 1 year ago

I have tried to download .tex files or pictures, but Github has changed the way it works. The downloaded .tex files are HTML files to some degree, but not .tex and certainly not the way its setup. This means you can't process them. Moreover, Latex is a tool for publishing scientific stuff and is by no means a dtp program by far. So the small changes in the manuals for getting the pictures with the text are somewhat lost and every time YOU have to agree with the changes. Editing offline in a dedicated tex editor is not possible.
Said that, no your changes for the pictures won't work. In table 2.1 you use icons and those are also in the translated manuals, no difference there. This means that its a graphical thing, so tex uses the rule in the preamble and in table 2.1 you set it to /icons/icon file. So to be successful you need to have an /icons directory with the icon files in the /pic directory. As Git changed the way it works I think you can at best set the pdf for direct access, it will open in your browser and from there you can download it. This however doesn't work with tex-file. You have to edit it online, but that is way to slow and does have the above problems, you have to agree. But dtp doesn't work that way. So I think its best to make a zip-file for one language, which can be download as a whole, with the tex-file, may be a readme file and directories with the pictures in the right way. That is if you like that other people are willing to make some progress with the program, in present way I doubt that very much. May be this works with Windows or Apple (Github have some manuals about the two), everything else you are on your own. So again 3 days lost for something which could be done in 3 minutes when it was a zip.

DarwinNE commented 1 year ago

Hello, I'm sorry for the difficulties you are experiencing. But I admit I have not fully understood some of the issues you have described. If I can give a suggestion, try to create a dummy project on your own and do some experiences to really understand how Git and Github work. Git and in general version control systems are extremely useful tools when you have to maintain a project with more than 100 lines of code. I am globally very happy to have spent some time learning their basis as they are useful even in my daily work (not related to programming).

I just installed LaTeX on this computer, I will correct all the issues with the Dutch version in the next few days so that the file will compile. I'll let you know.

DarwinNE commented 1 year ago

I corrected the references to the icons. Now the file correctly compiles. Can you please check that everythins is ok?

JoopN commented 1 year ago

I downloaded everything with "Code" and then download zip file. Copied Dutch to a directory and compiled it with TexStudio. No errors, checked with a manual from before update and all looks the same. So Dutch is going okay. Not so with the German. The way how you want to do it does not work that way. The TEX file has no knowledge of what your root is. It works from the directory in which the tex file resides. So all references in the preambule has as root this directory. Going to /images/pic etc will not work because TEX will translate that to /german/pic/images/pic etc. Looks to me you have to setup same way as you did with Dutch, ie convert the ico's to png's and set them in the directory /german/pic.

DarwinNE commented 1 year ago

If the Dutch translation is complete, I close this issue.