anne/lyx_mirror
1
0
Fork 0
mirror of https://git.lyx.org/repos/lyx.git synced 2025-01-08 18:19:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updates by Helge, Angus and me

Browse Source 
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@10740 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Martin Vermeer 2006-01-16 10:40:30 +00:00
parent d45d976bfb
commit 395bdd8dea
4 changed files with 326 additions and 268 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/doc/ChangeLog
View File

@ -1,3 +1,22 @@
2006-01-16 Martin Vermeer <martin.vermeer@hut.fi> (committed)
* UserGuide.lyx: Corrected information about nesting:
- sections etc can be nested into other environments,
so removed information about this being impossible.
- An abstract can be nested, and other stuff may be nested
into it, removed information about this being impossible
- A caption can be nested into other paragraphs, removed
the "vice versa" indicating this being impossible.
- Updated the lists in section "What You Can and Can't Nest"
to reflect reality.
(Helge Hafting <helge.hafting@aitel.hist.no>)
* UserGuide.lyx:
* Intro.lyx:
* Tutorial.lyx: A large number of updates needed due to changes
since 1.3.
(Angus Leeming <leeming@lyx.org>, Martin Vermeer)
2006-01-01 Angus Leeming <leeming@lyx.org>
* *.lyx: update all files to the latest file format.

4
lib/doc/Intro.lyx
View File

@ -514,7 +514,7 @@ Granted, many modern word processors can handle mathematical symbols, tables,
WYSIWYM concept.
However, they've only recently been able to do so, whereas LyX is built
upon the LaTeX document preparation system.
LaTeX has been around for over 15 years, and
LaTeX has been around for decades, and
\emph on
works
\emph default
@ -1677,7 +1677,7 @@ Contributing to LyX
\end_layout
\begin_layout Standard
LyX is mostly written in C++ (the LaTeX importer is written in Perl).
LyX is mostly written in C++.
It is a large project, and as a result it is not free from bugs, or the
need for improvements in the source code.
\end_layout

117
lib/doc/Tutorial.lyx
View File

