-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 389
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 417
\begin_document
\begin_header
\textclass scrbook
\cleardoublepage
\pagenumbering{arabic}}
-% redefine the \LyX macro for PDF bookmarks
-\def\LyX{\texorpdfstring{%
- L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
- {LyX}}
-
% used for multi-column text
\usepackage{multicol}
% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
\end_preamble
-\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
+\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\begin_modules
logicalmkup
theorems-ams
theorems-ams-extended
+multicol
\end_modules
\maintain_unincluded_children false
\begin_local_layout
End
\end_local_layout
\language english
-\inputencoding latin1
+\language_package default
+\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\graphics default
\default_output_format default
+\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize 12
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle false
-\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
+\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 0
+\use_amsmath 1
\use_esint 0
\use_mhchem 1
+\use_mathdots 1
+\use_undertilde 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\use_refstyle 0
+\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes true
+\tracking_changes false
\output_changes false
\html_math_output 0
+\html_css_as_file 0
\html_be_strict true
-\author 1 "ab"
\end_header
\begin_body
Additional LyX Features
\end_layout
+\begin_layout Subtitle
+Version 2.0.x
+\end_layout
+
\begin_layout Author
by the LyX Team
\begin_inset Foot
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-
+
\end_layout
\begin_layout Standard
For one thing, you don't need to know LaTeX to use LyX effectively.
And LyX has added its own extensions to LaTeX.
Try the following sometime: select
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
from the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu (or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
), then look at the preamble of the resulting
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Format
+View
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Update\SpecialChar \menuseparator
-Format
+Update
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Convert the document to LaTeX and save to a file with the extension
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in place of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Run LaTeX on the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file (maybe several times), and run any other commands (such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-If you've run LaTeX using
-\begin_inset Flex CharStyle:MenuItem
+If you have run LaTeX using
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, LyX then runs a DVI viewer to display the DVI-file.
- If you've used
-\begin_inset Flex CharStyle:MenuItem
+ If you have used
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run a PostScript viewer, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can import a LaTeX file into LyX by using the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
command in LyX.
This will call a program named
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
which will create a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
from the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
will translate most legal LaTeX, but not everything.
It will put things it doesn't understand into TeX code, so after translating
a file with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LyX cannot, and will never be able to, display every possible LaTeX construct.
If ever you need to insert LaTeX commands into your LyX document, you can
use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
box, which you can insert into your document with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In addition to using TeX code, you can also create a separate file containing
some complex LaTeX structure and then use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to include your file (you should select the type
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
).
We recommend that you only do this if you have a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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.
For example, the package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Declare user defined commands (with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX adds its own set of definitions to the preamble of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
The commands which LyX adds to the preamble of a LaTeX file are fixed; you
can't change them without patching LyX itself.
You can, however, add your own stuff to the preamble by selecting
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
dialog.
LyX adds anything in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
There are two variables under LaTeX that control page position:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Sometimes, the size of a print medium and the area of the medium that you
can actually print on aren't the same.
This is where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The default values for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
your sysadmin is a doofus,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
can save the day.
- Suppose you're left and top margins are always 0.5
+ Suppose your left and top margins are always 0.5
\begin_inset space \thinspace{}
\end_inset
Speaking of labels, suppose you wanted to print out a bunch of address labels.
There's a rather nice package, available at your nearest CTAN archive,
for printing sheets of labels:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First, make sure you're using the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
This sets things up for Avery label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
around each label text.
This and other special features of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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
\begin_layout Standard
Some folks also like to look at the log file directly: It is available from
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
You can also enable the `draft' option in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
isn't installed on this system.
This usually appears because some package your document needs isn't installed.
If you didn't touch the preamble or didn't use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
command, then one of the packages LyX tried to load is missing.
Use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
to get a list of packages that LyX knows about.
This file is updated whenever you reconfigure LyX (using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
If you did use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
misuse
\emph default
any of them, like trying to manually insert lots of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
spacing it will add in order to break a line.
Preferably, you should rework the paragraph to avoid the problem.
If this isn't an option, you can wrap your text in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
).
LyX supports two packages that provide this style,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Both packages have their pros and cons, which cannot be listed in detail.
If you only want to have simple author-year (or author-numerical) style,
or if you want to use one of the countless style files for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, than the established
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package is probably your choice.
If you need special features like short title references, ibidem etc., you
might consider the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The handling of both packages in LyX is basically the same.
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and select under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and check under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Now you can insert multiple BibTeX bibliographies, one for each section
of your bibliography.
Returning to our example: Insert the BibTeX bibliography
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and a second one for the database
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The titles for the sections can be added as ordinary sections or subsections.
Since
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
a bibliography for each section or chapter of the document, are not supported
by BibTeX itself.
But the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package, which is used for the creation of sectioned bibliographies in
LyX (see the previous section), provides an easy way to solve this task,
if you are willing to use some
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
An alternative approach is to use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
check
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
In the document, you have to enclose the sections, which shall contain
their own bibliography (including the BibTeX bibliography itself), between
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
(those commands have to be inserted as TeX code).
The bibliography will contain all references which have been cited in the
current
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\series default
If you are using this approach, then every citation reference has to be
inside some
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Also, the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
everything up to and including the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
line as well as the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX allows you to include files quite easily with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Normally, spaces in this file are invisible, though two consecutive spaces
are conserved, unlike LyX's normal treatment of spaces.
However, setting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
Copy the bibliography list with all entries to all subdocuments and transform
them to a comment.
This way LyX will find the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
As the bibliography list is in a comment, LaTeX won't use use it and the
references will look like this: [?], instead of like this: [1].
One solution is to use the LaTeX-package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
\end_layout
+\begin_layout Section
+LyX Archives
+\end_layout
+
+\begin_layout Standard
+Users sometimes need to be able to
+\begin_inset Quotes eld
+\end_inset
+
+bundle
+\begin_inset Quotes erd
+\end_inset
+
+ a LyX file together with all the images (and other files) on which it depends,
+ either for sending to a publisher or for sharing with a co-author.
+ LyX 2.0 includes a Python script (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxpak.py
+\end_layout
+
+\end_inset
+
+) that automates this process.
+ To use it, you must have either the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zipfile
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tarfile
+\end_layout
+
+\end_inset
+
+ python modules installed on your system.
+ By default, the script prefers the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+gzip
+\end_layout
+
+\end_inset
+
+-compressed
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tar
+\end_layout
+
+\end_inset
+
+ format on Unix-like systems and the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zip
+\end_layout
+
+\end_inset
+
+ format on Windows.
+\end_layout
+
+\begin_layout Standard
+LyX's configuration process will set the script up to export a `LyX Archive',
+ and this format will then be available under
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Export
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Independently of the platform, the generation of a particular archive format
+ can be forced by adding either the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-t
+\end_layout
+
+\end_inset
+
+ (for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tar
+\end_layout
+
+\end_inset
+
+ format) or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-z
+\end_layout
+
+\end_inset
+
+ (for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zip
+\end_layout
+
+\end_inset
+
+ format) switch to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyX\SpecialChar \menuseparator
+LyX Archive
+\end_layout
+
+\end_inset
+
+ converter in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
+\end_layout
+
+\end_inset
+
+.
+ (Make sure you add the switch after the script name, not before it.)
+\end_layout
+
\begin_layout Section
Fancy Headers and Footers
\end_layout
\begin_layout Standard
The default page layout is rather plain; for an
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For more information on fancy headers, see the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The footer is also divided into these three fields.
The LaTeX commands to set these fields in the simplest manner are
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
access LaTeX's section and page counters, and so print out the current
section and page numbers.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can switch the header/footer settings on and off for individual pages
using commands like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
\noindent
(you may need to preface this with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Open the dialog by selecting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu item and then select the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Use the LaTeX command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Specify each individual entry by starting each item with the bullet shape
enclosed in square brackets and set as
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
For example, this item was started with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX has long supported the export of documents to various web-friendly formats,
such as HTML.
- Before verson 1.7, however, HTML export was always accomplished by the use
+ Before verson 2.0, however, HTML export was always accomplished by the use
of external converters.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
For details on the use of external converters with LyX, see the
-\size normal
\emph on
Converters
\emph default
These fall into two large groups: there are converters that use LaTeX as
an intermediate format, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
, relying upon LyX to produce the LaTeX; and there is a converter that works
directly on LyX files,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
everything about the exported document that LaTeX does.
Such converters do not care, for example, if a certain block of code was
produced by LyX or was Evil Red Text.
- They know about
-\begin_inset Flex CharStyle:Code
+ These converters know about
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
files, counters, and references, and can often make use of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Embedded Objects
\emph default
manual will not export with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Alex Fernandez's
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- solves some of these problems.
- In particular, its rendering of math tends to look better than
-\begin_inset Flex CharStyle:Code
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://elyxer.nongnu.org/"
+target "http://elyxer.nongnu.org/"
+
+\end_inset
+
+) solves some of these problems.
+ In particular, the formulae it produces scale perfectly, since it renders
+ math using a combination of HTML and CSS rather than converting the formulae
+ to images.
+ But even moderately complex formula are rendered less well than with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-'s, at least in simpler cases, since it renders math using a neat combination
- of HTML and CSS rather than converting the formulae to images.
- But more complex formula tend to be rendered less well than with
-\begin_inset Flex CharStyle:Code
+; this reflects the limitations of HTML.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-htlatex
+That said,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+eLyXer
+\end_layout
+
+\end_inset
+
+ can also use jsMath and MathJax for equations, but this setting is only
+ available globally and requires one to have access to a server that runs
+ the backend.
\end_layout
\end_inset
-, since there is no reasonable way of scaling parentheses in HTML, for example.
- More importantly (as of version 0.39, at least),
-\begin_inset Flex CharStyle:Code
+ More importantly (as of version 1.1.1, at least),
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- has no support for math macros, for user-defined paragraph or character
- styles, or for tables of contents and figures.
+ has limited support for math macros and no support for user-defined paragraph
+ or character styles.
These limitations make
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- unsuitable for many of the documents more advanced LyX users would produce.
- In principle, of course, all of these problems could be solved, but the
- LyX developers have decided to follow a different path and made LyX itself
- capable of writing XHTML, just as it is capable of writing LaTeX, DocBook,
- and plaintext.
+ unsuitable for many of the documents LyX users produce.
+ In principle, of course, these problems could be solved, but the LyX developers
+ have decided to follow a different path and have made LyX itself capable
+ of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
+ plaintext.
\end_layout
\begin_layout Standard
\begin_layout Plain Layout
The file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, usually contains up-to-date information about the state of XHTML output.
+ See also the list of XHTML bugs on
+\begin_inset CommandInset href
+LatexCommand href
+name "the bug tracker"
+target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
+
+\end_inset
+
+.
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Another advantege is that, since these routines are internal to LyX, they
+Another advantage is that, since these routines are internal to LyX, they
are immune to changes in LyX's file format, or to changes in the semantics
of existing insets.
\end_layout
\end_inset
- So they know about the table of contents (as displayed in the Outline),
+ So they know about the table of contents (as displayed in the outline),
about the counters associated with different paragraph styles, and about
user-defined styles.
The XHTML output routines know what LyX knows about internationalization,
\end_layout
\begin_layout Standard
-Quite generally, the output routines know everything LyX knows about document
- layout, that is, about the document is to be rendered on screen.
- We can use this information when we output the document as XHTML.
+Quite generally, the output routines know what LyX knows about document
+ layout, that is, about how the document is to be rendered on screen.
+ We use this information when we output the document as XHTML.
In particular, LyX
\emph on
automatically
sans-serif and bold when viewed in a web browser, too.
And this is true not just for pre-defined styles, like Section, but for
any style, including user-defined styles.
- Indeed, the XHTML output routines make no distinction between user-defined
+ Indeed, the XHTML output routines make no distinction between user-defined
paragraph and character styles and LyX's own pre-defined styles: in each
case, everything LyX knows about the styles is contained in the layout
files.
And much the same is true as regards pre-defined textual insets, such as
- footnotes, and custom versions.
+ footnotes, and various custom insets.
\end_layout
\begin_layout Standard
-The result is that XHTML output can be customized and extended in
-\emph on
-exactly
-\emph default
+The result is that XHTML output can be customized and extended in exactly
the same way LaTeX output can be customized and extended: through layout
files and modules.
See chapter five of the
\end_layout
\begin_layout Standard
-As for math, LyX renders math using MathML.
- This has advantages and disadvantages.
- The advantage is that MathML is a dialect of XML designed specifically
- for mathematics on the web, and it typically renders very well in browsers
- that support it.
- The first disadvantage is that not all browsers support MathML, and support
- is not complete even in the Gecko-based browsers, such as Firefox.
- A second disadvantage, as compared to rendering math by images, is that
- LyX can only output MathML for LaTeX constructs that it knows about, which
- means that the use of ERT in math---e.g., the command
-\begin_inset Flex CharStyle:Code
-status collapsed
+The remainder of this chapter contains more detailed information on XHTML
+ output, its limitations, and ways to work around those limitations.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Section
+Math Output in XHTML
+\end_layout
-\backslash
-BGassert
+\begin_layout Standard
+LyX offers four choices for how math is rendered.
+ These have various advantages and disadvantages:
\end_layout
+\begin_layout Itemize
+MathML
+\begin_inset Newline newline
+\end_inset
+
+MathML is a dialect of XML designed specifically for mathematics on the
+ web, and it typically renders very well in browsers that support it.
+ The disadvantage is that not all browsers support MathML, and support is
+ not complete even in the Gecko-based browsers, such as Firefox.
+\begin_inset Newline newline
\end_inset
- from the
-\begin_inset Flex CharStyle:Code
+If LyX is unable to render a formula as MathML---for example, if the formula
+ uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-begriff.sty
+xymatrix
\end_layout
\end_inset
- package---will produce nothing helpful.
- Eventually, therefore, LyX will offer the user the option to use MathML
- or images, and it will offer this choice on a case by case basis.
+ package or ERT---then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Standard
-The remainder of this chapter contains more detailed information on XHTML
- output, its limitations, and ways around those limitations.
-\end_layout
+\begin_layout Itemize
+HTML
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-\begin_inset Note Note
-status open
+As mentioned above,
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-This is very incomplete at this point!
+elyxer
\end_layout
\end_inset
+ outputs math as HTML, styled by CSS.
+\begin_inset Foot
+status collapsed
-\end_layout
+\begin_layout Plain Layout
+LyX has borrowed some of the CSS for its HTML output from
+\begin_inset Flex Code
+status collapsed
-\begin_layout Section
-Bibliography and Citations
+\begin_layout Plain Layout
+elyxer
\end_layout
-\begin_layout Standard
-XHTML output fully supports bibliographies and citations.
-
-\end_layout
+\end_inset
-\begin_layout Standard
-Citation labels are generated by exactly the same machinery that generates
- LyX's on-screen labels, so the labels will look in the output much as they
- do in LyX, though better.
- If you are using numerical citations, then LyX will output numerical labels,
- such as [1] or [17], rather than simply showing the citation key in square
- brackets, as it does on-screen.
- If you are using author-year citations, then LyX will add lowercase letters
- to the years, just as BibTeX does, if it finds more than one citation for
- a given author-year combination.
- The labels will be printed with the bibliography entries.
- Note that there is, at present, no way to customize the appearance of the
- labels, for example, to choose between square brackets and parentheses.
+.
\end_layout
-\begin_layout Standard
-Bibliography output is handled by the same machinery that handles the presentati
-on of reference information in the citation dialog, so you will see in the
- XHTML output pretty much what you would see if you were to look at a given
- entry in the citation dialog.
- The formatting can be customized in your layout file or, preferably, in
- a module.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Citation-format-description"
+\end_inset
+ For simple formulae, this can work quite well, though with more complicated
+ formulae it tends to break down.
+ Still, this method has the advantage that it is very widely supported and
+ so it may be appropriate for documents that contain only a little, fairly
+ simple math.
+\begin_inset Newline newline
\end_inset
- of the
-\emph on
-Customization
-\emph default
- manual for the details.
-\end_layout
+If Lyx is unable to render a formula as HTML---for example, if the formula
+ uses the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-The other significant defect is that cross-referenced information is printed
- with every entry with which it is associated.
- So you can see things like this:
+\begin_layout Plain Layout
+xymatrix
\end_layout
-\begin_layout Quote
-Jason Stanley,
-\begin_inset Quotes eld
\end_inset
-Context and Logical Form
-\begin_inset Quotes erd
-\end_inset
+ package or ERT---then it will instead output the formula as an image.
+
+\end_layout
+
+\begin_layout Itemize
+Images
+\begin_inset Newline newline
+\end_inset
+
+Like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+htlatex
+\end_layout
+
+\end_inset
+
+, LyX will output formulae as images, the very same images, in fact, that
+ are used for instant preview.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Instant preview does
+\emph on
+not
+\emph default
+have to be on for images to be output, however.
+\end_layout
+
+\end_inset
+
+ The advantage to this method is that the images are simply generated by
+ LaTeX, so they are very accurate.
+ The disadvantage, as mentioned earlier, is that these are bitmapped images,
+ so they do not scale terribly well, and one cannot copy them, etc.
+ (As of this writing, there are also problems about equation numbering.
+ See
+\begin_inset CommandInset href
+LatexCommand href
+name "bug 6894"
+target "http://www.lyx.org/trac/ticket/6894"
+
+\end_inset
+
+.)
+\begin_inset Newline newline
+\end_inset
+
+The size of the images can be controlled by setting the
+\begin_inset Quotes eld
+\end_inset
+
+Math Images Scaling
+\begin_inset Quotes erd
+\end_inset
+
+ parameter under
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For those who want to know, this controls the resolution of the image in
+ dots per inch and is based upon a default of 75 dpi.
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+If LyX for some reason fails to create an image for a formula (e.g., if a
+ required LaTeX package is not installed), then it will fall back to outputing
+ the raw LaTeX.
+\end_layout
+
+\begin_layout Itemize
+LaTeX
+\begin_inset Newline newline
+\end_inset
+
+Finally, LyX will happily output math as LaTeX.
+ As well as being the output of last resort, this method can be used with
+ such tools as
+\begin_inset CommandInset href
+LatexCommand href
+name "jsMath"
+target "http://www.math.union.edu/~dpvc/jsMath/"
+
+\end_inset
+
+, which uses JavaScript to render LaTeX embedded in HTML documents.
+ LyX wraps the LaTeX in either a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+ (for inline formulas) or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+ (for displayed formulas) with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class='math'
+\end_layout
+
+\end_inset
+
+, as is required for jsMath.
+\end_layout
+
+\begin_layout Standard
+One of these output methods must be selected under
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
+\end_layout
+
+\end_inset
+
+.
+ By default, LyX outputs MathML.
+ This is a document-wide setting, therefore.
+\end_layout
+
+\begin_layout Standard
+Eventually, LyX will offer the user the option to select an alternate output
+ method for a particular inset, say, one that isn't being rendered very
+ well by MathML.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+That said, since LyX falls back to images if the inset contains ERT, then
+ one can force output as an image by putting some harmless ERT into the
+ math, for example:
+\begin_inset Formula $a=b\relax$
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Section
+Bibliography and Citations
+\end_layout
+
+\begin_layout Standard
+XHTML output fully supports bibliographies and citations.
+
+\end_layout
+
+\begin_layout Standard
+Citation labels are generated by the same machinery that generates LyX's
+ on-screen labels, so the labels will look in the output much as they do
+ in LyX, though better.
+ If you are using numerical citations, then LyX will output numerical labels,
+ such as [1] or [17], rather than simply showing the citation key in square
+ brackets, as it does on-screen.
+ If you are using author-year citations, then LyX will add lowercase letters
+ to the years, just as BibTeX does, if it finds more than one citation for
+ a given author-year combination.
+ The labels will be printed with the bibliography entries.
+ Note that there is, at present, no way to customize the appearance of the
+ labels, for example, to choose between square brackets and parentheses.
+\end_layout
+
+\begin_layout Standard
+Bibliography output is handled by the same machinery that handles the presentati
+on of reference information in the citation dialog, so you will see in the
+ XHTML output pretty much what you would see if you were to look at a given
+ entry in the citation dialog.
+ The formatting can be customized in your layout file or, preferably, in
+ a module.
+ See the
+\emph on
+Customization
+\emph default
+ manual for the details.
+\end_layout
+
+\begin_layout Standard
+The main defect at present is that cross-referenced information is printed
+ with every entry with which it is associated.
+ So you can see things like this:
+\end_layout
+
+\begin_layout Quote
+Jason Stanley,
+\begin_inset Quotes eld
+\end_inset
+
+Context and Logical Form
+\begin_inset Quotes erd
+\end_inset
, in
\emph on
\begin_layout Standard
There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
\end_layout
\begin_layout Chapter
\begin_layout Standard
The LyX server works through the use of a pair of named pipes.
These are usually located in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
local
\emph default
named pipes are special objects located in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
External programs write into
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and read back data from
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The stem of the pipe names can be defined in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
dialog, for example
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- on Windows.
+ on Windows (but any working path can be used).
You
\emph on
must
\begin_layout Standard
LyX will add the '
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
' and '
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
To have several LyX processes with servers at the same time, you have to
use different configurations, perhaps by using separate user directories,
each with its own
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
If you are developing a client program, you might find it useful to enable
debugging information from the LyX server.
Do this by starting LyX as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can find a complete example client written in C in the source distribution
as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Another useful tool is command-line based client you will find in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Quote
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lyxsocket
\emph default
) that LyX creates in its temporary directory (this is the way the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Subsection
-
-\change_inserted 1 1271453726
+Automatic setup
\begin_inset CommandInset label
LatexCommand label
name "sub:rev-search"
\end_inset
-\change_unchanged
-Enabling reverse search
\end_layout
\begin_layout Standard
-LaTeX provides several different methods for reverse search.
- Some are built-in in the
-\begin_inset Flex CharStyle:Code
+In most cases LyX will do the work for you by enabling the option
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-latex/pdflatex
+Synchronize with Output
\end_layout
\end_inset
- program, some are provided by external packages.
- Your choice depends on whether your LaTeX distribution already provides
- a given method (the built-in methods are rather new) and whether your viewer
- can cope with it.
- The available methods are described in the following.
+ in the menu
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
\end_layout
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
+\end_inset
+
+.
+ In such a case LyX will automatically insert the necessary SyncTeX macro
+ (for PDF) or load the srcltx package (for DVI) respectively.
+ This option can be easily reached also on
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+View/Update
+\end_layout
+
+\end_inset
+
+ Toolbar.
\end_layout
\begin_layout Standard
-This method provides the DVI file with the necessary information for reverse
- search.
- It is available in LaTeX since quite some time (any somewhat recent LaTeX
- distribution should include it), and it works reliably.
- To enable it, change the
-\begin_inset Flex CharStyle:MenuItem
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Synchronize with Output
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Note that the method
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{}
+\backslash
+synctex=1
\end_layout
\end_inset
-eX (plain)->DVI
+ 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
- or
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+.
+\end_layout
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_layout Standard
+Please aöso note that including the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+srcltx
\end_layout
\end_inset
-eX (plain)->DraftDVI
+ package or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src-specials
\end_layout
\end_inset
- converter in
-\begin_inset Flex CharStyle:MenuItem
+ sometimes has an undesired impact on the typesetting.
+ Thus, you should switch output synchronization off for the final typesetting
+ if you use the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+srcltx
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+ package or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex -src-specials $$i
+src-specials
\end_layout
\end_inset
.
- If this doesn't work, check if your TeX engine needs different options
- (the syntax might differ in some distributions).
-\end_layout
-
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
+
+\end_layout
+
+\begin_layout Standard
+In case you need some more special settings that are not covered by the
+ automatic settings, read the next section about how to set up output synchroniz
+ation manually.
+ If the automatic setup suits your needs, you can readily jump to section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:configuring-viewers"
+
+\end_inset
+
+, where the necessary configuration steps in your viewer -- needed both
+ with the automatic and the manual setup -- are described.
+\end_layout
+
+\begin_layout Subsection
+Manual setup
+\end_layout
+
+\begin_layout Standard
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latex/pdflatex
+\end_layout
+
+\end_inset
+
+ program, some are provided by external packages.
+ Your choice depends on whether your LaTeX distribution already provides
+ a given method (the built-in methods are rather new) and whether your viewer
+ can cope with it.
+ The available methods are described in the following.
+\end_layout
+
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
+\end_layout
+
+\begin_layout Standard
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in LaTeX since quite some time (any somewhat recent LaTeX
+ distribution should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
+\end_layout
+
+\end_inset
+
+eX (plain)->DVI
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
+\end_layout
+
+\end_inset
+
+eX (plain)->DraftDVI
+\end_layout
+
+\end_inset
+
+ converter in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latex -src-specials $$i
+\end_layout
+
+\end_inset
+
+.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
+\end_layout
+
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Recent versions of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
To enable SyncTeX for DVI output, change the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
converter in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, and for PDF output, change the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
or converter to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-The
-\begin_inset Flex CharStyle:Code
+Note that the option
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
option enables gzip compression.
If your viewer does not support it, you should instead use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Subsection
Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:configuring-viewers"
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection*
\begin_layout Standard
If you use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
, you don't need to do anything else for performing a reverse DVI search,
as LyX already provides the necessary hooks for automatically using the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
However, if for whatever reason you want to use the named pipe instead of
the socket for communicating with LyX, simply change the DVI viewer in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
On Mac OSX you have to use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
XServer pipe path specified in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
In the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
folder of a source distribution you can find a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
At the end of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Enter
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
to the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, and then in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and add the command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Launch yap, choose its
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
to open a file dialog and navigate to the directory containing the batch
file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
(see below).
Select
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and then specify the program arguments as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Make sure that the LyXServer pipe path you specified in LyX is
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, otherwise change the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First of all, make sure that yap is your default DVI viewer in the Windows
environment, then launch it, choose its
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to open a file dialog and navigate to the directory containing the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
program (which is installed by default on Cygwin along with the LyX executable).
Select
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and then specify the program arguments as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
lyxpipe
\emph default
, omit the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+SumatraPDF -inverse-search "lyxeditor -g %f %l"
\end_layout
\end_inset
in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-SumatraPDF.sh
-\end_layout
-
-\end_inset
-
- is the following script (to be placed in your command PATH,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-/usr/local/bin
-\end_layout
-
-\end_inset
-
- being the best choice):
-\end_layout
-
-\begin_layout LyX-Code
-#!/bin/bash
-\begin_inset Newline newline
-\end_inset
-
-cd $(dirname $1)
-\begin_inset Newline newline
-\end_inset
-
-SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
-\end_layout
-
-\begin_layout Standard
-This wrapper script is needed because SumatraPDF is a native Windows application
- and does not understand the posix paths used by the Cygwin version of LyX.
- If SumatraPDF.exe is not in your command PATH, use its full posix path in
- the script above.
+.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph default
.
Again, omit the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Reverse search is triggered by double-click.
-\change_inserted 1 1271453423
-
\end_layout
\begin_layout Section
-
-\change_inserted 1 1271453442
Forward search
\end_layout
\begin_layout Standard
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
+\end_inset
+
+opposite
+\begin_inset Quotes erd
+\end_inset
+
+ to 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
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Navigate\SpecialChar \menuseparator
+Forward search
+\end_layout
+
+\end_inset
+
+ (or select
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Forward search
+\end_layout
+
+\end_inset
+
+ in the context menu via right mouse click), and then the viewer will jump
+ to that position as well.
+ This implies, of course, that your viewer supports this function.
+\end_layout
-\change_inserted 1 1271454338
-To make forward search possible you need to provide generated output PDF/DVI
- file with additional information about TeX sources.
+\begin_layout Standard
+To make forward search possible, you first need to provide the generated
+ output PDF/DVI file with additional information about the TeX sources.
This can be done via the methods described in the section
\begin_inset CommandInset ref
LatexCommand ref
\end_layout
\begin_layout Standard
-
-\change_inserted 1 1271454479
-Secondly you need to configure LyX for using your viewers in
-\begin_inset Flex CharStyle:MenuItem
+Additionally, you need to configure LyX for using your viewers in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1 1271453866
+Tools\SpecialChar \menuseparator
Preferences\SpecialChar \menuseparator
Output\SpecialChar \menuseparator
General
\end_inset
.
- Only some of the viewers allows this operation --- yap, xdvi, okular, Sumatra
- PDF
+ We provide a range of tested configurations for some viewers, which you
+ 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:
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$n
+\end_layout
+
+\end_inset
+
+: row number
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$t
+\end_layout
+
+\end_inset
+
+: name of the (temporary) exported .tex file
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$o
+\end_layout
+
+\end_inset
+
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
+\end_layout
+
+\begin_layout Standard
+Note that only some of the viewers provide full forward search functionality,
+ among them yap, xdvi, okular and Sumatra PDF.
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
+For Sumatra CMCDDE is needed --- downloadable from
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.istri.fr/zip/CMCDDE.zip"
+
+\end_inset
-\change_inserted 1 1271454273
-For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
-ip
-\change_unchanged
\end_layout
+\end_inset
+
+ While many of the widespread PDF viewers (most notably Adobe Reader) do
+ not support forward search at all, some other viewers -- e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ evince and xpdf -- allow at least to reload the document and jump to a
+ specific page of the file, so you can at least navigate
+\begin_inset Quotes eld
+\end_inset
+
+near
+\begin_inset Quotes erd
\end_inset
.
- Some other viewers allow at least reloading and positioning to particular
- page of the file --- Evince or xpdf --- for these cases you can use external
- call of synctex.
- Please study the prepared examples in the Preferences dialog.
-\change_unchanged
+ These latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+
+\end_layout
+
+\begin_layout Standard
+Forward search works both with DVI and PDF output.
+ LyX simply checks which preview format you have used before (i.
+\begin_inset space \thinspace{}
+\end_inset
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
\end_layout
\begin_layout Chapter
\begin_layout Standard
A manual comes together with that package, and this text is not meant to
- replace the original manual but merely a short guide how to realize the
- correct form of your paper.
+ replace the original manual but is merely a short guide in how to realize
+ the correct form of your paper.
\end_layout
\begin_layout Standard
Please note that the publisher of the journal was changed from Springer
to EDP Sciences starting January 1, 2001.
- That change implicated also some slight changes of the style files, namely
+ That change involved also some slight changes to the style files, namely
the removal of the thesaurus command.
The LyX class aa supports the newest version of these style files, V 5.01.
If you have an older version installed, please upgrade.
Things that work as expected
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Standard
Because they work as you might expect, I simply list them and the section
they are found in:
Document
\family default
.
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Things that work, but require more comment
+\end_layout
+
+\begin_layout Subsubsection
+Things that work, but require more comment
\end_layout
\begin_layout Standard
Things not implemented, use TeX code
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Standard
\family typewriter
(3.2)
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Subsubsection
Things that cannot be implemented
\end_layout
\begin_layout Standard
by
\noun on
-David Johnson; updated by Richard Heck
+David Johnson
+\noun default
+; updated by
+\noun on
+Richard Heck
\end_layout
\begin_layout Standard
They do not, in particular, contain any of the `theorem' environments used
for setting theorems, lemmas, and the like.
These are contained, instead, in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
classes.
(It can also be used with other classes and can be removed, if you would
rather use something else.) Less commonly used environments are in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
By default, theorems and the like are numbered consecutively throughout
the document, but this may be modified by loading the module
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or, if you are using
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, the module
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
only
\emph default
unnumbered results, the module
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph default
to be used with the AMS classes.
It is perfectly possible to use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
module, and the others mentioned, with other classes, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The following environments—as well as the standard environments, such as
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
—are provided by
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The following environments are provided by both the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
(numbered) versions.
These same environments are provided only in the starred versions by the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
And these environments are provided by
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-By
-\noun on
-Rod Pinna
-\end_layout
-
-\begin_layout Standard
-Elsevier Science Publishers B.V.
- provides a standard LaTeX document class (
+See the LyX template file
\family typewriter
-elsart.cls
+elsarticle.lyx
\family default
-) for submitting articles to their various journals.
- The style file can be downloaded directly from their web site:
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://authors.elsevier.com/
-\end_layout
-
-\end_inset
-
.
- Instructions are supplied along with the class file, which details the
- requirements of the publishers.
- LyX includes package that allows for the use of this class, by a layout
- and a template file.
- Installation of the class file is the same as for any other LaTeX package;
- instructions are provided in the Elsevier documentation.
-\end_layout
-
-\begin_layout Standard
-To make use of
-\family typewriter
-elsart.cls
-\family default
-, a file
-\family typewriter
-elsart.layout
-\family default
- is supplied.
- As the Elsevier class file is based mainly on the standard article class,
- most of the normal functionality is provided.
- The Elsevier class defines a number of mathematical environments, which
- are similar to the AMS environments.
- These commands are all described in the Elsevier documentation, and are
- available in LyX.
-\end_layout
-
-\begin_layout Standard
-The easiest way to use the Elsevier style is to base documents on the included
- template file.
- It is best not to use options such as fancy headings or the geometry package,
- as elements such as these are defined by Elsevier in their style file.
- Ideally, no extra packages except those mentioned in the Elsevier documentation
- should be used.
- Essentially, Elsevier require as
-\begin_inset Quotes eld
-\end_inset
-
-clean
-\begin_inset Quotes erd
-\end_inset
-
- a LaTeX file as possible, as their intention is to take the supplied file
- and replace the class file with one for the particular journal to which
- the paper has been submitted.
- This also means that not too much time should be spent on the formating
- of the document.
- When it comes to be published, this will change anyway.
- The rest of the usage for this layout is substantially the same as for
- the normal article class.
- For details of what Elsevier do and don't allow, refer to their documentation.
+ It contains all infos you need.
\end_layout
\begin_layout Section
command to implement table captions.
As a result, a table created by LyX is printed correctly, but its caption
is ignored.
- However, you can use some TeX code to overpass this problem, so that captions
+ However, you can use some TeX code to overcome this problem, so that captions
are printed as expected.
To do so, create a float table as usual, remove the caption, and replace
it with the TeX code
\end_layout
\begin_layout Itemize
-To be able to compile your document to a PDF, PS, or DVI, assure that the
+To be able to compile your document to a PDF, PS, or DVI, ensure that the
two options
\family sans
Use AMS math package
\emph default
, but there are many others (see a complete list at
\begin_inset Flex URL
-status collapsed
+status open
\begin_layout Plain Layout
Document
\family default
).
- A detailed German description of these options can be found in the Koma-Script
- documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
Settings
\family default
.
- A detailed German description of these and other type area options can
- be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-A detailed German description of the LaTeX document classes of the Koma-Script
- family can be found in the Koma-Script documentation
+Detailed descriptions of the LaTeX document classes of the Koma-Script family
+ can be found in the Koma-Script documentation
\emph on
scrguide
\emph default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-There is an English translation
+ (German) and
\emph on
-screnggu
+scrguien
\emph default
-, but it is not a complete one.
-\end_layout
-
-\end_inset
-
- The following sections describe only those aspects, which are relevant
- in LyX.
+ (English).
\end_layout
\begin_layout Subsection
letter (koma-script)
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Standard
\noindent
The document class
Furthermore, there are a number of new letter specific types.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Standard
The appearance of the letter produced by this document class can be controlled
by a number of LaTeX commands, which you can put in the LaTeX preamble.
.
It has — on the LaTeX side — a completely new interface and is not compatible
with the old class.
- Therefore, LyX supports both, though it is recommended to use the new class.
+ Therefore, LyX supports both, though it is recommended you use the new
+ class.
\end_layout
\begin_layout Standard
\begin_layout Standard
The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
+ to meet almost any needs.
This can be done via the preamble or with a special style file (Letter
Class Option, extension
\family typewriter
document to produce the gap, which is not what is wanted in this case.
\end_layout
-\begin_layout Section
-Latex8 (IEEE Conference Papers)
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Allan Rae
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-Since this class is specifically for writing submissions to IEEE sponsored
- conferences I strongly recommend that you get a copy of their Authors Kit.
- The
-\family sans
-latex.sty
-\family default
- package and associated bibliography style file is included in the kit.
- The Authors Kit is usually sent out by email once your initial submission
- has been accepted.
- There is a lot of useful information in the Authors Kit explaining formatting
- restrictions and so on and I will assume you have read this since that
- means I don't have to repeat it all here.
-\end_layout
-
-\begin_layout Subsection
-Getting Started
-\end_layout
-
-\begin_layout Standard
-[AR\SpecialChar \@.
- more to come]
-\end_layout
-
-\begin_layout Subsection
-Supported Environments
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Standard
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Title
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Author
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-E-mail
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Affiliation
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Abstract
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Section
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-SubSection
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Caption
-\end_layout
-
-\begin_layout Subsection
-Differences Between Screen and Paper
-\end_layout
-
-\begin_layout Standard
-There are slight differences in appearance mainly with the presentation
- of section counters.
- On screen the trailing period of the section counter is missing but it
- will appear in the output so don't let this worry you.
-\end_layout
-
\begin_layout Section
Memoir
\end_layout
).
In this section, we can only list those features which are natively supported
by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
+ 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 Foot
status collapsed
\end_inset
style: The fancy page style is not supported, due to a command clash between
- Memoir and the fancyhdr package (they are both defining a command with
- the same name, which confuses LaTeX).
- Instead, Memoir comes with a bunch of own page styles (see
+ Memoir and the fancyhdr package (they both define a command with the same
+ name, which confuses LaTeX).
+ Instead, Memoir comes with a number of its own page styles (see
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
\end_layout
\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
+Sectioning: Sectionings (chapter, section, subsection etc.) come with an
+ optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
In LyX, you can do this via
\end_layout
\begin_layout Description
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
+Chapterprecis: You may know this older typesetting style: The contents of
+ a chapter are summarized below the title and also in the table of contents
(e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
Slide
\family default
, for example.
- In that case, enter in your descriptive comment and hit
+ In that case, enter your descriptive comment and hit
\family sans
Return
\family default
\end_layout
\begin_layout Standard
-If, on the other hand, you don't want to enter in any descriptive text,
- you'll hit another LyX quirk.
+If, on the other hand, you don't want to enter any descriptive text, you'll
+ hit another LyX quirk.
LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
environment until you put something in the old one.
So, do this:
ChkTeX
\family default
package is a program that was written by
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
ChkTeX
\family default
to get better along with you.
- Another choice in the most desperate situations is to use
-\family sans
-View\SpecialChar \menuseparator
-Remove
-\begin_inset space ~
-\end_inset
-
-All
-\begin_inset space ~
-\end_inset
-
-Error
-\begin_inset space ~
-\end_inset
-
-Boxes
-\family default
-, which will get rid of all warnings instantly.
\end_layout
\begin_layout Standard
it.
This angered me a bit, so I thought that I should at least make support
for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has now been done.
- LyX now supports some of the most basic RCS commands.
- If you need to something a bit more sophisticated you will have to do that
+ This has been done.
+ LyX now supports some of the most basic RCS/CVS/SVN commands.
+ If you need something a bit more sophisticated you will have to do that
manually in a terminal.
\end_layout
\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- read
+Also note that CVS support is not as good as subversion support so we advice
+ using SVN instead.
+ Good place to start with Subversion is SVN Book
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+\begin_inset CommandInset href
+LatexCommand href
+target "http://svnbook.red-bean.com/"
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+.
+ In case of RCS you should read
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-Later basic CVS/SVN support was added.
- You should be familiar with CVS/SVN usage before start using it under LyX.
- Most of the log messages are not currently displayed after operations -
- you can check them in Messages pane if unsure.
-\end_layout
-
-\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+Before you begin to use the version control features in LyX, you should
+ be familiar with RCS/CVS/SVN usage.
+ 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.
\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.
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-This show the complete history of the RCS document.
+This shows the complete history of the RCS document.
The output of
\family typewriter
rlog <file-name>
\end_layout
\begin_layout Standard
-LyX supports RCS version number information (only), see
+LyX supports RCS version number, author name, date and time of last commit.
+ All those are extracted from
+\family typewriter
+rlog -r <file-name>
+\family default
+.
+ For other details see
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:VCS-Revision-Information"
\end_layout
\begin_layout Standard
-CVS is now partially supported by LyX.
+A subset of CVS operations is supported by LyX.
You can find the commands in the
\family sans
File\SpecialChar \menuseparator
Control
\family default
submenu.
- Focus of the development moved to SVN support, so please use it instead
+ The version control system SVN is more powerful, so please use it instead
of CVS if possible.
\end_layout
\begin_layout Subsubsection
\family sans
-Register
-\end_layout
-
-\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
-\bar under
-R
-\bar default
-egister
-\family default
- item is not visible.
-
-\end_layout
-
-\begin_layout Standard
-This command registers in CVS your document ONLY in case you have already
- the documents directory under CVS control (in particular
-\family typewriter
-CVS/Entries
-\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
+General CVS usage
\end_layout
\begin_layout Standard
-Then you are asked interactively to supply an initial description of the
- document.
- Don't forget that registered file is not yet commited.
+If you start from scratch with CVS you have to create your repository and
+ checkout the working copy with external tools.
+ If you're using a client-server setup you may need to login before doing
+ the first repository checkout.
\end_layout
\begin_layout Standard
-CVS command that is run:
-\family typewriter
-cvs -q add -m
-\begin_inset Quotes erd
-\end_inset
-
-<entered message>"
+If your documents are under revision control and others are using the same
+ repository problems arise when different changes to the same document at
+ the same location happen.
+ Standard CVS repositories doesn't operate with a file locking mechanism.
+ This may be surprising, but conflicts only occur if people disagree on
+ the proper content of the same part of a document.
+ So, if co-workers are used to communicate regularly, these conflicts occur
+ rarely.
+ If they don't communicate they have a fundamental problem anyway.
+ Nevertheless some people like to work with so called
\begin_inset Quotes eld
\end_inset
-<file-name>
+reserved checkouts
\begin_inset Quotes erd
\end_inset
+.
+ If they do so the working copy of all files is readonly when checked out
+ first and the user starts editing after using a special command to make
+ the working copy writable.
+ When the changes are checked in the working copy returns to readonly state.
+ With LyX one has to edit the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+.cvsrc
\end_layout
-\begin_layout Standard
-Read
-\family typewriter
-man svn
-\family default
- to understand the switches.
-
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Check In Changes
-\end_layout
+\end_inset
-\begin_layout Standard
-When you are finished editing a file, you commit your changes.
- When you do this, you are asked for a description of the changes.
- After that changes are commited.
-\end_layout
+ file and add the line
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs -q commit -m"<description>" "<file-name>"
+\begin_layout Plain Layout
+cvs -r
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Revert To Repository Version
+ to work with reserved checkouts.
+ The benefit is the possibility to see who is using a writable copy of some
+ document.
+ It's not guaranteed only one user makes a copy writable.
\end_layout
\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
- Firstly the file is deleted, secondly CVS update command is run.
-\end_layout
+LyX tries to guess if you're using reserved or non-reserved checkouts.
+ If your working copy is readonly or it is writable and an additional copy
+ of your document exists in the CVS/Base sub-directory a reserved otherwise
+ a non-reserved checkout is assumed.
+ When a reserved checkout is detected you have to use
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs update
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Check Out
+\end_layout
-<file-name>
-\begin_inset Quotes erd
\end_inset
+ to make your working copy writable if it's readonly.
+ After doing so the
+\begin_inset Flex MenuItem
+status collapsed
+\begin_layout Plain Layout
+Check In
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Show History
+ operation is possible and that makes your working copy readonly again after
+ transferring your changes to the repository.
\end_layout
\begin_layout Standard
-This show the complete history of the CVS document.
- The output of
-\family typewriter
-cvs log
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
-\end_inset
-
+More information about CVS can be found here
+\begin_inset Flex URL
+status collapsed
-\family default
- is shown in a browser.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsection
-SVN commands in LyX
+http://www.nongnu.org/cvs
\end_layout
-\begin_layout Standard
-SVN is now partially supported by LyX.
- You can find the commands in the
-\family sans
-File\SpecialChar \menuseparator
-Version
-\begin_inset space ~
\end_inset
-Control
-\family default
- submenu.
- Please note that if you use password protected access to repository via
- ssh, you will be asked in terminal window.
- LyX was tested against SVN 1.5 and 1.6
-\begin_inset Foot
+ and here
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-Most of the commands will work with 1.4 too, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:SVN-Repo-Update"
-\end_inset
-
-.
+http://ximbiot.com/cvs
\end_layout
\end_inset
+.
+\end_layout
+\begin_layout Standard
+Read
+\family typewriter
+man cvs
+\family default
+ to understand the sub-commands and the switches mentioned below.
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-This command registers in SVN your document ONLY in case you have already
- the documents directory under SVN control (in particular
+This command registers in CVS your document
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+only
+\end_layout
+
+\end_inset
+
+ in case you have already the documents directory under CVS control (in
+ particular
\family typewriter
-.svn/entries
+CVS/Entries
\family default
file exists).
- This means you have to checkout the archive by yourself.
-
+ This means you have to create or checkout the archive by yourself using
+ external tools.
+ (In case you forget that step LyX registers the document with RCS.)
\end_layout
\begin_layout Standard
Then you are asked interactively to supply an initial description of the
document.
- Don't forget that registered file is not yet commited.
+ Don't forget that registered file is not yet checked in.
\end_layout
\begin_layout Standard
-SVN command that is run:
+CVS command that is run:
\family typewriter
-svn add -q
+cvs -q add -m"<entered message>" "<file-name>"
+\end_layout
+
+\begin_layout Standard
+The term
+\family typewriter
+"<file-name>"
+\family default
+ above and for all other CVS commands is an abbreviation for
\begin_inset Quotes eld
\end_inset
-<file-name>
+change the current working directory to file location and use the file name
+ without path component as argument
\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Read
-\family typewriter
-man svn
-\family default
- to understand the switches.
-
+.
\end_layout
\begin_layout Subsubsection
\begin_layout Standard
When you are finished editing a file, you commit your changes.
- When you do this, you are asked for a description of the changes.
- After that changes are commited.
-\end_layout
-
-\begin_layout Standard
-SVN command:
-\begin_inset Foot
+ When you do this and you had changed the document, you are asked for a
+ description of the changes.
+ After that changes are written to the repository.
+ In case you didn't change the document and a reserved checkout is detected
+ the reservation made on
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-In case locking is not enabled.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:SVN-File-Locking"
+Check Out
+\end_layout
\end_inset
-.
+ is undone.
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
-
-\family typewriter
-svn commit -q -m"<description>" <file-name>
-\end_layout
+command:
+\begin_inset space ~
+\end_inset
-\begin_layout Subsubsection
-\family sans
-Check Out For Edit
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-Updates the changes of this file from the repository.
- Be sure you understand SVN merging and conflicts resolving before using
- this function, because all conflicts has to be resolved manually by you!
-\end_layout
-\begin_layout Standard
-SVN command:
-\begin_inset Foot
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Ditto.
+cvs
+\family typewriter
+-q commit -m"<description>" "<file-name>"
\end_layout
\end_inset
-
-\family typewriter
-svn update --non-interactive
-\begin_inset Quotes eld
+ or
+\begin_inset Newline newline
\end_inset
-<file-name>
-\begin_inset Quotes erd
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q unedit
+\family typewriter
+"<file-name>"
+\end_layout
+
\end_inset
\begin_layout Subsubsection
\family sans
-Revert To Repository Version
+Check Out Changes
\end_layout
\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
-
+When you are sharing a repository with others, you may have to incorporate
+ their changes into your working copy.
\end_layout
\begin_layout Standard
-SVN command:
+CVS command:
\family typewriter
-svn revert -q
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+cvs -q update "<file-name>"
+\end_layout
+\begin_layout Standard
+If a readonly checkout is detected the working copy is made writable and
+ reserved.
+\end_layout
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q edit "<file-name>"
\end_layout
\begin_layout Subsubsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:SVN-Repo-Update"
-
-\end_inset
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
+\end_layout
+
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q update "<file-name>"
+\end_layout
+
+\begin_layout Standard
+If a reserved checkout is detected and the working copy has no changes only
+ the reservation is undone.
+\end_layout
+
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q unedit "<file-name>"
+\end_layout
+
+\begin_layout Subsubsection
Update of the local directory checkout from repository
-\begin_inset Foot
+\end_layout
+
+\begin_layout Standard
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that this command will work only with subversion
-\begin_inset Formula $\geqq1.5$
+.tex
+\end_layout
+
\end_inset
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Update local directory from repository
\end_layout
\end_inset
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+<<<<<<<
\end_layout
-\begin_layout Standard
-All the commands above have one shortcomming - they deal with the current
- document only.
- Once your document contains pictures, includes external
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.tex
+>>>>>>>
\end_layout
\end_inset
- files and so on administration becomes more complicated.
- LyX now supports updating the whole tree in which resides the document
-\begin_inset Foot
+ separated by
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-One need to organize the files structure so that all external files are
- in the same directory or subdirectories of the document.
-
+=======
\end_layout
\end_inset
.
- This become especially useful once you cooperate with people which neither
- know about subversion management nor they have ambition to commit additional
- material to the repository.
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Update local directory from repository
+>
\end_layout
\end_inset
- command updates the whole directory and in case of merge conflicts local
- version of the files are left, so no unintended data loss occurs.
- If local changes are detected user is warned before update starts.
+ signs.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-SVN
+CVS
\begin_inset space ~
\end_inset
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn diff $path
+cd $path; cvs diff
+\family typewriter
+"."
\end_layout
\end_inset
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn update --accept mine-full $path
+cd $path; cvs -q update
+\family typewriter
+"."
\end_layout
\end_inset
\begin_layout Standard
where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-This show the complete history of the SVN document.
+This shows the complete history of the CVS document.
The output of
\family typewriter
-svn log
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
-\end_inset
-
-
+cvs log "<file-name>"
\family default
is shown in a browser.
\end_layout
-\begin_layout Subsubsection
-File Locking
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:SVN-File-Locking"
-
-\end_inset
-
-
+\begin_layout Subsection
+SVN commands in LyX
\end_layout
\begin_layout Standard
-The file exchange through various revision control systems brings the problem
- of merge conflicts in case two different users try to edit the same (parts
- of) document.
- When such conflict happens it needs manual resolving and one reasonable
- alternative is to provide some kind of locking mechanism, which guarantees
- that only one user is allowed to edit file at the given time.
-\end_layout
+SVN is now partially supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-SVN has two mechanisms to provide such kind of mutual exclusivity for file
- access - locks and automatical setting of write permissions (see sec.
-
+Control
+\family default
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against SVN 1.5 and 1.6
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Most of the commands will work with 1.4 too, see
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Automatical-Locking-Property"
+reference "sub:SVN-Repo-Update"
\end_inset
-) based on
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-svn:needs-lock
+.
\end_layout
\end_inset
- file svn property
-\begin_inset Foot
-status open
-\begin_layout Plain Layout
-http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
\end_layout
-\end_inset
+\begin_layout Subsubsection
-.
- In a case this property is detected for a given document LyX starts to
- use SVN locks for document editing automatically and the whole check-in/out
- mechanism switches to the same regimen as for RCS.
- This in particular means there are two different modes how file is used
- in LyX:
+\family sans
+Register
\end_layout
-\begin_layout Itemize
-Unlocked state.
- The loaded file is in the read-only mode.
- For editation on needs to check-out.
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
-\emph on
-Check-out
-\emph default
- consists of update from repository and gaining write lock.
- If the lock is not possible to obtain, we remain in unlocked state.
\end_layout
-\begin_layout Itemize
-Locked state.
- The loaded file is in the 'normal' edit mode.
- No other user is allowed to edit the file.
+\begin_layout Standard
+This command registers in SVN your document ONLY in case you have already
+ the documents directory under SVN control (in particular
+\family typewriter
+.svn/entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
-\emph on
-Check-in
-\emph default
- consists of commiting changes and releasing write-lock.
- If no changes have been made to the document, no commit will be produced
-\begin_inset Foot
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-Don't be puzzled by the fact that you will be asked for commit message anyway.
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
\end_layout
+\begin_layout Standard
+SVN command that is run:
+\family typewriter
+svn add -q
+\begin_inset Quotes eld
\end_inset
- and only the write-lock will be released.
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
\begin_layout Standard
-SVN commands:
+Read
+\family typewriter
+man svn
+\family default
+ to understand the switches.
+
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Check-in:
-\family typewriter
- svn commit -q -m"<description>" "<file-name>"
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsubsection
-svn unlock "<file-name>"
+\family sans
+Check In Changes
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Check-out:
-\family typewriter
-svn update "<file-name>"
-\begin_inset Newline newline
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In case locking is not enabled.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:SVN-File-Locking"
+
\end_inset
-svn lock "<file-name>"
+.
\end_layout
-\begin_layout Subsubsection
+\end_inset
+
\family typewriter
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Automatical-Locking-Property"
-
-\end_inset
+svn commit -q -m"<description>" <file-name>
+\end_layout
+\begin_layout Subsubsection
-\family default
-Automatical Locking Property
+\family sans
+Check Out For Edit
\end_layout
\begin_layout Standard
-The above mentioned automatical setting of write permissions of the .lyx
- file can be set through
-\family sans
-\bar under
- F
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be resolved manually by you!
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Ditto.
+\end_layout
+
+\end_inset
+
+
+\family typewriter
+svn update --non-interactive
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\family typewriter
+svn revert -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:SVN-Repo-Update"
+
+\end_inset
+
+Update of the local directory checkout from repository
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this command will work only with subversion
+\begin_inset Formula $\geqq1.5$
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+All the commands above have one shortcomming - they deal with the current
+ document only.
+ Once your document contains pictures, includes external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
+\end_layout
+
+\end_inset
+
+ files and so on administration becomes more complicated.
+ LyX now supports updating the whole tree in which resides the document
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+One need to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+
+\end_layout
+
+\end_inset
+
+.
+ This become especially useful once you cooperate with people which neither
+ know about subversion management nor they have ambition to commit additional
+ material to the repository.
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
+\end_inset
+
+ command updates the whole directory and in case of merge conflicts local
+ version of the files are left, so no unintended data loss occurs.
+ If local changes are detected user is warned before update starts.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn diff $path
+\end_layout
+
+\end_inset
+
+ (Ask if changes are detected.)
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn update --accept mine-full $path
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$path
+\end_layout
+
+\end_inset
+
+ stands for the path to the document.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the SVN document.
+ The output of
+\family typewriter
+svn log
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ is shown in a browser.
+\end_layout
+
+\begin_layout Subsubsection
+File Locking
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:SVN-File-Locking"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The file exchange through various revision control systems brings the problem
+ of merge conflicts in case two different users try to edit the same (parts
+ of) document.
+ When such a conflict happens it needs manual resolving and one reasonable
+ alternative is to provide some kind of locking mechanism, which guarantees
+ that only one user is allowed to edit file at the given time.
+\end_layout
+
+\begin_layout Standard
+SVN has two such mechanisms to provide mutual exclusivity for file access
+ - locks and automatic setting of write permissions (see sec.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Automatical-Locking-Property"
+
+\end_inset
+
+) based on
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn:needs-lock
+\end_layout
+
+\end_inset
+
+ file svn property
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
+\end_layout
+
+\end_inset
+
+.
+ If this property is detected for a given document LyX starts to use SVN
+ locks for document editing automatically and the whole check-in/out mechanism
+ switches to the same regimen as for RCS.
+ This in particular means there are two different modes of file use in LyX:
+\end_layout
+
+\begin_layout Itemize
+Unlocked state.
+ The loaded file is in the read-only mode.
+ For editing on needs to check-out.
+
+\emph on
+Check-out
+\emph default
+ consists of updating from the repository and gaining write lock.
+ If the lock is not possible to obtain, we remain in unlocked state.
+\end_layout
+
+\begin_layout Itemize
+Locked state.
+ The loaded file is in the 'normal' edit mode.
+ No other user is allowed to edit the file.
+
+\emph on
+Check-in
+\emph default
+ consists of commiting changes and releasing write-lock.
+ If no changes have been made to the document, no commit will be produced
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Don't be puzzled by the fact that you will be asked for commit message anyway.
+\end_layout
+
+\end_inset
+
+ and only the write-lock will be released.
+\end_layout
+
+\begin_layout Standard
+SVN commands:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-in:
+\family typewriter
+ svn commit -q -m"<description>" "<file-name>"
+\begin_inset Newline newline
+\end_inset
+
+svn unlock "<file-name>"
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-out:
+\family typewriter
+svn update "<file-name>"
+\begin_inset Newline newline
+\end_inset
+
+svn lock "<file-name>"
+\end_layout
+
+\begin_layout Subsubsection
+
+\family typewriter
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Automatical-Locking-Property"
+
+\end_inset
+
+
+\family default
+Automatic Locking Property
+\end_layout
+
+\begin_layout Standard
+The above mentioned automatic setting of write permissions of the .lyx file
+ can be set through
+\family sans
+\bar under
+ F
\bar default
ile\SpecialChar \menuseparator
\begin_deeper
\begin_layout Itemize
tree revision information (
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
).
The result is the output of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
file revision information.
The result comes from parsing the output of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_deeper
\begin_layout Itemize
version number of the last commit (
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
author of the last commit (
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
date of the last commit (
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
time of the last commit (
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can obtain this info via InsetInfo (e.g.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
The information will be available only when you have the file stored under
svn managment (i.e.
the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family sans
svn propset svn:keywords 'Rev' file.lyx
\family default
-) and then paste keyword ERT
+) and then paste keyword TeX code
\begin_inset Foot
status collapsed
\end_layout
\begin_layout Subsubsection
-SSH tunel used with SVN under Windows
+SSH tunnel used with SVN under Windows
\end_layout
\begin_layout Standard
-Compared to linux setting svn client to communicate over ssh under Windows
- is rather troublesome task.
- We will at least make some hints how to setup client side but former knowledge
- about ssh and Windows command line is needed, also be prepared for a great
- deal of frustration...
+Compared with Linux setting up 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
+ for a great deal of frustration\SpecialChar \ldots{}
+
\end_layout
\begin_layout Enumerate
-Get svn client for windows, as described in previous sections.
- When it is fresh install run some svn command (e.g.
+Get a 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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-) to have created config files, which you will need to change later on.
+) to create config files, which you will need to change later on.
\end_layout
\begin_layout Enumerate
-Choose ssh client for Windows.
- There are more possibilities, we will use the one from Putty tools
+Choose a ssh client for Windows.
+ There are several possibilities, we will use the one from Putty tools
\begin_inset Foot
-status collapsed
+status open
\begin_layout Plain Layout
\begin_inset Flex URL
\end_inset
.
- You will need to automatize connection, so client doesn't ask for any password
- from you.
+ You will need to set the connection up so that the client doesn't ask for
+ any password from you.
To keep things easy we will use only keys without any additional password
protection etc.
\end_layout
\begin_deeper
\begin_layout Enumerate
Generate keys by
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Save your private .ppk key file and put the public one on the server side.
- In case the SVN server runs on linux, note that the format of the public
- key is not compatible with linux openssh and you will need to direcly copy-past
-e the key from the “
+ If the SVN server runs on Linux, note that the format of the public key
+ is not compatible with Linux openssh and you will need to direcly copy-paste
+ the key from the “
\emph on
Public key for pasting into OpenSSH authorized_keys file
\emph default
:” edit field into the server's
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
/
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Get the Putty's
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
Exact path depends on Windows version, usually somewhere around
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
/
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
, section [tunnels], setup ssh command, e.g.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Checkout the SVN archive, e.g.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
\end_layout
+\begin_layout Subsubsection
+End-of-Line Conversions
+\end_layout
+
+\begin_layout Standard
+When the collaborators are mixing Linux and Windows environments, LyX will
+ use different line endings inside the .lyx files.
+ This is not a problem as far as LyX functionality is concerned, but the
+ commit diffs will be huge and merge-conflicts prone.
+ Fortunately SVN itself knows
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ how to deal with CR/LF problems when switching .lyx files to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+native
+\end_layout
+
+\end_inset
+
+ mode.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For the lazy guys:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn propset svn:eol-style native FILE_NAME
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
\begin_layout Subsection
Further tuning
\end_layout
\begin_layout Description
Commit:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Description
Revert:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
+\begin_layout Subsection
+Version control and Document comparison
+\end_layout
+
+\begin_layout Standard
+One of the typical uses of version control is to inspect the changes between
+ revisions, usually by creating
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+diff
+\end_layout
+
+\end_inset
+
+ 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.
+ Hence we provide binding to the Document comparison feature.
+ They are two ways of calling this feature - either by direct call of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+VC_COMPARE
+\end_layout
+
+\end_inset
+
+ LyX function (for details see LyX functions manual) or by icon/menu item
+
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Compare with older revision...
+\end_layout
+
+\end_inset
+
+.
+ One can either compare two chosen revisions of the document or he can simply
+ compare the current version of edited text with older revisions (where
+ '
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+' revisions back means comparison of the edited file with last commited
+ revision).
+
+\end_layout
+
+\begin_layout Standard
+This feature is supported for SVN and RCS though due to the more complicated
+ versioning scheme of RCS there is a constraint -- when addressing the revisions
+ in dialog, numbers always point to the last number in RCS revision number,
+ i.e.
+ '35' in '1.2.35'.
+\end_layout
+
\begin_layout Section
Literate Programming
\end_layout
\begin_layout Standard
The main purpose of this documentation is to show you how to use LyX for
- literate programming.
- Where it is assumed that you are familiar with this programming technique,
- and know what
+ literate programming, where it is assumed that you are familiar with this
+ programming technique, and know what
\begin_inset Quotes eld
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+E.
Knuth during the development of his TeX typesetting software.
\end_layout
\begin_layout Plain Layout
-http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+http://www.literateprogramming.com/lpfaq.pdf
\end_layout
\end_inset
\end_layout
\begin_layout Chapter
-Secrets of the LaTeX Masters
-\begin_inset CommandInset label
-LatexCommand label
-name "cha:secrets"
-
-\end_inset
-
-
+Special features
\end_layout
\begin_layout Standard
-Though LyX is a powerful tool, it cannot hope to support everything that
- can be done with pure TeX/LaTeX.
- However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
- as long as you are not afraid to use that
-\begin_inset Quotes eld
-\end_inset
-
-TeX
-\begin_inset Quotes erd
-\end_inset
-
- button on the toolbar or add things to the LaTeX preamble.
- This section lists some tips, tricks, and otherwise cool ideas to give
- your document that extra little flair.
-
+You can do everything with LyX that you can do with LaTeX.
+ However, LyX cannot support every LaTeX feature directly.
+ But you can always use TeX Code.
+ This chapter shows you some more special things you might want to use.
+ For other special things you can do with figures, tables, floats, boxes
+ and notes, have a look at the
\emph on
-Do try this at home
+EmbeddedObjects
\emph default
-, just start with something a little smaller and less important than your
- dissertation!
-\end_layout
-
-\begin_layout Standard
-Most ideas in this section require less common files in your LaTeX installation.
- If you have a system like teTeX, most will already be available.
- A few, however, will need to be downloaded from one of the CTAN archives.
- Often, there are several ways to do something, or several LaTeX style files
- which do the same thing.
- We do not endorse one choice over another, we simply claim that we have
- done a particular task with a particular file.
- Put on your wizard hat, keep an eye out for dragons, and let us begin.
+ manual.
\end_layout
\begin_layout Section
-Multiple Columns
+Multiple Text Columns
\end_layout
\begin_layout Standard
-by
-\noun on
-Lars Gullik Bjønnes
-\end_layout
+This feature is independent of the option
+\family sans
+Two-column document
+\family default
+ in the document settings under
+\family sans
+Text Layout
+\family default
+.
+ If you want to have 2
+\begin_inset space ~
+\end_inset
-\begin_layout Subsection
-Purpose
+columns for the whole document, it is recommended to use the
+\family sans
+Two-column document
+\family default
+ option.
+ For all other cases use this feature.
\end_layout
\begin_layout Standard
-The aim for this chapter
-\begin_inset Foot
+To use multiple text columns in your document, you have to load the module
+
+\family sans
+Multiple Columns
+\family default
+ (menu
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Modules
+\family default
+) and must have the LaTeX-package
+\series bold
+multicol
+\series default
+
+\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
-Editor's note: Lars' original chapter was a masterful description of how
- to use the
-\family typewriter
-multicol
-\family default
- package.
- However, it was too long to flow smoothly in this document.
- I have therefore chosen to excerpt the most important sections here (sorry,
- Lars); you can read the original chapter (and more of the story!) in the
- example file
-\family typewriter
-examples/multicol.lyx
-\family default
-.
- — mer
+LaTeX-packages ! multicol
\end_layout
\end_inset
- is to show how the LaTeX package
-\family typewriter
-multicol
-\family default
- can be used in a LyX document.
- As LyX doesn't support the
-\family typewriter
-multicol
-\family default
- package natively yet, we have to use some small hacks.
- By reading this section it should be obvious how to do this.
-\end_layout
-
-\begin_layout Subsection
-Limitations
+ installed.
\end_layout
\begin_layout Standard
-The
-\family typewriter
-multicol
+Footnotes within multiple columns will be placed at the bottom of the page
+ and not under each column.
+ Within the different columns you can use everything, with the limitation
+ that for floats you need to use the float option
+\family sans
+Span columns
\family default
- package allows switching between one and multicolumn format on the same
- page.
- Footnotes are handled correctly (for the most part), but will be placed
- at the bottom of the page and not under each column.
- LaTeX's float mechanism, however, is partly disabled in the current implementat
-ion.
- At the moment only page-wide floats can be used within the scope of the
- environment.
+.
\end_layout
\begin_layout Subsection
-Examples
-\end_layout
-
-\begin_layout Subsubsection
-Two columns
+Basics
\end_layout
\begin_layout Standard
-If you want to have two columns in your text, you have use LaTeX mode to
- insert
-\family typewriter
+If you want to have 2
+\begin_inset space ~
+\end_inset
-\backslash
-begin{multicols}{2}
+columns in your text, use the style
+\family sans
+Begin Multiple Columns
\family default
- at the point where you want the two column layout to start, and then
-\family typewriter
+ where the columns should start.
+ The content of the style is the number of the columns, so in this case
+ use a
+\begin_inset Quotes eld
+\end_inset
-\backslash
-end{multicols}
+2
+\begin_inset Quotes erd
+\end_inset
+
+.
+ At the point where the columns should end use the style
+\family sans
+End Multiple Columns
\family default
- where you want it to end.
- Like this:
+ and keep it empty.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
+Here is an example:
\end_layout
-\end_inset
-
-
+\begin_layout Begin Multiple Columns
+2
\end_layout
\begin_layout Standard
only withdrawn upon the third of last month.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Multiple columns
-\end_layout
+\begin_layout End Multiple Columns
-\begin_layout Standard
-The same pattern is used when you want more than two columns:
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{3}
-\end_layout
-
+Here is an example with 3
+\begin_inset space ~
\end_inset
+columns:
+\end_layout
+\begin_layout Begin Multiple Columns
+3
\end_layout
\begin_layout Standard
as they were known to the public at the conclusion of the inquest.
\end_layout
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+You can have up to 10
+\begin_inset space ~
+\end_inset
+
+columns if you want to, but that might not be very pleasant for the readers
+ of your document.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Columns inside Columns
+\end_layout
+
+\begin_layout Standard
+You can also have columns inside columns:
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
+\end_layout
+
+\begin_layout Standard
+
+\size footnotesize
+The Honourable Ronald Adair was the second son of the Earl of Maynooth,
+ at that time governor of one of the Australian colonies.
+ Adair's mother had returned from Australia to undergo the operation for
+ cataract, and she, her son Ronald, and her daughter Hilda were living together
+ at 427 Park Lane.
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
+\end_layout
+
+\begin_layout Standard
+
+\size footnotesize
+The youth moved in the best society–had, so far as was known, no enemies
+ and no particular vices.
+ He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
+ had been broken off by mutual consent some months before, and there was
+ no sign that it had left any very profound feeling behind it.
+ For the rest {sic} the man's life moved in a narrow and conventional circle,
+ for his habits were quiet and his nature unemotional.
+ Yet it was upon this easy-going young aristocrat that death came, in most
+ strange and unexpected form, between the hours of ten and eleven-twenty
+ on the night of March 30, 1894.
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+
+\size footnotesize
+Ronald Adair was fond of cards–playing continually, but never for such stakes
+ as would hurt him.
+ He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
+ It was shown that, after dinner on the day of his death, he had played
+ a rubber of whist at the latter club.
+ He had also played there in the afternoon.
+
+\size default
+
+\size footnotesize
+The evidence of those who had played with him– Mr.
+ Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
+ and that there was a fairly equal fall of the cards.
+ Adair might have lost five pounds, but not more.
+ His fortune was a considerable one, and such a loss could not in any way
+ affect him.
+ He had played nearly every day at one club or other, but he was a cautious
+ player, and usually rose a winner.
+ It came out in evidence that, in partnership with Colonel Moran, he had
+ actually won as much as four hundred and twenty pounds in a sitting, some
+ weeks before, from Godfrey Milner and Lord Balmoral.
+ So much for his recent history as it came out at the inquest.
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Subsection
+Advanced Examples
+\end_layout
+
+\begin_layout Standard
+The examples in this section show some more special features of multiple
+ columns.
+\end_layout
+
+\begin_layout Standard
+For more features of multiple columns, have a look at the documentation
+ of the LaTeX-package
+\series bold
+multicol
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! multicol
+\end_layout
+
+\end_inset
+
+,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "multicol"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+Preface
+\end_layout
+
+\begin_layout Standard
+To add a preface text for multiple columns, add the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+}[
+\end_layout
+
+\begin_layout Standard
+as TeX Code behind the number of columns in the
+\family sans
+ Begin Multiple Columns
+\family default
+ style.
+ Behind the command follows the preface text.
+ At the end of the style use the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+]{
+\end_layout
+
+\begin_layout Standard
+as TeX Code.
+ An example with some preface text:
+\end_layout
+
\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
\begin_inset ERT
-status open
+status collapsed
\begin_layout Plain Layout
+}[
+\end_layout
+
+\end_inset
-\backslash
-end{multicols}
+And the story continues and continues and continues and continues\SpecialChar \ldots{}
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+]{
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-You can have more than 3 columns if you want to, but that might not be very
- pleasant for the eye.
+
+\size small
+On the evening of the crime, he returned from the club exactly at ten.
+ His mother and sister were out spending the evening with a relation.
+ The servant deposed that she heard him enter the front room on the second
+ floor, generally used as his sitting-room.
+ She had lit a fire there, and as it smoked she had opened the window.
+ No sound was heard from the room until eleven-twenty, the hour of the return
+ of Lady Maynooth and her daughter.
+ Desiring to say good-night, she attempted to enter her son's room.
+ The door was locked on the inside, and no answer could be got to their
+ cries and knocking.
+ Help was obtained, and the door forced.
+ The unfortunate young man was found lying near the table.
+ His head had been horribly mutilated by an expanding revolver bullet, but
+ no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout Subsubsection
-Columns inside columns
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+You can also use a section heading as the preface if you use a section command
+ as TeX Code behind the first TeX Code.
+ For example the command
\end_layout
\begin_layout Standard
-You can even have columns inside columns:
+
+\series bold
+
+\backslash
+subsection{subsection title}
\end_layout
\begin_layout Standard
+creates a subsection.
+ In this example the preface is a subsubsection:
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
\begin_inset ERT
-status open
+status collapsed
+
+\begin_layout Plain Layout
+
+}[
+\end_layout
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
\backslash
-begin{multicols}{2}
+subsubsection{
\end_layout
\end_inset
+This is a subsubsection heading as a preface
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+}
\end_layout
-\begin_layout Standard
+\end_inset
-\size footnotesize
-The Honourable Ronald Adair was the second son of the Earl of Maynooth,
- at that time governor of one of the Australian colonies.
- Adair's mother had returned from Australia to undergo the operation for
- cataract, and she, her son Ronald, and her daughter Hilda were living together
- at 427 Park Lane.
-\end_layout
-\begin_layout Standard
\begin_inset ERT
-status open
+status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{multicols}{2}
+]{
\end_layout
\end_inset
\begin_layout Standard
-\size footnotesize
-The youth moved in the best society–had, so far as was known, no enemies
- and no particular vices.
- He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
- had been broken off by mutual consent some months before, and there was
- no sign that it had left any very profound feeling behind it.
- For the rest {sic} the man's life moved in a narrow and conventional circle,
- for his habits were quiet and his nature unemotional.
- Yet it was upon this easy-going young aristocrat that death came, in most
- strange and unexpected form, between the hours of ten and eleven-twenty
- on the night of March 30, 1894.
+\size small
+A minute examination of the circumstances served only to make the case more
+ complex.
+ In the first place, no reason could be given why the young man should have
+ fastened the door upon the inside.
+ There was the possibility that the murderer had done this, and had afterwards
+ escaped by the window.
+ The drop was at least twenty feet, however, and a bed of crocuses in full
+ bloom lay beneath.
+ Neither the flowers nor the earth showed any sign of having been disturbed,
+ nor were there any marks upon the narrow strip of grass which separated
+ the house from the road.
+ Apparently, therefore, it was the young man himself who had fastened the
+ door.
+ But how did he come by his death? No one could have climbed up to the window
+ without leaving traces.
+ Suppose a man had fired through the window, he would indeed be a remarkable
+ shot who could with a revolver inflict so deadly a wound.
+ Again, Park Lane is a frequented thoroughfare; there is a cab stand within
+ a hundred yards of the house.
+ No one had heard a shot.
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+If there is less vertical space left on the page at the beginning of the
+ multiple columns than needed for 6
+\begin_inset space ~
+\end_inset
+
+text lines, a page break will be inserted before the multiple columns.
+ Depending on the number of lines of the preface text, you might want to
+ change this value.
+ It is determined by inserting the command
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
+\series bold
+][number
\backslash
-end{multicols}
+baselineskip
\end_layout
+\begin_layout Standard
+as TeX Code behind the preface definition but before the final
+\series bold
+]{
+\series default
+ command.
+
+\emph on
+number
+\emph default
+ is hereby the number of text lines.
+ In this example the space is set to 7
+\begin_inset space ~
\end_inset
-
+text lines:
\end_layout
-\begin_layout Standard
+\begin_layout Begin Multiple Columns
+2
+\begin_inset ERT
+status collapsed
-\size footnotesize
-Ronald Adair was fond of cards–playing continually, but never for such stakes
- as would hurt him.
- He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
- It was shown that, after dinner on the day of his death, he had played
- a rubber of whist at the latter club.
- He had also played there in the afternoon.
+\begin_layout Plain Layout
-\size default
-
-\size footnotesize
-The evidence of those who had played with him– Mr.
- Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
- and that there was a fairly equal fall of the cards.
- Adair might have lost five pounds, but not more.
- His fortune was a considerable one, and such a loss could not in any way
- affect him.
- He had played nearly every day at one club or other, but he was a cautious
- player, and usually rose a winner.
- It came out in evidence that, in partnership with Colonel Moran, he had
- actually won as much as four hundred and twenty pounds in a sitting, some
- weeks before, from Godfrey Milner and Lord Balmoral.
- So much for his recent history as it came out at the inquest.
+}[
\end_layout
-\begin_layout Standard
+\end_inset
+
+
\begin_inset ERT
-status open
+status collapsed
\begin_layout Plain Layout
\backslash
-end{multicols}
+subsubsection{
\end_layout
\end_inset
+This is the sectioning command
+\begin_inset Newline newline
+\end_inset
-\end_layout
+as a preface and
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-Please do read the file
-\family typewriter
-examples/multicol.lyx
-\family default
- for more advanced examples including column and header spacing, vertical
- separator lines, and more.
+with multiple text lines
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
\end_layout
-\begin_layout Section
-Numbering in the
-\family sans
-Enumerate
-\family default
- Paragraph Environment
-\begin_inset OptArg
+\end_inset
+
+
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-Numbering in Enumerate
+
+][7
+\backslash
+baselineskip
\end_layout
\end_inset
-\end_layout
+\begin_inset ERT
+status collapsed
-\begin_layout Standard
-by
-\noun on
-John Weiss
+\begin_layout Plain Layout
+
+]{
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-\noindent
-The default numbering for the
-\family sans
-Enumerate
-\family default
- paragraph environment begins with Arabic numbers and ends with uppercase
- letters.
- Suppose, however, you wanted a different type of numbering scheme.
- Here's a quickie example of how to change the numbering scheme:
+
+\size small
+On the evening of the crime, he returned from the club exactly at ten.
+ His mother and sister were out spending the evening with a relation.
+ The servant deposed that she heard him enter the front room on the second
+ floor, generally used as his sitting-room.
+ She had lit a fire there, and as it smoked she had opened the window.
+ No sound was heard from the room until eleven-twenty, the hour of the return
+ of Lady Maynooth and her daughter.
+ Desiring to say good-night, she attempted to enter her son's room.
+ The door was locked on the inside, and no answer could be got to their
+ cries and knocking.
+ Help was obtained, and the door forced.
+ The unfortunate young man was found lying near the table.
+ His head had been horribly mutilated by an expanding revolver bullet, but
+ no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout LyX-Code
+\begin_layout End Multiple Columns
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-Roman{enumi}.}
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumii}.}
+\begin_layout Subsubsection
+Surrounding Space
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+The amount of space before and after multiple columns can be changed by
+ changing the length
+\series bold
\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-arabic{enumiii}.}
+multicolsep
+\series default
+.
+ For example the command
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+
+\series bold
\backslash
-renewcommand{
-\backslash
-labelenumiv}{
+setlength{
\backslash
-alph{enumiv}.)}
-\end_layout
-
-\begin_layout Standard
-\SpecialChar \ldots{}
- which changes the numbering scheme to uppercase Roman numerals, uppercase
- letters, Arabic numbers, and lowercase letter.
+multicolsep}{3cm}
\end_layout
\begin_layout Standard
-Additionally, the previous example also adds a little bit extra to the numbering
- scheme.
- For example, the first level label actually looks like:
-\begin_inset Quotes eld
-\end_inset
-
-I.
-\begin_inset Quotes erd
-\end_inset
-
-.
- For ease of reading, we'll describe what the numbering schemes look like
- using a notation something like this: <
-\begin_inset Quotes eld
+in TeX Code changes its value to 3
+\begin_inset space \thinspace{}
\end_inset
-I.
-\begin_inset Quotes erd
+cm.
+ The change must be made before the multiple columns' start.
+ The predefined value is 13
+\begin_inset space \thinspace{}
\end_inset
-,
-\begin_inset space ~
-\end_inset
+pt.
+\end_layout
+\begin_layout Standard
+For this example
+\series bold
-\begin_inset Quotes erd
+\backslash
+multicolsep
+\series default
+ was set to 2.5
+\begin_inset space \thinspace{}
\end_inset
-A.
-\begin_inset Quotes erd
-\end_inset
+cm:
+\end_layout
-,
-\begin_inset space ~
-\end_inset
+\begin_layout Standard
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
-1.
-\begin_inset Quotes erd
-\end_inset
+\backslash
+setlength{
+\backslash
+multicolsep}{2.5cm}
+\end_layout
-,
-\begin_inset space ~
\end_inset
-\begin_inset Quotes eld
-\end_inset
-
-a.)
-\begin_inset Quotes erd
-\end_inset
+\end_layout
->.
-
+\begin_layout Begin Multiple Columns
+2
\end_layout
\begin_layout Standard
-As you can see in the example, there is a label command for each nesting
- level,
-\family typewriter
-
-\backslash
-labelenumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
-
-\backslash
-labelenumiv
-\family default
-, as well as a counter,
-\family typewriter
-enumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
-enumiv
-\family default
-.
- There are also five
-\begin_inset Quotes eld
-\end_inset
-
-number printing
-\begin_inset Quotes erd
-\end_inset
- commands,
-\family typewriter
-
-\backslash
-arabic{}
-\family default
-,
-\family typewriter
-
-\backslash
-roman{}
-\family default
-,
-\family typewriter
-
-\backslash
-Roman{}
-\family default
-,
-\family typewriter
+\size small
+All day I turned these facts over in my mind, endeavouring to hit upon some
+ theory which could reconcile them all, and to find that line of least resistanc
+e which my poor friend had declared to be the starting-point of every investigat
+ion.
+ I confess that I made little progress.
+ In the evening I strolled across the Park, and found myself about six o'clock
+ at the Oxford Street end of Park Lane.
+ A group of loafers upon the pavements, all staring up at a particular window,
+ directed me to the house which I had come to see.
+ A tall, thin man with coloured glasses, whom I strongly suspected of being
+ a plain-clothes detective, was pointing out some theory of his own, while
+ the others crowded round to listen to what he said.
+ I got as near him as I could, but his observations seemed to me to be absurd,
+ so I withdrew again in some disgust.
+ As I did so I struck against an elderly, deformed man, who had been behind
+ me, and I knocked down several books which he was carrying.
+\end_layout
-\backslash
-alph{}
-\family default
-, and
-\family typewriter
+\begin_layout End Multiple Columns
-\backslash
-Alph{}
-\family default
-, each of which take one counter as an argument.
- You can add characters before or after these, but there's no need to add
- spaces.
\end_layout
\begin_layout Standard
-You can get really fancy with these.
- For example:
-\end_layout
+\begin_inset Note Greyedout
+status open
-\begin_layout LyX-Code
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ The values you set with
+\series bold
\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-#
-\backslash
-Alph{enumi}
-\backslash
-#}
+setlength
+\series default
+ will be used for all following multiple columns until to change them again.
\end_layout
-\begin_layout LyX-Code
+\end_inset
+
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumi}.
-\backslash
-arabic{enumii}}
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-alph{enumiii}+}
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
\backslash
-renewcommand{
-\backslash
-labelenumiv}{(
+setlength{
\backslash
-roman{enumiv})}
+multicolsep}{13pt}
\end_layout
-\begin_layout Standard
-produces the somewhat out of hand numbering scheme: <
-\begin_inset Quotes eld
-\end_inset
-
-#A#
-\begin_inset Quotes erd
\end_inset
-,
-\begin_inset space ~
-\end_inset
+\begin_inset Note Note
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+go back to the default
+\end_layout
-A.1
-\begin_inset Quotes erd
\end_inset
-,
-\begin_inset space ~
-\end_inset
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Standard
+\begin_inset Newpage newpage
\end_inset
-a+
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset space ~
-\end_inset
+\end_layout
+\begin_layout Subsubsection
+Column Separation
+\end_layout
-\begin_inset Quotes eld
+\begin_layout Standard
+The width of the columns is automatically calculated, but you can modify
+ the space between the columns.
+ This is done by changing the length
+\series bold
+
+\backslash
+columnsep
+\series default
+.
+ Its predefined value is 10
+\begin_inset space \thinspace{}
\end_inset
-(i)
-\begin_inset Quotes erd
+pt.
+ Here is an example where
+\series bold
+
+\backslash
+columnsep
+\series default
+ is set to 3
+\begin_inset space \thinspace{}
\end_inset
->.
-
+cm:
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+\backslash
+setlength{
+\backslash
+columnsep}{3cm}
\end_layout
-\begin_layout Section
-Dropped Capitals
+\end_inset
+
+
\end_layout
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+\begin_layout Begin Multiple Columns
+2
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+
+\size small
+My observations of No.
+\begin_inset space \space{}
\end_inset
+427 Park Lane did little to clear up the problem in which I was interested.
+ The house was separated from the street by a low wall and railing, the
+ whole not more than five feet high.
+ It was perfectly easy, therefore, for anyone to get into the garden, but
+ the window was entirely inaccessible, since there was no water pipe or
+ anything which could help the most active man to climb it.
+ More puzzled than ever, I retraced my steps to Kensington.
+ I had not been in my study five minutes when the maid entered to say that
+ a person desired to see me.
+ To my astonishment it was none other than my strange old book collector,
+ his sharp, wizened face peering out from a frame of white hair, and his
+ precious volumes, a dozen of them at least, wedged under his right arm.
+\end_layout
+
+\begin_layout End Multiple Columns
\end_layout
\begin_layout Standard
-\noindent
\begin_inset ERT
status collapsed
\backslash
-newfont{
-\backslash
-tmpfont}{cmr17 scaled 2500}{
-\backslash
-tmpfont T}
+setlength{
\backslash
-vspace*{-8.4ex}
+columnsep}{10pt}
\end_layout
\end_inset
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
\end_layout
-\begin_layout Standard
-\noindent
-\begin_inset ERT
-status open
+\end_inset
-\begin_layout Plain Layout
+\end_layout
-\backslash
-hangindent=3.3em
-\backslash
-hangafter=-3
+\begin_layout Subsubsection
+Vertical Lines
\end_layout
-\end_inset
+\begin_layout Standard
+Between the columns a rule with a width of the length
+\series bold
- hose of you who like the style of old books probably also like
-\begin_inset Quotes eld
+\backslash
+columnseprule
+\series default
+ is placed.
+ If this rule width is set to 0
+\begin_inset space \thinspace{}
\end_inset
-dropped capitals
-\begin_inset Quotes erd
+pt (this is the default), the rule is suppressed.
+ In the following example the line is 2
+\begin_inset space \thinspace{}
\end_inset
-—those large capital letters which begin each new chapter or section.
- Implementing them with plain LyX/LaTeX is straightforward (assuming you
- know some plain TeX!) but does require a lot of work and many iterations,
- as you can see by all the ugly TeX-mode stuff at the beginning of this
- paragraph.
+pt wide:
\end_layout
\begin_layout Standard
\backslash
-verb+
+setlength{
\backslash
-bigdrop{-1em}{3}{ptmri}{T}+
+columnseprule}{2pt}
\end_layout
\end_inset
-here is a much easier way of doing this, of course.
- The
-\family typewriter
-dropcaps
-\family default
- (or the newer
-\family typewriter
-dropping
-\family default
-) package from CTAN allows a simple way to add such letters to your documents.
- Since this package is not a standard part of teTeX, I can't demonstrate
- it within this document, but if you copy this paragraph to a new document,
- delete the
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-\family typewriter
+\begin_layout Begin Multiple Columns
+2
+\end_layout
-\backslash
-verb
-\family default
+\begin_layout Standard
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+You're surprised to see me, sir,
\begin_inset Quotes erd
\end_inset
- and the pluses from the TeX code at the beginning of the paragraph, and
- add
-\family typewriter
+ said he, in a strange, croaking voice.
+\end_layout
-\backslash
-usepackage{dropcaps}
-\family default
- to your LaTeX preamble, you will get a nice Times Roman Italic
+\begin_layout Standard
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Standard
+
+\size small
\begin_inset Quotes eld
\end_inset
-T
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
\begin_inset Quotes erd
\end_inset
-, whose height is three lines of text and which protrudes 1 em into the
- margin.
- (Make certain you have copied
+
+\end_layout
+
+\begin_layout Standard
+
+\size small
\begin_inset Quotes eld
\end_inset
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-dropcaps.sty
-\family default
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+May I ask how you knew who I was?
\begin_inset Quotes erd
\end_inset
- into a directory where TeX can see it.) The first argument is the amount
- of indentation; in this case the negative sign moves it into the margin.
- The second argument is the height of the letter in number of lines of text.
- The third argument is the font name: virtually anything which has a tfm
- file should work (wade through the
-\family typewriter
-.../texmf/fonts/tfm
-\family default
- directory for possibilities).
- My personal favorite is
+
+\end_layout
+
+\begin_layout Standard
+
+\size small
\begin_inset Quotes eld
\end_inset
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
-\family typewriter
-yinit
-\family default
-
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+--a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
\begin_inset Quotes erd
\end_inset
-, a fancy German font specifically designed for dropped capitals.
- The fourth argument is the letter (or letters) to be dropped.
- The
-\family typewriter
-dropping
-\family default
- package also offers the
-\family typewriter
-\backslash
-bigdrop
-\family default
- command, as well as a slightly simplified
-\family typewriter
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
\backslash
-dropping
-\family default
- command.
+setlength{
+\backslash
+columnseprule}{0pt}
\end_layout
-\begin_layout Section
-Non-standard Paragraph Shapes
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
\end_layout
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+\end_inset
+
+
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+\begin_inset Newpage newpage
\end_inset
\end_layout
+\begin_layout Section
+Non-standard Paragraph Shapes
+\end_layout
+
\begin_layout Standard
\begin_inset ERT
status collapsed
\family default
is called for.
As you can see, completely arbitrary shapes can be laid out with a suitable
- set of linelength definitions.
+ set of line length definitions.
While this parshape may look a bit silly and useless, one could conceive
of situations such as finely tuned dropped capitals, word wrapping around
non-rectangular graphics, etc.
\end_layout
-\begin_layout Section
-Summary
+\begin_layout Bibliography
+\begin_inset CommandInset bibitem
+LatexCommand bibitem
+key "multicol"
+
+\end_inset
+
+Documentation of the LaTeX-package
+\begin_inset CommandInset href
+LatexCommand href
+name "multicol"
+target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
+
+\end_inset
+
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! multicol
\end_layout
-\begin_layout Standard
-As you can see, the examples in this section range from the useful to the
- whimsical.
- While I don't expect that anyone will ever need the paragraph shape demonstrate
-d in the last section, the important point is that you can do almost anything
- you want in LyX if you are willing to figure out how to do it in TeX and
- LaTeX.
- TeX is a fantastically powerful typesetting system and all that power is
- available to you since LyX uses it as its backend.
- Happy LyXing!
+\end_inset
+
+
\end_layout
\end_body
projects / lyx.git / blobdiff