-#LyX 2.0 created this file. For more info see http://www.lyx.org/
-\lyxformat 413
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 426
\begin_document
\begin_header
\textclass scrbook
\graphics default
\default_output_format default
-\output_sync 0
+\output_sync 1
\bibtex_command default
\index_command default
\paperfontsize 12
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
\papersize default
\use_geometry false
-\use_amsmath 1
-\use_esint 0
-\use_mhchem 1
-\use_mathdots 1
+\use_package amsmath 1
+\use_package esint 0
+\use_package mathdots 1
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type numerical
+\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\justification true
\use_refstyle 0
+\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
User's Guide\SpecialChar \@.
\emph default
- The reason for separating this document out is simple: the
+ The reason for separating the two documents is simple: the
\emph on
User's Guide
\emph default
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Format
+View
\end_layout
\end_inset
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Update\SpecialChar \menuseparator
-Format
+Update
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-If you've run LaTeX using
+If you have run LaTeX using
\begin_inset Flex MenuItem
status collapsed
\end_inset
, LyX then runs a DVI viewer to display the DVI-file.
- If you've used
+ If you have used
\begin_inset Flex MenuItem
status collapsed
TeX Code
\end_layout
+\end_inset
+
+ or the keyboard shortcut
+\begin_inset Info
+type "shortcut"
+arg "ert-insert"
\end_inset
.
\begin_inset Newline newline
\end_inset
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You
\begin_inset Newline newline
\end_inset
box containing this text is directly after this paragraph.
Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\begin_inset ERT
-status collapsed
+status open
\begin_layout Plain Layout
\begin_layout Plain Layout
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\end_layout
\end_inset
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Itemize
-Beware reinventing the wheel.
+Beware of reinventing the wheel.
\end_layout
\begin_layout Standard
\end_inset
- for details, and see chapter
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
+ for details.
\end_layout
\begin_layout Standard
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
+ In addition to providing special commands, the inclusion of a package can
+ change the document.
For example, the package
\begin_inset Flex Code
status collapsed
\begin_inset Newline newline
\end_inset
-There are several LaTeX counters and variables which
+There are several LaTeX counters and variables that
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- (There are variables which you can set and reset inside the document, too.)
- Margins are a good example of something which must be set in the preamble.
+ (There are variables that you can set and reset inside the document, too.)
+ Margins are a good example of something that must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\begin_layout Standard
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
- Also, there are more examples and an assortment of LaTeX
-\begin_inset Quotes eld
-\end_inset
-
-dirty tricks
-\begin_inset Quotes erd
-\end_inset
-
- given in Chapter
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
-
\end_layout
\begin_layout Section
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
It then uses the logfile from the LaTeX run to do a post-mortem.
- After analyzing the logfile,LyX displays a dialog listing the errors.
+ After analyzing the logfile, LyX displays a dialog listing the errors.
Clicking on any one of them will take you to the position in your LyX file
where the error occurred.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
- LaTeX Error: File
+LaTeX Error: File
\begin_inset Quotes els
\end_inset
\end_inset
-, than the established
+, then the established
\begin_inset Flex Code
status collapsed
.
You are free to use the same or different styles for each section.
- Additionally, you can chose if the bibliography section should contain
+ Additionally, you can choose if the bibliography section should contain
\begin_inset Quotes eld
\end_inset
\end_inset
- removes the bibliography title, you have manually re-add that, too (as
+ removes the bibliography title, you have to manually re-add that, too (as
a chapter* or section*, for instance).
\end_layout
\end_inset
(those commands have to be inserted as TeX code).
- The bibliography will contain all references which have been cited in the
+ The bibliography will contain all references that have been cited in the
current
\begin_inset Flex Code
status collapsed
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
+ that files that are
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- are typeset beginning on a new page, while files which are
+ are typeset beginning on a new page, while files that are
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
+g, while the included files are converted to LaTeX files that do not have
all the preamble information.
\end_layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
First, open all the files in question: let's call them A and B in a two
file example, where B is included in A.
Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
+ Open the cross-reference dialog whilst in document B, and you can select
the
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
You will now see your name in the upper left.
If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer, simply include a command
+ the page number appears in the central footer) simply include a command
with a blank argument, e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Standard
The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+ The following table shows the mappings from button name to LaTeX package.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-Another useful tool is command-line based client you will find in
+Another useful tool is the command-line based clientfound in
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-Please note that including the
+Note that the method
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=1
+\end_layout
+
+\end_inset
+
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=-1
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Please aöso note that including the
\begin_inset Flex Code
status collapsed
\end_inset
.
+
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-The
+Note that the option
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
- to reverse search.
+ of reverse search.
It allows you to let the viewer jump to a given position from within LyX.
If forward search is set up (as described in what follows), you can put
the cursor anywhere in your LyX document, and hit
can select from the drop down list.
If none of these configurations suits you, you have to find out and enter
a suitable configuration yourself.
- The definition syntax uses the following placeholders:
+ The definition syntax uses the following placeholders:
\end_layout
\begin_layout Itemize
\end_inset
.
- These latter functionality is provided by an external call of synctex (see
+ This latter functionality is provided by an external call of synctex (see
the predefined example configurations).
\end_layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\emph on
\begin_inset space \space{}
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
+, lots will probably never be supported, due to the limitations of LyX's
+ framework.
Of course you can still use all features with the help of some native LaTeX
commands (TeX code
\begin_inset Foot
\end_inset
).
- In this section, we can only list those features which are natively supported
+ In this section, we can only list those features that are natively supported
by LyX.
For detailed descriptions (and for the rest of features) we recommend you
have a look at the detailed manual of the Memoir class
\begin_inset Quotes erd
\end_inset
-, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-without pagina).
+).
If you want an empty title page, type
\family typewriter
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\family typewriter
chktex
\family default
- it from CTAN,
+ from CTAN,
\begin_inset CommandInset href
LatexCommand href
target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
\begin_inset Newline newline
\end_inset
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
+If you have bad luck, the text will break right between the referenced text
+ and reference number, and that's a pity.
See section
\begin_inset CommandInset ref
LatexCommand ref
\family sans
ChkTeX
\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
+, and this gap can make some warnings seem arcane or just plain silly.
\end_layout
\begin_layout Standard
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
+ to the internal document structure, some of the warnings will not appear
+ correctly.
There are two things you can do about this:
\end_layout
ChkTeX
\family default
invocation command line in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Outputs
-\family default
-,
-\family sans
-Misc
-\family default
-), or the global
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+LaTeX\SpecialChar \menuseparator
+CheckTeX command
+\end_layout
+
+\end_inset
+
+, or the global
\family sans
ChkTeX
\family default
).
See below to learn what warnings can be enabled and disabled on the command
line.
-
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-Also note that CVS support is not as good as subversion support so we advice
+Also note that CVS support is not as good as subversion support so we advise
using SVN instead.
- Good place to start with Subversion is SVN Book
+ A good place to start learning Subversion is SVN Book
\begin_inset Foot
status open
\end_inset
.
- In case of RCS you should read
+ In the case of RCS you should read
\begin_inset Quotes eld
\end_inset
The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
package—no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
- you can check them in Messages pane if unsure.
+ you can check them in the Messages pane if unsure.
\end_layout
\begin_layout Standard
Control
\family default
submenu.
- LyX was tested against RCS 5.7.
+ LyX was tested against RCS 5.7/5.8
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Note that old DOS / MS Windows builds (5.7) need to setup environment variables
+ in order to work properly with LyX.
+ In particular time zone (TZ) should be set and more importantly RCSINIT
+ in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
+ expects archive to be found in file.lyx,v within the original document directory.
+ See also README shipped with Windows RCS binaries.
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Subsubsection
\end_inset
- in case you have already the documents directory under CVS control (in
- particular
+ in the case you have already the documents directory under CVS control
+ (in particular
\family typewriter
CVS/Entries
\family default
\end_layout
\begin_layout Standard
-Compared with Linux setting up svn client to communicate over ssh under
+Compared with Linux setting up an svn client to communicate over ssh under
Windows is a rather troublesome task.
We will at least offer some hints how to setup the client side but prior
knowledge about ssh and the Windows command line is needed, also be prepared
\end_layout
\begin_layout Enumerate
-Get a svn client for windows, as described in the previous sections.
+Get an svn client for windows, as described in the previous sections.
When it is a fresh install run some svn command (e.g.
\begin_inset Flex Code
\end_layout
\begin_layout Enumerate
-Choose a ssh client for Windows.
+Choose an ssh client for Windows.
There are several possibilities, we will use the one from Putty tools
\begin_inset Foot
status open
dumps.
While this is useful for plain text files, it is much less useful in the
- case of LyX files, which have more complicated structure.
+ case of LyX files, which have more a complicated structure.
Hence we provide binding to the Document comparison feature.
- They are two ways of calling this feature - either by direct call of
+ There are two ways of calling this feature - either by direct call of
\begin_inset Flex Code
status collapsed
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
For other special things you can do with figures, tables, floats, boxes
and notes, have a look at the
\emph on
-EmbeddedObjects
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
\emph default
manual.
\end_layout
\end_layout
\begin_layout Standard
-If you want to have 2 columns in your text, use the style
+If you want to have 2
+\begin_inset space ~
+\end_inset
+
+columns in your text, use the style
\family sans
Begin Multiple Columns
\family default
Begin Multiple Columns
\family default
style.
- behind the command write the text.
+ Behind the command follows the preface text.
At the end of the style use the command
\end_layout
\backslash
setlength
\series default
- will be used for all following multiple columns until to change them again.
+ will be used for all following multiple columns until you change them again.
\end_layout
\end_inset
\end_inset
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\end_inset
pt (this is the default), the rule is suppressed.
- In the following example, the line separating the columns is 2
+ In the following example the line is 2
\begin_inset space \thinspace{}
\end_inset
-pt wide.
+pt wide:
\end_layout
\begin_layout Standard
projects / lyx.git / blobdiff