Lars Gullik Bjønnes wrote:
> It seems that our documentation needs a small overhaul before the
> 1.4.0 release. Not any big workovers, but at fix-up the really
> out-dated stuff... Especiall the reLyX stuff...
> At least Customization.lyx, Tutorial.lyx and Extended.lyx needs work
> in this regard.
Attached is a patch to Intro.lyx, Tutorial.lyx and UserGuide.lyx. OK?
Two notes of my own:
1. One for the Mac users: where is the "preferences" file to be found?
Currently I have:
The preferences file is found in different directories on different
systems:
Unix: ~/lyx/
Mac: ???
Windows: C:\Documents and Settings\USER\Application Data\LyX\
2. It would be great if someone could run John McCabe-Dansted's new grammar
checker over the English flavour of the LyX files. One thing that I'm
confused about is the typography of footnotes and punctuation. Is it
... foo bar.[foot] Foo bar ...
or
... foo bar[foot]. Foo bar ...
Both are used but the first looks ugly to me.
> We also need to upgrade our documentation to the latest lyx-format.
Done.
Incidentally, is there away to do this from the command line without
launching the GUI? I did the upgrade as:
for file in *.lyx;
do
lyxcvs -x "command-sequence file-open $file; buffer-write; lyx-quit"
done
--
Angus
Index: lib/doc/Intro.lyx
===================================================================
RCS file: /usr/local/lyx/cvsroot/lyx-devel/lib/doc/Intro.lyx,v
retrieving revision 1.3
diff -u -p -r1.3 Intro.lyx
--- lib/doc/Intro.lyx 2 Jan 2006 01:51:18 -0000 1.3
+++ lib/doc/Intro.lyx 2 Jan 2006 02:04:39 -0000
@@ -514,7 +514,7 @@ Granted, many modern word processors can
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
Index: lib/doc/Tutorial.lyx
===================================================================
RCS file: /usr/local/lyx/cvsroot/lyx-devel/lib/doc/Tutorial.lyx,v
retrieving revision 1.3
diff -u -p -r1.3 Tutorial.lyx
--- lib/doc/Tutorial.lyx 2 Jan 2006 01:51:18 -0000 1.3
+++ lib/doc/Tutorial.lyx 2 Jan 2006 02:04:43 -0000
@@ -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
[EMAIL PROTECTED]
+\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 w
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
@@ -2560,8 +2563,11 @@ We told you that LyX worries about numbe
test that.
Add a new section before Section\InsetSpace ~
2.
- Now rerun LaTeX, and --- voilà! --- the section cross reference changed
- to
+ Now rerun LaTeX, and ---
+\lang french
+voilà
+\lang english
+! --- the section cross reference changed to
\begin_inset Quotes eld
\end_inset
@@ -2593,10 +2599,9 @@ If you want some more practice with labe
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 +2928,9 @@ nsert\SpecialChar \menuseparator
\bar under
C
\bar default
-itation\InsetSpace ~
-Reference\SpecialChar [EMAIL PROTECTED]
-
+itation
\family default
+.
A
\family sans
Citation
@@ -2953,12 +2957,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 +2988,8 @@ abel
field in the
\family sans
Bibliography\InsetSpace ~
-item
+Entry\InsetSpace ~
+Settings
\family default
dialog.
As usual, you can see the
@@ -4349,7 +4353,7 @@ G
\bar default
raphics
\family default
-\SpecialChar [EMAIL PROTECTED]
+.
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 +4496,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 +4538,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 +4638,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 +4666,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 +4678,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 +4703,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 +4925,7 @@ nsert\SpecialChar \menuseparator
\bar under
C
\bar default
-itation\InsetSpace ~
-Reference
+itation
\family default
(see Section\InsetSpace ~
@@ -4974,18 +4953,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
Index: lib/doc/UserGuide.lyx
===================================================================
RCS file: /usr/local/lyx/cvsroot/lyx-devel/lib/doc/UserGuide.lyx,v
retrieving revision 1.17
diff -u -p -r1.17 UserGuide.lyx
--- lib/doc/UserGuide.lyx 2 Jan 2006 01:51:18 -0000 1.17
+++ lib/doc/UserGuide.lyx 2 Jan 2006 02:04:59 -0000
@@ -332,8 +332,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
@@ -1650,7 +1650,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,9 +1761,52 @@ lyxrc.defaults
.
It will then attempt to read a file called
\family typewriter
-~/.lyx/preferences
+preferences
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+The
+\family typewriter
+preferences
+\family default
+ file is found in different directories on different systems:
+\end_layout
+
+\begin_layout Description
+Unix:
+\family typewriter
+~/.lyx/
+\end_layout
+
+\begin_layout Description
+Mac: ???
+\end_layout
+
+\begin_layout Description
+Windows:
+\family typewriter
+C:
+\backslash
+Documents\InsetSpace ~
+and\InsetSpace ~
+Settings
+\backslash
+USER
+\backslash
+Application\InsetSpace ~
+Data
+\backslash
+LyX
+\backslash
+
+\end_layout
+
+\end_inset
+
+
\family default
- beneath your home directory.
+.
The
\family sans
\bar under
@@ -2772,7 +2815,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
@@ -4421,7 +4468,7 @@ Before describing all of the various par
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
@@ -5813,7 +5854,11 @@ depth
\begin_inset Quotes erd
\end_inset
- and voilà! You're all set.
+ and
+\lang french
+voilà
+\lang english
+! You're all set.
\end_layout
\begin_layout Subsubsection
@@ -7603,8 +7648,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
@@ -10163,11 +10207,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 +11987,7 @@ In LyX, the
-
\family default
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
character comes in three lengths, often called the
@@ -11973,7 +12019,7 @@ made with
-
\family default
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
@@ -12005,7 +12051,7 @@ status collapsed
-
\family default
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
@@ -12049,7 +12095,7 @@ status collapsed
-
\family default
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
@@ -12073,7 +12119,7 @@ a
-
\family default
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
in math mode
@@ -12089,7 +12135,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 +12155,7 @@ The three types of dash are distinct fro
-
\family default
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
in use:
@@ -12200,7 +12246,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 +12975,11 @@ I
\bar no
nsert
\series default
-\bar under
+\bar default
\SpecialChar \menuseparator
\series medium
+\bar under
F
\bar no
ootnote,
@@ -13239,11 +13293,7 @@ raphics...
\family default
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
@@ -28375,8 +28425,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
