anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-22 10:00:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some material to the section on tex2lyx that explains the need for layout files. We might want to refer to this elsewhere, too.

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@33003 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Richard Heck 2010-01-12 23:11:54 +00:00
parent 0d0390112a
commit 3fef24069a
1 changed files with 255 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

283
lib/doc/Tutorial.lyx
View File

@ -1,5 +1,5 @@
#LyX 1.6.5svn created this file. For more info see http://www.lyx.org/
\lyxformat 345
#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
\lyxformat 376
\begin_document
\begin_header
\textclass book
@ -36,18 +36,27 @@
{LyX}}
\end_preamble
\use_default_options false
\begin_modules
logicalmkup
\end_modules
\maintain_unincluded_children false
\language english
\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\use_xetex false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\default_output_format default
\bibtex_command default
\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
@ -69,21 +78,29 @@
\use_geometry false
\use_amsmath 0
\use_esint 0
\use_mhchem 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 2
\paragraph_separation indent
\defskip medskip
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 2
\paperpagestyle headings
\tracking_changes false
\tracking_changes true
\output_changes false
\author ""
\author ""
\html_use_mathml true
\html_be_strict true
\author 2 "Richard Heck"
\end_header
\begin_body
@ -1782,7 +1799,7 @@ Additional Features
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
<features>
<features tabularvalignment="middle">
<column alignment="center" valignment="top" width="0pt">
<column alignment="center" valignment="top" width="0pt">
<row>
@ -4040,7 +4057,8 @@ Environment
f(x)=\left\{ \begin{array}{cc}
\log_{8}x & x>0\\
0 & x=0\\
\sum_{i=1}^{5}\alpha_{i}+\sqrt{-\frac{1}{x}} & x<0\end{array}\right.\]
\sum_{i=1}^{5}\alpha_{i}+\sqrt{-\frac{1}{x}} & x<0
\end{array}\right.\]
\end_inset
@ -4448,7 +4466,13 @@ reference "sec:preamble"
\end_layout
\begin_layout Subsection
Importing LaTeX Documents —
Importing LaTeX Documents
\change_deleted 2 1263335457
—
\change_inserted 2 1263335459
---
\change_unchanged
\family typewriter
tex2lyx
\family default
@ -4475,47 +4499,250 @@ LaTeX
\family default
menu in LyX.
This will call the program
\family typewriter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
tex2lyx
\family default
\end_layout
\end_inset
which will create a file
\family typewriter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
foo.lyx
\family default
\end_layout
\end_inset
from the file
\family typewriter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
foo.tex
\family default
and then open that file.
\end_layout
\end_inset
\change_inserted 2 1263337184
; LyX will
\change_deleted 2 1263337185
and
\change_unchanged
then open that file.
If the translation does not work, you can try calling
\family typewriter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
tex2lyx
\family default
\end_layout
\end_inset
from the command line, possibly using fancier options.
\end_layout
\begin_layout Standard
\family typewriter
\change_inserted 2 1263337199
Even when the translation does work,
\change_unchanged
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
tex2lyx
\family default
will translate most legal LaTeX, but not everything.
\end_layout
\end_inset
\change_inserted 2 1263337202
may not
\change_deleted 2 1263337203
will
\change_unchanged
translate
\change_deleted 2 1263337205
most legal LaTeX, but not
\change_unchanged
everything
\change_inserted 2 1263337217
, though it does handle most legal LaTeX
\change_unchanged
.
It will leave things it does not understand in TeX mode; so, after translating
a file with
\family typewriter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
tex2lyx
\family default
\end_layout
\end_inset
, you can look for the red text and manually edit it to get it right.
\end_layout
\begin_layout Standard
\begin_inset Flex CharStyle:Code
status collapsed
\family typewriter
\begin_layout Plain Layout
tex2lyx
\family default
has its own manpage.
Read it to find out which LaTeX commands and environments are not supported,
bugs (and how to get around them), and how to use the various options.
\end_layout
\end_inset
has its own
\change_inserted 2 1263337255
documentation
\change_deleted 2 1263337260
manpage.
\change_inserted 2 1263337293
, which *nix users can access via
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\change_inserted 2 1263337285
man tex2lyx
\change_unchanged
\end_layout
\end_inset
.
The manpage describes
\change_deleted 2 1263337296
Read it to find out
\change_unchanged
which LaTeX commands and environments are not supported,
\change_inserted 2 1263335470
what bugs you might run into
\change_deleted 2 1263335471
bugs
\change_unchanged
(and how to get around them), and how to use the various options.
\change_inserted 2 1263335473
\end_layout
\begin_layout Standard
\change_inserted 2 1263337717
It is extremely important to understand that
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\change_inserted 2 1263335502
tex2lyx
\change_unchanged
\end_layout
\end_inset
can only translate files whose document class is
\begin_inset Quotes eld
\end_inset
known
\begin_inset Quotes erd
\end_inset
to LyX, that is, for which there is a corresponding LyX `layout file'.
If there is no layout file, then you will get an error saying that the
conversion could not be performed.
The reason for this is that, in a sense, LyX doesn't know anything about
LaTeX: very little of the information LyX has about LaTeX is contained
in the program itself.
That information is instead contained in layout files.
You can think of the layout file for a document class as a translation
manual between LyX constructs---paragraphs with their corresponding styles,
etc---and the corresponding LaTeX commands and environments.
So, unless you have a layout for
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\change_inserted 2 1263336322
foo.tex
\change_unchanged
\end_layout
\end_inset
's document class,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\change_inserted 2 1263336331
tex2lyx
\change_unchanged
\end_layout
\end_inset
simply will not now how to translate the LaTeX that it finds there into
things LyX understands.
\end_layout
\begin_layout Standard
\change_inserted 2 1263337784
When you installed LyX, you also installed layout files for almost 100 different
document types (though some of these are DocBook, rather than LaTeX).
Still, there are many, many more document classes than that, and new ones
are probably invented every day.
There is no way that LyX itself can include layout files for every document
class you might want to use.
\end_layout
\begin_layout Standard
\change_inserted 2 1263337857
So what can you do if LyX does not include a layout file for your fancy
new document class? Create your own.
If your new document class is based upon, or very similar to, one for which
there already is a layout file, which is true in many cases, then creating
a new layout file may be as easy as copying a file and changing a few lines.
In the other cases, you may have more work to do.
But while you will have to learn a bit, it is not really that difficult,
and many of the people who contribute to the users' mailing list have a
great deal of experience they are willing to share.
\change_unchanged
\end_layout
\begin_layout Standard
\change_inserted 2 1263337162
The format of LyX's layout files and the process of creating new ones are
discussed in detail in Chapter 5 of the
\emph on
Customization
\emph default
manual.
\change_unchanged
\end_layout
\begin_layout Subsection