@ -45,7 +45,11 @@ Amir Karger
\noun default
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list, <lyx-docs@lists.lyx.org>.
Documentation mailing list,
\family typewriter
lyx-docs@lists.lyx.org
\family default
.
\end_layout
\end_inset
@ -2213,7 +2217,7 @@ exercise
\begin_inset Quotes erd
\end_inset
here; just write a letter to someone
here; just write a letter to someone!
\begin_inset Foot
status collapsed
@ -2237,7 +2241,7 @@ Environment
\end_inset
!
\end_layout
\begin_layout Standard
@ -2493,7 +2497,6 @@ LyX puts the references in a box right where the cursor was.
In the printed document, this reference marker will be replaced with either
the page or section number (depending on what you selected in the
\family sans
Insert\InsetSpace ~
Reference
\family default
dialog).
@ -2546,7 +2549,7 @@ Reference
\family sans
Go\InsetSpace ~
to\InsetSpace ~
reference
Label
\family default
will move the cursor to the referenced label.
\end_layout
@ -2593,10 +2596,9 @@ If you want some more practice with labels, then try putting a new label
If you'll be inserting cross-references often (if, for example, you're
writing a journal article), it may be convenient to leave the
\family sans
Insert\InsetSpace ~
Reference
\family default
window open.
dialog open.
\end_layout
\begin_layout Standard
@ -2923,10 +2925,9 @@ nsert\SpecialChar \menuseparator
\bar under
C
\bar default
itation\InsetSpace ~
Reference\SpecialChar \@.
itation
\family default
.
A
\family sans
Citation
@ -2953,12 +2954,11 @@ lyxtutorial
\begin_layout Standard
How are the other fields used? The
\family sans
Text\InsetSpace ~
aft
\bar under
e
T
\bar default
r
ext\InsetSpace ~
after
\family default
field in the
\family sans
@ -2985,7 +2985,8 @@ abel
field in the
\family sans
Bibliography\InsetSpace ~
item
Entry\InsetSpace ~
Settings
\family default
dialog.
As usual, you can see the
@ -4349,7 +4350,7 @@ G
\bar default
raphics
\family default
\SpecialChar \@.
.
Then click on the figure to choose the file to include, rotate or scale
it, etc.) Tables and figures can have captions, and LyX will automatically
generate lists of figures and/or tables.
@ -4492,9 +4493,10 @@ learn
The short answer is that LyX can do pretty much everything LaTeX can do
in one form or another, and it definitely simplifies most parts of writing
a LaTeX document.
Currently, there may be some annoyance in converting old LaTeX documents
and in a couple other areas, but later releases of LyX will get rid of
these problems.
The tool that is used to convert a LaTeX document to LyX was rewritten
completely for LyX\InsetSpace ~
1.4.
It should now be able to handle most LaTeX gracefully.
\end_layout
\begin_layout Standard
@ -4533,8 +4535,10 @@ nsert\SpecialChar \menuseparator
Te
\bar under
X
\family default
\bar default
\InsetSpace ~
Code
\family default
.
This creates a text box, and everything within it is passed straight to
LaTeX.
@ -4631,9 +4635,9 @@ usepackage{foo}
\end_layout
\begin_layout Subsection
Importing LaTeX Documents---
Importing LaTeX Documents ---
\family typewriter
reLyX
tex2lyx
\end_layout
\begin_layout Standard
@ -4659,11 +4663,11 @@ L
aTeX
\family default
command in LyX.
This will call a Perl script called
This will call
\family typewriter
reLyX
tex2lyx
\family default
---which will create a file
which will create a file
\family typewriter
foo.lyx
\family default
@ -4671,51 +4675,24 @@ foo.lyx
\family typewriter
foo.tex
\family default
---and then open that file.
--- and then open that file.
If the translation doesn't work, you can try calling
\family typewriter
reLyX
tex2lyx
\family default
from the command line
\begin_inset Foot
status collapsed
\begin_layout Standard
When LyX is installed, a separate executable called
\family typewriter
reLyX
\family default
will be placed in the same folder as the
\family typewriter
lyx
\family default
executable (e.g.,
\family typewriter
/usr/local/bin/reLyX
\family default
).
\family typewriter
reLyX
\family default
requires Perl (version 5.002 as of this writing).
\end_layout
\end_inset
, possibly using fancier options.
from the command line, possibly using fancier options.
\end_layout
\begin_layout Standard
\family typewriter
reLyX
tex2lyx
\family default
will translate most legal LaTeX, but not everything.
It will leave things it doesn't understand in TeX mode, so after translating
a file with
\family typewriter
reLyX
tex2lyx
\family default
, you can look for red text and hand-edit it to look right.
\end_layout
@ -4723,7 +4700,7 @@ reLyX
\begin_layout Standard
\family typewriter
reLyX
tex2lyx
\family default
has its own manpage.
Read it to find out about which LaTeX commands and environments aren't
@ -4945,8 +4922,7 @@ nsert\SpecialChar \menuseparator
\bar under
C
\bar default
itation\InsetSpace ~
Reference
itation
\family default
(see Section\InsetSpace ~
@ -4974,18 +4950,15 @@ Errors!
\begin_layout Standard
Sometimes when you LaTeX a document, there will be errors, things that LyX
or LaTeX can't understand.
When this happens, LyX will create an error box (a box with the word
\begin_inset Quotes eld
\end_inset
error
\begin_inset Quotes erd
\end_inset
in it).
Clicking on this box will pop up a window showing what the error was.
LyX will just include the error message that LaTeX gave.
Note that the placement of these errors in often not accurate.
When this happens, LyX will open a
\family sans
LaTeX\InsetSpace ~
Errors
\family default
dialog.
Clicking on individual errors in this dialog will take you to the place
in the LyX document where the error occurs and also display the detailed
LaTeX error message.
\end_layout
\end_body

454
lib/doc/UserGuide.lyx
View File

@ -97,13 +97,8 @@ status collapsed
\begin_layout Standard
\noindent
Principal maintainer of this file is
\noun on
Mike Ressler
\noun default
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list:
If you have comments or error corrections, please send them to the LyX Documenta
tion mailing list:
\family typewriter
lyx-docs@lists.lyx.org
\end_layout
@ -332,8 +327,8 @@ HELP!
\end_layout
\begin_layout Standard
First, the bad news: the help system is not as thorough or idiot-proof as
in many commercial applications.
First, the bad news: the help system is not as thorough as that in many
commercial applications.
Patience.
We're working on it.
\end_layout
@ -840,8 +835,7 @@ atch\InsetSpace ~
Word
\family default
toggle button can be used to force LyX to only find complete words.
I.e.
searching for
I.e., searching for
\begin_inset Quotes eld
\end_inset
@ -1338,13 +1332,21 @@ For example, the sequence
\family sans
M-e\InsetSpace ~
a
s
\family default
\begin_inset Quotes erd
\end_inset
pastes text.
brings up the
\begin_inset Quotes eld
\end_inset
Text Style
\begin_inset Quotes erd
\end_inset
menu.
Typing
\begin_inset Quotes eld
\end_inset
@ -1650,7 +1652,7 @@ Basic LyX Setup
\begin_layout Standard
There are two ways to run LyX.
The first way is to install LyX and all of its support files on your system.
Of course, you need root privileges to do that.
Of course, you need root (administrator) privileges to do that.
The second way to run LyX doesn't require root access, letting you
\begin_inset Quotes eld
\end_inset
@ -1761,20 +1763,60 @@ lyxrc.defaults
.
It will then attempt to read a file called
\family typewriter
~/.lyx/preferences
preferences
\family default
beneath your home directory.
The
\begin_inset Foot
status collapsed
\begin_layout Standard
The
\family typewriter
preferences
\family default
file is found in different directories on different systems.
This directory is called LyX's
\emph on
user directory
\emph default
.
\emph on
\emph default
To find out where it is, use
\family sans
\bar under
H
\bar default
elp\SpecialChar \menuseparator
About Ly
\bar under
X
\family default
\bar default
.
(You may set up an alternative user directory from the command line, using
the switch
\family typewriter
-userdir
\family default
.)
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The
\family sans
\bar under
T
\bar default
ools\SpecialChar \menuseparator
\family default
\SpecialChar \-
\family sans
\bar under
P
\bar default
@ -2559,7 +2601,11 @@ P
\bar default
references
\family default
) and set the entries
), select the
\family sans
Printer
\family default
tab, and set the entries
\family sans
Adapt\InsetSpace ~
output
@ -2772,7 +2818,11 @@ ghostview
gv
\family default
.
LyX will automatically use it instead of ghostscript if it is available.
LyX will automatically use it instead of
\family typewriter
ghostview
\family default
if it is available.
\end_layout
\begin_layout Section
@ -2796,19 +2846,16 @@ as described in the last section.
\begin_layout Standard
\size normal
Those of you using Linux, however, will have a bit more work to do.
Many people now receive a Linux distribution, such as Red Hat or Slackware,
on CD-ROM
\size default
\SpecialChar \@.
\size normal
Those of you using Linux, however, may have a bit more work to do.
Many people now install Linux from an ISO image of one of the popular distribut
ions.
They follow the install instructions, get Linux up and running, but never
realize that they need to set up their printer.
\size default
If you find that you need to do this by hand, we've written a little something
to help you out with that; check out the
The more desktop friendly distributions may do this for you automatically.
However, if you find that you need to do this by hand, we've written a
little something to help you out with that; check out the
\begin_inset Quotes eld
\end_inset
@ -4421,7 +4468,7 @@ Before describing all of the various paragraph environments, we'd like to
Everyone seems to have their own convention for separating paragraphs.
Most Americans indent the first line of a paragraph.
Others don't indent but put extra space between the paragraphs.
LyX uses the same convention you find among typographer.
LyX uses the same convention you find among typographers.
The
\emph on
first
@ -4447,12 +4494,6 @@ will
print it that way.
You'll need to get a special package and insert an appropriate command
in the preamble.
[
\emph on
Editor's Note: I'll insert this info when I get the time.
- jw
\emph default
]
\end_layout
\end_inset
@ -5869,7 +5910,7 @@ You can only use inlined math in these environments.
\end_layout
\begin_layout Itemize
You cannot do any nesting with these environments.
You cannot nest other environments into these environments.
\end_layout
\begin_layout Itemize
@ -7325,12 +7366,6 @@ could
should
\emph default
only use it at the beginning of the document, after the title.
Also, don't bother trying to nest
\family sans
Abstract
\family default
in anything else or vice versa.
It won't work.
The
\family sans
Abstract
@ -7603,8 +7638,7 @@ nsert\SpecialChar \menuseparator
\bar under
C
\bar default
itation\InsetSpace ~
Reference
itation
\family default
command.
Just choose the key inside in the available keys list, then add a reference
@ -7751,7 +7785,7 @@ You can't really nest things into a
\family sans
Caption
\family default
environment or vice versa.
environment.
Additionally, hitting
\family sans
Return
@ -8333,6 +8367,99 @@ Unnestable Can't nest them.
\begin_deeper
\begin_layout Itemize
\family sans
Bibliography
\end_layout
\begin_layout Itemize
\family sans
Title
\end_layout
\begin_layout Itemize
\family sans
Author
\end_layout
\begin_layout Itemize
\family sans
Date
\end_layout
\end_deeper
\begin_layout Description
Fully\InsetSpace ~
Nestable You can nest them.
You can nest other things into them.
\end_layout
\begin_deeper
\begin_layout Itemize
\family sans
Abstract
\end_layout
\begin_layout Itemize
\family sans
Verse
\end_layout
\begin_layout Itemize
\family sans
Quote
\end_layout
\begin_layout Itemize
\family sans
Quotation
\end_layout
\begin_layout Itemize
\family sans
Itemize
\end_layout
\begin_layout Itemize
\family sans
Enumerate
\end_layout
\begin_layout Itemize
\family sans
Description
\end_layout
\begin_layout Itemize
\family sans
List
\end_layout
\begin_layout Itemize
\family sans
LyX-Code
\end_layout
\end_deeper
\begin_layout Description
Nestable-Inside You can nest them inside of other things.
You can't nest anything into them.
\end_layout
\begin_deeper
\begin_layout Itemize
\family sans
Part
\end_layout
@ -8409,99 +8536,6 @@ Subsubsection*
\begin_layout Itemize
\family sans
Bibliography
\end_layout
\begin_layout Itemize
\family sans
Abstract
\end_layout
\begin_layout Itemize
\family sans
Title
\end_layout
\begin_layout Itemize
\family sans
Author
\end_layout
\begin_layout Itemize
\family sans
Date
\end_layout
\end_deeper
\begin_layout Description
Fully\InsetSpace ~
Nestable You can nest them.
You can nest other things into them.
\end_layout
\begin_deeper
\begin_layout Itemize
\family sans
Verse
\end_layout
\begin_layout Itemize
\family sans
Quote
\end_layout
\begin_layout Itemize
\family sans
Quotation
\end_layout
\begin_layout Itemize
\family sans
Itemize
\end_layout
\begin_layout Itemize
\family sans
Enumerate
\end_layout
\begin_layout Itemize
\family sans
Description
\end_layout
\begin_layout Itemize
\family sans
List
\end_layout
\begin_layout Itemize
\family sans
LyX-Code
\end_layout
\end_deeper
\begin_layout Description
Nestable-Inside You can nest them inside of other things.
You can't nest anything into them.
\end_layout
\begin_deeper
\begin_layout Itemize
\family sans
Standard
\end_layout
@ -8519,26 +8553,13 @@ Address
Address
\end_layout
\end_deeper
\begin_layout Standard
The
\begin_layout Itemize
\family sans
Caption
\family default
environment doesn't really fit anywhere, since it's only used inside of
\family sans
Table\InsetSpace ~
Floats
\family default
and
\family sans
Figure\InsetSpace ~
Floats
\family default
.
\end_layout
\end_deeper
\begin_layout Subsection
Nesting Other Things: Tables, Math, Floats, etc.
\begin_inset LatexCommand \label{sec:table-and-fig-nesting}
@ -10163,11 +10184,13 @@ Noun
\family default
style corresponds to a font in smallcaps, which some languages and writing
styles use to typeset proper names.
The LyX Team actually hopes to someday have a full set of character styles,
and to also allow the user to customize which font changes correspond to
what styles.
At the moment, though, you'll have to be satisfied with what we've done
already.
The LyX Team has at last (as of LyX version\InsetSpace ~
1.4) introduced true character
styles, but currently these must be defined explicitly in the document
layout file.
There's currently no GUI support to define new, or tweak existing, character
styles to allow you, the user, to customize which font changes correspond
to what styles.
\end_layout
\begin_layout Subsection
@ -11941,7 +11964,7 @@ In LyX, the
-
\family default
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
character comes in three lengths, often called the
@ -12005,7 +12028,7 @@ status collapsed
-
\family default
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
@ -12049,7 +12072,7 @@ status collapsed
-
\family default
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
@ -12073,7 +12096,7 @@ a
-
\family default
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
in math mode
@ -12089,7 +12112,7 @@ You generate these by using the
-
\family default
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
character multiple times in a row.
@ -12109,7 +12132,7 @@ The three types of dash are distinct from the minus sign, which appears
-
\family default
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
in use:
@ -12200,7 +12223,14 @@ texconfig
\family typewriter
fmtutil
\family default
in order to switch hyphenation on for your language by ''uncommenting''
in order to switch hyphenation on for your language by
\begin_inset Quotes eld
\end_inset
uncommenting
\begin_inset Quotes erd
\end_inset
the relevant line in a file typically named
\family typewriter
language.dat
@ -12922,10 +12952,11 @@ I
\bar no
nsert
\series default
\bar under
\bar default
\SpecialChar \menuseparator
\series medium
\bar under
F
\bar no
ootnote,
@ -13242,8 +13273,7 @@ from the menu.
\end_layout
\begin_layout Standard
A graphics inset will be added to your document and a dialog will appear
for you to choose the file to load.
A dialog will appear for you to choose the file to load.
You can also change any settings you need to in this dialog.
\end_layout
@ -14962,6 +14992,18 @@ T
\family sans
\bar default
able
\family default
or
\family sans
\bar under
E
\bar default
dit\SpecialChar \menuseparator
Rows&
\bar under
C
\bar default
ols
\family default
when the cursor is inside a table.
@ -17952,19 +17994,12 @@ Pane
l
\family default
\bar default
dialog, or via
dialog, by
\family sans
\bar under
E
\bar default
dit\SpecialChar \menuseparator
\bar under
M
\bar default
ath
Edit\SpecialChar \menuseparator
Math
\family default
.
, or by clicking the right mouse button on the formula.
The math panel is very useful, so you may want to open it and leave it
somewhere on the screen.
If you're not already in a formula, selecting anything from the math panel
@ -19719,7 +19754,19 @@ M
\bar default
ath
\family default
menu.
and
\family sans
\bar under
E
\bar default
dit\SpecialChar \menuseparator
Rows&
\bar under
C
\bar default
ols
\family default
menus.
\end_layout
\begin_layout Standard
@ -19731,8 +19778,12 @@ There are numerous other arrays used in LaTeX math-mode, particularly with
cases
\family default
and commutative diagrams.
Not all of these are supported in LyX.
However, it is possible to build these structures from a matrix.
Not all of these are supported in LyX but some are, see
\family sans
Insert\SpecialChar \menuseparator
Math
\family default
.
\end_layout
\begin_layout Standard
@ -21449,13 +21500,21 @@ p
\bar default
review
\family default
check box in the
\begin_inset Quotes eld
\end_inset
On
\begin_inset Quotes erd
\end_inset
pulldown item in the
\family sans
\bar under
E
T
\bar default
dit\SpecialChar \menuseparator
ools\SpecialChar \menuseparator
\bar under
P
@ -21496,7 +21555,15 @@ review
\begin_layout Standard
LyX will generate previews of math insets.
It will also generate previews of include insets if you select the
It will also generate previews of include insets or
\begin_inset Quotes eld
\end_inset
child documents
\begin_inset Quotes erd
\end_inset
if you select the
\family sans
\bar under
S
@ -22878,7 +22945,7 @@ ccept compound words
Prevent the spellchecker from complaining about compounded words like
\newline
\begin_inset Quotes eld
\begin_inset Quotes erd
\end_inset
passthrough
@ -28375,8 +28442,7 @@ status collapsed
\begin_layout Standard
\backslash
href{http://www.lyx.org/cgi-bin/viewcvs.cgi/*checkout*/lyx-devel/lib/CREDITS?rev=HE
AD&content-type=text/plain}{
href{http://www.lyx.org/about/credits.php}{
\end_layout
\end_inset