texmacs
/
doc
mirror of https://github.com/texmacs/doc.git
1
0
Fork 0
Code

LaTeX: upgrade documentation

This commit is contained in:
François Poulain 2013-11-27 08:30:56 +00:00
parent 33f8eb96a1
commit 9f372c5dbe
4 changed files with 98 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
main/convert/latex/man-bugs.en.tm
View File

@ -1,51 +1,30 @@
<TeXmacs|1.0.0.8> <TeXmacs|1.0.7.21>
<style|tmdoc> <style|<tuple|tmdoc|english>>
<\body> <\body>
<expand|tmdoc-title|Bugs in the conversion algorithm> <tmdoc-title|Bugs in the conversion algorithm>
The most annoying situation if when a converted <apply|TeXmacs> document The most annoying situation if when a converted <TeXmacs> document produces
produces lots of errors at the compilation or if the result has nothing to lots of errors at the compilation or if the result has nothing to do with
do with the original. In that case you have probably detected a bug in the the original. In that case you have probably detected a bug in the
conversion algorithm (or in the installation of <apply|LaTeX> on your conversion algorithm (or in the installation of <LaTeX> on your system).
system). Please try to figure out the source of the bug in this case and Please try to figure out the source of the bug in this case and report it
report it by sending an email to by sending an email to
<\verbatim> <\verbatim>
\ \ \ \ TeXmacs@math.u-psud.fr \ \ \ \ texmacs-dev@gnu.org
</verbatim> </verbatim>
<apply|tmdoc-copyright|1998--2002|Joris van der Hoeven> <tmdoc-copyright|1998--2013|Joris van der Hoeven, François Poulain>
<expand|tmdoc-license|Permission is granted to copy, distribute and/or <tmdoc-license|Permission is granted to copy, distribute and/or modify this
modify this document under the terms of the GNU Free Documentation License, document under the terms of the GNU Free Documentation License, Version 1.1
Version 1.1 or any later version published by the Free Software Foundation; or any later version published by the Free Software Foundation; with no
with no Invariant Sections, with no Front-Cover Texts, and with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Back-Cover Texts. A copy of the license is included in the section entitled Texts. A copy of the license is included in the section entitled "GNU Free
"GNU Free Documentation License".> Documentation License".>
</body> </body>
<\initial> <initial|<\collection>
<\collection> </collection>>
<associate|paragraph width|150mm>
<associate|odd page margin|30mm>
<associate|shrinking factor|4>
<associate|page right margin|30mm>
<associate|page top margin|30mm>
<associate|reduction page right margin|25mm>
<associate|page type|a4>
<associate|reduction page bottom margin|15mm>
<associate|even page margin|30mm>
<associate|reduction page left margin|25mm>
<associate|page bottom margin|30mm>
<associate|reduction page top margin|15mm>
<associate|language|english>
</collection>
</initial>
<\references>
<\collection>
<associate|toc-1|<tuple|<uninit>|?>>
</collection>
</references>

48
main/convert/latex/man-latex2tm.en.tm
View File

@ -1,6 +1,6 @@
<TeXmacs|1.0.5.10> <TeXmacs|1.0.7.21>
<style|tmdoc> <style|<tuple|tmdoc|english>>
<\body> <\body>
<tmdoc-title|Conversion from <LaTeX> to <TeXmacs>> <tmdoc-title|Conversion from <LaTeX> to <TeXmacs>>
@ -13,10 +13,10 @@
<TeXmacs> is more problematic than conversions the other way around. As <TeXmacs> is more problematic than conversions the other way around. As
long as you restrict yourself to using the most common <LaTeX> commands, long as you restrict yourself to using the most common <LaTeX> commands,
the conversion process should not give rise to any major difficulties. the conversion process should not give rise to any major difficulties.
However, as soon as your documents contain ``weird macro definitions'', However, as soon as your documents contain ``weird <TeX> primitives''
then the converter may get confused. We also notice that <TeXmacs> is (think about <verbatim|\\csname>...), then the converter may get confused.
currently unable to convert <LaTeX> style files and no plans exist to We also notice that <TeXmacs> is currently unable to convert <LaTeX> style
enhance the converter in this direction. files and no plans exist to enhance the converter in this direction.
There are two major reasons for <LaTeX> documents to get imported in an There are two major reasons for <LaTeX> documents to get imported in an
inappropriate way, and which can easily be corrected by the user. First of inappropriate way, and which can easily be corrected by the user. First of
@ -41,7 +41,34 @@
style package with <TeXmacs> counterparts for the macros which were not style package with <TeXmacs> counterparts for the macros which were not
recognized. recognized.
<tmdoc-copyright|1998--2005|Joris van der Hoeven> The behaviour of the converter may be customized using several user
preferences in the <menu|Edit|Preferences|Converters|LaTeX|LaTeX--\<gtr\>TeXmacs>
menu:
<\description-long>
<item*|Import sophisticated objects as pictures>This option allows
<TeXmacs> to compile the <LaTeX> document in a temporary directory, with
the package <verbatim|preview> 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: <verbatim|\\xymatrix>,
<verbatim|pspicture>, <verbatim|tikzpicture>.
<item*|Keep track of the <LaTeX> source code>One should be interested in
this option in order to use <TeXmacs> to make small or isolated
modifications into a <LaTeX> file (e.g. for a proofreading). This option
allows <TeXmacs> to import the <LaTeX> 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 <LaTeX>
re-export.
<item*|Ensure transparent tracking>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 <em|strongly>
increase the time of the import process (at least it double it).
</description-long>
<tmdoc-copyright|1998--2013|Joris van der Hoeven, François Poulain>
<tmdoc-license|Permission is granted to copy, distribute and/or modify this <tmdoc-license|Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.1 document under the terms of the GNU Free Documentation License, Version 1.1
@ -51,8 +78,5 @@
Documentation License".> Documentation License".>
</body> </body>
<\initial> <initial|<\collection>
<\collection> </collection>>
<associate|language|english>
</collection>
</initial>

