From 9f372c5dbe495977ed7b66079443ebeb21844567 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Poulain?= Date: Wed, 27 Nov 2013 08:30:56 +0000 Subject: [PATCH] LaTeX: upgrade documentation --- main/convert/latex/man-bugs.en.tm | 59 +++++++------------- main/convert/latex/man-latex2tm.en.tm | 48 ++++++++++++---- main/convert/latex/man-not-implemented.en.tm | 52 +++++------------ main/convert/latex/man-tm2latex.en.tm | 48 +++++++++------- 4 files changed, 98 insertions(+), 109 deletions(-) diff --git a/main/convert/latex/man-bugs.en.tm b/main/convert/latex/man-bugs.en.tm index 09677ba..e48de90 100644 --- a/main/convert/latex/man-bugs.en.tm +++ b/main/convert/latex/man-bugs.en.tm @@ -1,51 +1,30 @@ - + - +> <\body> - + - The most annoying situation if when a converted document - produces lots of errors at the compilation or if the result has nothing to - do with the original. In that case you have probably detected a bug in the - conversion algorithm (or in the installation of on your - system). Please try to figure out the source of the bug in this case and - report it by sending an email to + The most annoying situation if when a converted document produces + lots of errors at the compilation or if the result has nothing to do with + the original. In that case you have probably detected a bug in the + conversion algorithm (or in the installation of on your system). + Please try to figure out the source of the bug in this case and report it + by sending an email to <\verbatim> - \ \ \ \ TeXmacs@math.u-psud.fr + \ \ \ \ texmacs-dev@gnu.org - + - + -<\initial> - <\collection> - - - - - - - - - - - - - - - - -<\references> - <\collection> - |?>> - - + +> \ No newline at end of file diff --git a/main/convert/latex/man-latex2tm.en.tm b/main/convert/latex/man-latex2tm.en.tm index b261297..9193369 100644 --- a/main/convert/latex/man-latex2tm.en.tm +++ b/main/convert/latex/man-latex2tm.en.tm @@ -1,6 +1,6 @@ - + - +> <\body> to > @@ -13,10 +13,10 @@ is more problematic than conversions the other way around. As long as you restrict yourself to using the most common commands, the conversion process should not give rise to any major difficulties. - However, as soon as your documents contain ``weird macro definitions'', - then the converter may get confused. We also notice that is - currently unable to convert style files and no plans exist to - enhance the converter in this direction. + However, as soon as your documents contain ``weird primitives'' + (think about ...), then the converter may get confused. + We also notice that is currently unable to convert style + files and no plans exist to enhance the converter in this direction. There are two major reasons for documents to get imported in an inappropriate way, and which can easily be corrected by the user. First of @@ -41,7 +41,34 @@ style package with counterparts for the macros which were not recognized. - + The behaviour of the converter may be customized using several user + preferences in the TeXmacs> + menu: + + <\description-long> + This option allows + to compile the document in a temporary directory, with + the package installed, in order to import some macros + or environments as pictures. The source of each picture is also imported + in order to be re-exported if needed. Currently, the following macros are + imported as pictures when this option is set: , + , . + + source code>One should be interested in + this option in order to use to make small or isolated + modifications into a file (e.g. for a proofreading). This option + allows to import the document with added markup in + order to track the original sources of the document paragraphs. These + tracked sources are, as far as possible, re-used during a + re-export. + + This option, subject to the above, + verify that the added markup does not change the result of the + conversion. It has been added for testing purpose and may + increase the time of the import process (at least it double it). + + + -<\initial> - <\collection> - - - \ No newline at end of file + +> \ No newline at end of file diff --git a/main/convert/latex/man-not-implemented.en.tm b/main/convert/latex/man-not-implemented.en.tm index 8d20f7b..63134db 100644 --- a/main/convert/latex/man-not-implemented.en.tm +++ b/main/convert/latex/man-not-implemented.en.tm @@ -1,9 +1,9 @@ - + - +> <\body> - + Although we try to keep the conversion algorithm as complete as possible for your needs, certain things have not yet been implemented. Some examples @@ -12,8 +12,6 @@ <\itemize> Non standard fonts. - Conversion of tabulars. - Style parameters. @@ -26,40 +24,18 @@ and we will try to incorporate it as quickly as possible. It may take some time to implement the correct conversion of style parameters, since these - are not the same in and . Furthermore, layout - differences between and can not entirely be - eliminated. + are not the same in and . Furthermore, layout differences + between and can not entirely be eliminated. - + - + -<\initial> - <\collection> - - - - - - - - - - - - - - - - -<\references> - <\collection> - |?>> - - + +> \ No newline at end of file diff --git a/main/convert/latex/man-tm2latex.en.tm b/main/convert/latex/man-tm2latex.en.tm index f8e6c54..a681e32 100644 --- a/main/convert/latex/man-tm2latex.en.tm +++ b/main/convert/latex/man-tm2latex.en.tm @@ -1,6 +1,6 @@ - + - +> <\body> to > @@ -16,7 +16,7 @@ Notice that the exportation of a document with images may cause the creation of additional image files. If your destination file is called , these files are named , - >, and they are stored in the same + >, and they are stored in the same directory. In particular, all pictures drawn with the editor, and all images which are not already in format, will be converted to encapsulated files. @@ -25,7 +25,7 @@ files and packages or macros with no equivalents are either ignored or replaced by a reasonable substitute. The precise behaviour of the converter may be customized using several user preferences in the - LaTeX> menu: + LaTeX> menu: <\description-long> >This option (which is set by @@ -33,7 +33,7 @@ equivalents by the style. Furthermore, all additional style packages are ignored. - In the case when you know how to , then you might wish to create equivalents of certain journal styles which you often use. Similarly, you might wish to create a style package with your own macros @@ -72,13 +72,6 @@ using >. In this case, you need to enable the option. - >By default, accented - characters like ``é'' are exported to as . In - order to increase readability and especially in case that you want to - edit the resulting file, you may wish to keep the accented - characters ``as is''. This can be achieved by allowing to put - additional catcode definitions into your preamble. - >Certain macros like have no direct analogues. For a certain number of frequently used macros, automatically @@ -91,6 +84,25 @@ of additional macros in the preamble. When disallowing for macro definitions in preambles, will automatically expand all corresponding macro applications. + + This define the behavior of the converter with + respect to characters encoding. There is three possible choices: + + <\description> + This will generate document + with the package loaded. If, for any reason, you + don't want to rely on , you should consider others + options. + + This keep the accented characters ``as is''. + This can be achieved by allowing to put additional catcode + definitions into your preamble. This provides a good trade-off between + readability (accented characters are kept in a 8 bit charset) and + simplicity (you don't need the package). + + This will generate pure ascii characters, using plain + sequencies to compose non-ascii symbols. + Sometimes, the converter does not produce a satisfactory file even @@ -119,7 +131,8 @@ Type the latex code with the correct hyphenation. - Press to activate the -specific text. + Press to activate the -specific + text. In a similar fashion, you may insert -specific line breaks, page @@ -127,7 +140,7 @@ force arbitrary content to be exported as an image using . - + -<\initial> - <\collection> - - - \ No newline at end of file + +> \ No newline at end of file