Re: [TeXstudio-list] Translating the documentation
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-01 16:44:10
|
Le samedi 01/09/12 à 18h27, sunderme <sunderme@...> a écrit : > Hi Denis, Hi Jan, > what exactly do you need? Nothing special: as Tim asked for contacting TXS team, I did it in case you could let me know of useful information(s). If not, I guess I could manage :) > there is very old usermanual from texmaker in French, but that is > probably not useful any more ... Indeed: I'm starting from scratch, that is from the current usermanual_en.html file. -- Denis |
Thread view
|
From: sunderme <sunderme@gm...> - 2012-09-01 16:27:11
Attachments:
Message as HTML
|
Hi Denis, what exactly do you need? there is very old usermanual from texmaker in French, but that is probably not useful any more ... JanDenis Bitouzé <dbitouze@...> hat geschrieben:Hi, I'm starting to translate the documentation in French. Tim asked for contacting the TXS team for this purpose, so here I am :) -- Denis ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ _______________________________________________ TeXstudio-list mailing list TeXstudio-list@... https://lists.sourceforge.net/lists/listinfo/texstudio-list |
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-01 16:44:10
|
Le samedi 01/09/12 à 18h27, sunderme <sunderme@...> a écrit : > Hi Denis, Hi Jan, > what exactly do you need? Nothing special: as Tim asked for contacting TXS team, I did it in case you could let me know of useful information(s). If not, I guess I could manage :) > there is very old usermanual from texmaker in French, but that is > probably not useful any more ... Indeed: I'm starting from scratch, that is from the current usermanual_en.html file. -- Denis |
|
From: Tim Hoffmann <hoffmann@hi...> - 2012-09-01 18:47:26
|
Hi all, In the first place, the notification was just to know when anyone is starting a translation. Second, at that time, there has been some outdated stuff in the English file and I wanted to warn a translator about that. However, I think Jan and Benito have fixed most of it, though I didn't have time to thoroughly check. Ok, and finally the useful information :) There are some issues with the current manual, that you should be aware of at least, before literally translating it: A: SVN location A separate directory could be useful Trunk -> utilities -> manual B: Structure I'm not very happy with the current structure of the document. It's rather a technical documentation and not a instructive user manual. You have to scroll past all the "what's new entries" and the detailed configuration settings before you learn how to use the editor. I think the following structure would be more suited. 1. Tutorial 1.1 Basic configuration to get the editor working (Have Latex installed, check that the commands are available) 1.2 Writing and compiling a simple document 2. Editing a TeX document (current chapter 2) 3. Building TeX a document 3.1. The LaTeX build process 3.2. TXS Build Framework 4. TXS Configuration (current chapter 1) 5. Other features (current chapter 4 - only the sections that don't fit in any other category) 6. 6.1 What's new 6.2 Synopsis of the TeXstudio command 6.3 Description of the cwl format I want to change the document towards that direction - provided there are no objections from the other developers. Since it's not done yet, I'll leave the decision up to you, if you literally translate the current version or already change some things. I just let you know, that the present structure may change (maybe in a few weeks or so, if I have time). C: html code I think it could use some cleanup. - Use descriptive ids in the html, i.e. id="config-autocompletion" instead of id="SECTION040". It's more easy to reference and to reorder. - There are some formatting parameters that should rather be defined via CSS e.g. border=1 - The paragraphs are a mix of <p> and <br>. I think that's not good style. Also I'm not sure on the use of <p> around <img> - Furthermore, it would make sense to put every chapter in a separate <div> - Maybe more. D: Fomat style I just quickly hacked together the CSS. I think it could need a little tuning, but it's ok in the present state. However, if you have ideas for improvement, you may implement them. E: Images It should be decided, if the images should be localized or not. If so, a images_fr subfolder would be reasonable (as well as images_en). Tim > -----Ursprüngliche Nachricht----- > Von: Denis Bitouzé [mailto:dbitouze@...] > Gesendet: Samstag, 1. September 2012 18:43 > An: texstudio-list@... > Betreff: Re: [TeXstudio-list] Translating the documentation > > Le samedi 01/09/12 à 18h27, > sunderme <sunderme@...> a écrit : > > > Hi Denis, > > Hi Jan, > > > what exactly do you need? > > Nothing special: as Tim asked for contacting TXS team, I did it in case you could > let me know of useful information(s). If not, I guess I could manage :) > > > there is very old usermanual from texmaker in French, but that is > > probably not useful any more ... > > Indeed: I'm starting from scratch, that is from the current usermanual_en.html > file. > -- > Denis > > ---------------------------------------------------------------------------- -- > Live Security Virtual Conference > Exclusive live event will cover all the ways today's security and threat > landscape has changed and how IT managers can respond. Discussions will > include endpoint security, mobile security and the latest in malware threats. > http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ > _______________________________________________ > TeXstudio-list mailing list > TeXstudio-list@... > https://lists.sourceforge.net/lists/listinfo/texstudio-list |
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-01 22:24:34
|
Le samedi 01/09/12 à 20h47, "Tim Hoffmann" <hoffmann@...> a écrit : > In the first place, the notification was just to know when anyone is > starting a translation. Second, at that time, there has been some > outdated stuff in the English file and I wanted to warn a translator > about that. That's what I suspected :) > However, I think Jan and Benito have fixed most of it, though I > didn't have time to thoroughly check. > > Ok, and finally the useful information :) There are some issues with > the current manual, That's also what I suspected :) > that you should be aware of at least, before literally translating it: > > A: SVN location > A separate directory could be useful > Trunk -> utilities -> manual Should be useful. > B: Structure > I'm not very happy with the current structure of the document. It's > rather a technical documentation and not a instructive user manual. I strongly agree. > You have to scroll past all the "what's new entries" and the detailed > configuration settings before you learn how to use the editor. I > think the following structure would be more suited. > 1. Tutorial Nice idea. > 1.1 Basic configuration to get the editor working (Have Latex > installed, check that the commands are available) > 1.2 Writing and compiling a simple document OK. > 2. Editing a TeX document (current chapter 2) OK. BTW, the "2.6 Spacings" relies on bad practice of LaTeX (\\ should be avoided in paragraphs). > 3. Building TeX a document > 3.1. The LaTeX build process > 3.2. TXS Build Framework OK. The Build Framework may be hard to understand by a newbie. > 4. TXS Configuration (current chapter 1) OK. > 5. Other features (current chapter 4 - only the sections that don't > fit in any other category) OK. > 6. > 6.1 What's new > 6.2 Synopsis of the TeXstudio command > 6.3 Description of the cwl format Why not "What's new" in the last position? Often, the changelog is at the end. > I want to change the document towards that direction - provided there > are no objections from the other developers. Other opinions? > Since it's not done yet, I'll leave the decision up to you, if you > literally translate the current version or already change some > things. I didn't change anything for the moment, except some precisions I added when it was not that clear, especially for beginners. > I just let you know, that the present structure may change OK. > (maybe in a few weeks or so, if I have time). Before or after the next release? > C: html code > I think it could use some cleanup. > - Use descriptive ids in the html, i.e. id="config-autocompletion" > instead of id="SECTION040". It's more easy to reference and to > reorder. > - There are some formatting parameters that should rather be defined > via CSS e.g. border=1 > - The paragraphs are a mix of <p> and <br>. I think that's not good > style. Also I'm not sure on the use of <p> around <img> > - Furthermore, it would make sense to put every chapter in a separate > <div> > - Maybe more. I agree. Why not using a .tex file to be converted in .html with TeX4Ht or other translators? I'm much more efficient in LaTeX than in HTML. And, for instance, the table of contents is automatically generated. > D: Fomat style > I just quickly hacked together the CSS. I think it could need a little > tuning, but it's ok in the present state. However, if you have ideas > for improvement, you may implement them. Not for the moment: it is rather nice. Note that, at least on Linux, the usermanual.css file isn't installed in the installation directory of TXS by the build process. > E: Images > It should be decided, if the images should be localized or not. I strongly recommend to localize them! > If so, a images_fr subfolder would be reasonable (as well as > images_en). Agree. -- Denis |
|
From: Tim Hoffmann <hoffmann@hi...> - 2012-09-01 22:44:53
|
> Von: Denis Bitouzé [mailto:dbitouze@...] > Gesendet: Sonntag, 2. September 2012 00:24 > > 6.1 What's new > > 6.2 Synopsis of the TeXstudio command > > 6.3 Description of the cwl format > > Why not "What's new" in the last position? Often, the changelog is at the end. Fine by me. > > (maybe in a few weeks or so, if I have time). > > Before or after the next release? Definitively after. The next release is about to appear. > I agree. Why not using a .tex file to be converted in .html with TeX4Ht or other > translators? I'm much more efficient in LaTeX than in HTML. > And, for instance, the table of contents is automatically generated. This is a good idea. I haven't used it so far. But I'll consider it for the renewal of the manual. > > D: Fomat style > > I just quickly hacked together the CSS. I think it could need a little > > tuning, but it's ok in the present state. However, if you have ideas > > for improvement, you may implement them. > > Not for the moment: it is rather nice. Note that, at least on Linux, the > usermanual.css file isn't installed in the installation directory of TXS by the build > process. Thanks for the hint. I haven't bothered with the installer until now. Benito or Jan, could you please check that? (I may also be missing in the windows installer, since I simply added the file to the SVN some time ago). |
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-02 09:15:33
|
Le dimanche 02/09/12 à 00h44, "Tim Hoffmann" <hoffmann@...> a écrit : > Definitively after. OK. > The next release is about to appear. Could you be more precise? I guess I'll be able to provide a translation for the current documentation in 3 or 4 days if I hurry. But if it would be too late, I'll postpone this work and maybe wait for the renewal of the manual. > > I agree. Why not using a .tex file to be converted in .html with > > TeX4Ht or other translators? I'm much more efficient in LaTeX than > > in HTML. And, for instance, the table of contents is automatically > > generated. > > This is a good idea. I haven't used it so far. But I'll consider it > for the renewal of the manual. Another benefit would be to be able to provide also a .pdf version of the manual. -- Denis |
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-02 20:51:21
|
Le dimanche 02/09/12 à 00h44, "Tim Hoffmann" <hoffmann@...> a écrit : > > I agree. Why not using a .tex file to be converted in .html with > > TeX4Ht or other translators? I'm much more efficient in LaTeX than > > in HTML. And, for instance, the table of contents is automatically > > generated. > > This is a good idea. I'm in the process to translate (thanks to htmltolatex and manual corrections) the .html to a .tex file and a first draft may be found here: http://gte.univ-littoral.fr/members/dbitouze/pub/latex/divers/usermanual_en-tar-gz/downloadFile/file/usermanual_en.tar.gz The usermanual_en.tex is the source from which are generated: 1. the usermanual_en.pdf file that comes from a simple: pdflatex usermanual_en 2 the usermanual_en.html and usermanual_en.css files that come from: htlatex usermanual_en "html,fn-in,charset=utf-8" " -cunihtf -utf8" For the moment: a) there are compilation errors but the .html file seems to be OK, b) I'm unable to recreate the Tim's usermanual.css file but it should not be difficult to manage. Please note that some work has still to be done! At least two benefits of this approach are: 1. with very nice TeX editors as TXS or emacs, it is a pleasure to edit the .tex source file ;) 2. the logical and visual markups can be much distinguished with a .tex file than with a .html and a .css files. Regards. -- Denis |
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-03 05:44:41
|
Le dimanche 02/09/12 à 22h50, Denis Bitouzé <dbitouze@...> a écrit : > I'm in the process to translate (thanks to htmltolatex and manual > corrections) the .html to a .tex file and a first draft may be found > here: > > http://gte.univ-littoral.fr/members/dbitouze/pub/latex/divers/usermanual_en-tar-gz/downloadFile/file/usermanual_en.tar.gz Sorry, the slave file verylongtable.tex was missing. It should be OK by now. -- Denis |
|
From: Denis Bitouzé <dbitouze@wa...> - 2012-09-03 05:47:12
|
Le lundi 03/09/12 à 07h43, Denis Bitouzé <dbitouze@...> a écrit : > It should be OK by now. And the TeX4Ht compilation error is dropped. -- Denis |