52
main/convert/latex/man-not-implemented.en.tm
View File

@ -1,9 +1,9 @@
<TeXmacs|1.0.0.17> <TeXmacs|1.0.7.21>
<style|tmdoc> <style|<tuple|tmdoc|english>>
<\body> <\body>
<expand|tmdoc-title|Not yet implemented conversions> <tmdoc-title|Not yet implemented conversions>
Although we try to keep the conversion algorithm as complete as possible Although we try to keep the conversion algorithm as complete as possible
for your needs, certain things have not yet been implemented. Some examples for your needs, certain things have not yet been implemented. Some examples
@ -12,8 +12,6 @@
<\itemize> <\itemize>
<item>Non standard fonts. <item>Non standard fonts.
<item>Conversion of tabulars.
<item>Style parameters. <item>Style parameters.
</itemize> </itemize>
@ -26,40 +24,18 @@
and we will try to incorporate it as quickly as possible. It may take some 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 time to implement the correct conversion of style parameters, since these
are not the same in <apply|TeXmacs> and <apply|LaTeX>. Furthermore, layout are not the same in <TeXmacs> and <LaTeX>. Furthermore, layout differences
differences between <apply|TeXmacs> and <apply|LaTeX> can not entirely be between <TeXmacs> and <LaTeX> can not entirely be eliminated.
eliminated.
<apply|tmdoc-copyright|1998--2002|Joris van der Hoeven> <tmdoc-copyright|1998--2013|Joris van der Hoeven>
<expand|tmdoc-license|Permission is granted to copy, distribute and/or <tmdoc-license|Permission is granted to copy, distribute and/or modify this
modify this document under the terms of the GNU Free Documentation License, document under the terms of the GNU Free Documentation License, Version 1.1
Version 1.1 or any later version published by the Free Software Foundation; or any later version published by the Free Software Foundation; with no
with no Invariant Sections, with no Front-Cover Texts, and with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Back-Cover Texts. A copy of the license is included in the section entitled Texts. A copy of the license is included in the section entitled "GNU Free
"GNU Free Documentation License".> Documentation License".>
</body> </body>
<\initial> <initial|<\collection>
<\collection> </collection>>
<associate|paragraph width|150mm>
<associate|odd page margin|30mm>
<associate|shrinking factor|4>
<associate|page right margin|30mm>
<associate|page top margin|30mm>
<associate|reduction page right margin|25mm>
<associate|page type|a4>
<associate|reduction page bottom margin|15mm>
<associate|even page margin|30mm>
<associate|reduction page left margin|25mm>
<associate|page bottom margin|30mm>
<associate|reduction page top margin|15mm>
<associate|language|english>
</collection>
</initial>
<\references>
<\collection>
<associate|toc-1|<tuple|<uninit>|?>>
</collection>
</references>

48
main/convert/latex/man-tm2latex.en.tm
View File

@ -1,6 +1,6 @@
<TeXmacs|1.0.5.11> <TeXmacs|1.0.7.21>
<style|tmdoc> <style|<tuple|tmdoc|english>>
<\body> <\body>
<tmdoc-title|Conversion from <TeXmacs> to <LaTeX>> <tmdoc-title|Conversion from <TeXmacs> to <LaTeX>>
@ -16,7 +16,7 @@
Notice that the exportation of a <TeXmacs> document with images may cause Notice that the exportation of a <TeXmacs> document with images may cause
the creation of additional image files. If your destination file is called the creation of additional image files. If your destination file is called
<verbatim|name.tex>, these files are named <verbatim|name-1.eps>, <verbatim|name.tex>, these files are named <verbatim|name-1.eps>,
<group|<verbatim|name-2.eps>>, <abbr|etc.> and they are stored in the same <rigid|<verbatim|name-2.eps>>, <abbr|etc.> and they are stored in the same
directory. In particular, all pictures drawn with the editor, and all directory. In particular, all pictures drawn with the editor, and all
images which are not already in <name|Postscript> format, will be converted images which are not already in <name|Postscript> format, will be converted
to encapsulated <name|Postscript> files. to encapsulated <name|Postscript> files.
@ -25,7 +25,7 @@
files and packages or macros with no <LaTeX> equivalents are either ignored files and packages or macros with no <LaTeX> equivalents are either ignored
or replaced by a reasonable substitute. The precise behaviour of the or replaced by a reasonable substitute. The precise behaviour of the
converter may be customized using several user preferences in the converter may be customized using several user preferences in the
<menu|Edit|Preferences|Converters|TeXmacs-\<gtr\>LaTeX> menu: <menu|Edit|Preferences|Converters|LaTeX|TeXmacs--\<gtr\>LaTeX> menu:
<\description-long> <\description-long>
<item*|<menu|Replace unrecognized styles>>This option (which is set by <item*|<menu|Replace unrecognized styles>>This option (which is set by
@ -33,7 +33,7 @@
equivalents by the <verbatim|letter> style. Furthermore, all additional equivalents by the <verbatim|letter> style. Furthermore, all additional
style packages are ignored. style packages are ignored.
In the case when you know how to <hyper-link|write your own style In the case when you know how to <hlink|write your own style
files|../../../devel/style/style.en.tm>, then you might wish to create files|../../../devel/style/style.en.tm>, then you might wish to create
<TeXmacs> equivalents of certain journal styles which you often use. <TeXmacs> equivalents of certain journal styles which you often use.
Similarly, you might wish to create a style package with your own macros Similarly, you might wish to create a style package with your own macros
@ -72,13 +72,6 @@
using <name|Bib<TeX>>. In this case, you need to enable the <menu|Export using <name|Bib<TeX>>. In this case, you need to enable the <menu|Export
bibliographies as links> option. bibliographies as links> option.
<item*|<menu|Use catcode definitions in preamble>>By default, accented
characters like ``é'' are exported to <LaTeX> as <verbatim|\\'e>. In
order to increase readability and especially in case that you want to
edit the resulting <LaTeX> file, you may wish to keep the accented
characters ``as is''. This can be achieved by allowing <TeXmacs> to put
additional catcode definitions into your preamble.
<item*|<menu|Allow for macro definitions in preamble>>Certain <TeXmacs> <item*|<menu|Allow for macro definitions in preamble>>Certain <TeXmacs>
macros like <markup|strong> have no direct <LaTeX> analogues. For a macros like <markup|strong> have no direct <LaTeX> analogues. For a
certain number of frequently used macros, <TeXmacs> automatically certain number of frequently used macros, <TeXmacs> automatically
@ -91,6 +84,25 @@
of additional macros in the preamble. When disallowing for macro of additional macros in the preamble. When disallowing for macro
definitions in preambles, <TeXmacs> will automatically expand all definitions in preambles, <TeXmacs> will automatically expand all
corresponding macro applications. corresponding macro applications.
<item*|Character encoding>This define the behavior of the converter with
respect to characters encoding. There is three possible choices:
<\description>
<item*|Utf-8 with inputenc>This will generate <verbatim|utf-8> document
with the package <verbatim|inputenc> loaded. If, for any reason, you
don't want to rely on <verbatim|inputenc>, you should consider others
options.
<item*|Cork with catcodes>This keep the accented characters ``as is''.
This can be achieved by allowing <TeXmacs> 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 <verbatim|inputenc> package).
<item*|Ascii>This will generate pure ascii characters, using plain
<TeX> sequencies to compose non-ascii symbols.
</description>
</description-long> </description-long>
Sometimes, the converter does not produce a satisfactory <LaTeX> file even Sometimes, the converter does not produce a satisfactory <LaTeX> file even
@ -119,7 +131,8 @@
<item>Type the latex code <verbatim|blauw\\-bil\\-gor\\-gel> with the <item>Type the latex code <verbatim|blauw\\-bil\\-gor\\-gel> with the
correct hyphenation. correct hyphenation.
<item>Press <shortcut|(kbd-return)> to activate the <LaTeX>-specific text. <item>Press <shortcut|(kbd-return)> to activate the <LaTeX>-specific
text.
</enumerate> </enumerate>
In a similar fashion, you may insert <LaTeX>-specific line breaks, page In a similar fashion, you may insert <LaTeX>-specific line breaks, page
@ -127,7 +140,7 @@
force arbitrary content to be exported as an image using force arbitrary content to be exported as an image using
<menu|Format|Specific|Image>. <menu|Format|Specific|Image>.
<tmdoc-copyright|1998--2002|Joris van der Hoeven> <tmdoc-copyright|1998--2013|Joris van der Hoeven, François Poulain>
<tmdoc-license|Permission is granted to copy, distribute and/or modify this <tmdoc-license|Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.1 document under the terms of the GNU Free Documentation License, Version 1.1
@ -137,8 +150,5 @@
Documentation License".> Documentation License".>
</body> </body>
<\initial> <initial|<\collection>
<\collection> </collection>>
<associate|language|english>
</collection>
</initial>