-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 381
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 474
\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
+shapepar
\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_math auto
\font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_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"
-\papersize default
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
+\papersize a4paper
\use_geometry false
-\use_amsmath 0
-\use_esint 0
-\use_mhchem 1
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 0
+\use_package esint 0
+\use_package mathdots 1
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package stackrel 0
+\use_package stmaryrd 0
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type default
+\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\justification true
+\use_refstyle 0
+\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes false
+\tracking_changes true
\output_changes false
\html_math_output 0
+\html_css_as_file 0
\html_be_strict true
+\author 711066561 "Enrico Forestieri"
\end_header
\begin_body
Additional LyX Features
\end_layout
+\begin_layout Subtitle
+Version 2.1.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
User's Guide\SpecialChar \@.
\emph default
- The reason for separating this document out is simple: the
+ The reason for separating the two documents is simple: the
\emph on
User's Guide
\emph default
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
View\SpecialChar \menuseparator
Source
+\begin_inset space ~
+\end_inset
+
+Pane
\end_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
+Document\SpecialChar \menuseparator
+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
+Document\SpecialChar \menuseparator
+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
TeX Code
\end_layout
+\end_inset
+
+ or the keyboard shortcut
+\begin_inset Info
+type "shortcut"
+arg "ert-insert"
\end_inset
.
\begin_inset Newline newline
\end_inset
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You
\begin_inset Newline newline
\end_inset
\begin_layout Standard
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
box containing this text is directly after this paragraph.
Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\begin_inset ERT
-status collapsed
+status open
\begin_layout Plain Layout
\begin_layout Plain Layout
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\end_layout
\end_inset
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
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_layout
\begin_layout Itemize
-Beware reinventing the wheel.
+Beware of reinventing the wheel.
\end_layout
\begin_layout Standard
\end_inset
- for details, and see chapter
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
+ for details.
\end_layout
\begin_layout Standard
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
+ In addition to providing special commands, the inclusion of a package can
+ change the document.
For example, the package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Newline newline
\end_inset
-There are several LaTeX counters and variables which
+There are several LaTeX counters and variables that
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- (There are variables which you can set and reset inside the document, too.)
- Margins are a good example of something which must be set in the preamble.
+ (There are variables that you can set and reset inside the document, too.)
+ Margins are a good example of something that must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\begin_layout 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
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
It then uses the logfile from the LaTeX run to do a post-mortem.
- After analyzing the logfile,LyX displays a dialog listing the errors.
+ After analyzing the logfile, LyX displays a dialog listing the errors.
Clicking on any one of them will take you to the position in your LyX file
where the error occurred.
\begin_inset Foot
\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
- LaTeX Error: File
+LaTeX Error: File
\begin_inset Quotes els
\end_inset
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
+, then the established
+\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
.
You are free to use the same or different styles for each section.
- Additionally, you can chose if the bibliography section should contain
+ Additionally, you can choose if the bibliography section should contain
\begin_inset Quotes eld
\end_inset
.
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
\end_inset
- removes the bibliography title, you have manually re-add that, too (as
+ removes the bibliography title, you have to manually re-add that, too (as
a chapter* or section*, for instance).
\end_layout
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
\end_inset
(those commands have to be inserted as TeX code).
- The bibliography will contain all references which have been cited in the
+ The bibliography will contain all references that have been cited in the
current
-\begin_inset Flex 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
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\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
is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
+ that files that are
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- are typeset beginning on a new page, while files which are
+ are typeset beginning on a new page, while files that are
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
+g, while the included files are converted to LaTeX files that do not have
all the preamble information.
\end_layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
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"
First, open all the files in question: let's call them A and B in a two
file example, where B is included in A.
Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
+ Open the cross-reference dialog whilst in document B, and you can select
the
\begin_inset Quotes eld
\end_inset
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
\end_layout
\begin_layout Standard
-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].
+As the bibliography list is in a comment, LaTeX won't 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
\end_inset
package documentation.
- This can be found in the file
-\begin_inset Flex CharStyle:Code
+ (
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-fancyhdr.dvi
-\end_layout
-
-\end_inset
-, which should have been installed with your LaTeX distribution, or
-\begin_inset CommandInset href
-LatexCommand href
-name "online"
-target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
+http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
+\end_layout
\end_inset
-.
+)
\end_layout
\begin_layout Standard
.
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
You will now see your name in the upper left.
If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer, simply include a command
+ the page number appears in the central footer) simply include a command
with a blank argument, e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Standard
The 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 Standard
The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+ The following table shows the mappings from button name to LaTeX package.
\end_layout
\begin_layout Standard
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
-<features tabularvalignment="middle">
+<features rotate="0" tabularvalignment="middle">
<column alignment="center" valignment="top" width="0pt">
<column alignment="center" valignment="top" width="0pt">
<row>
\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
+That said,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-htlatex
+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
\begin_inset CommandInset href
LatexCommand href
name "accessed online"
-target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
+target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
\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
- from the
-\begin_inset Flex CharStyle:Code
+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
+
+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
+
+\begin_layout Plain Layout
+LyX has borrowed some of the CSS for its HTML output from
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+elyxer
\end_layout
-\begin_layout Section
-Bibliography and Citations
-\end_layout
+\end_inset
-\begin_layout Standard
-XHTML output fully supports bibliographies and citations.
-
+.
\end_layout
-\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.
+\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
+
+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 Plain Layout
+xymatrix
+\end_layout
+
+\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.
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
-
- of the
+ See the
\emph on
Customization
\emph default
\end_layout
\begin_layout Standard
-The other significant defect is that cross-referenced information is printed
+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 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 (
+\change_deleted 711066561 1405258697
+but
+\change_inserted 711066561 1405258701
+where
+\change_unchanged
+ any working path
+\change_inserted 711066561 1405258613
+instead of lyxpipe
+\change_unchanged
+can be used
+\change_inserted 711066561 1405258962
+, for example
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405258868
+"
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+my
+\backslash
+lyx
+\backslash
+pipe"
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ would also work
+\change_unchanged
+).
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
\end_layout
\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
-\begin_inset Flex CharStyle:Code
+You can find a complete example client written in C
+\change_inserted 711066561 1405258366
+++
+\change_unchanged
+ in the source distribution as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
development/lyxserver/server_monitor.c
+\change_inserted 711066561 1405258386
+pp
+\change_unchanged
+
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-Another useful tool is command-line based client you will find in
-\begin_inset Flex CharStyle:Code
+Another useful tool is the command-line based client
+\change_inserted 711066561 1405258403
+
+\change_unchanged
+found in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
echo $a
\end_layout
+\begin_layout Subsection
+AppleScript (Mac OS X)
+\end_layout
+
+\begin_layout Standard
+Since LyX 2.1, LyX supports basic interactions with AppleScript for normal
+ communication through the command run.
+ This command takes a direct argument (the
+\series bold
+function
+\series default
+ to perform) and an optional argument.
+ It either returns the output of the function or triggers an error with
+ the error message and code.
+\end_layout
+
+\begin_layout Standard
+Example:
+\end_layout
+
+\begin_layout LyX-Code
+tell application "LyX"
+\end_layout
+
+\begin_layout LyX-Code
+ try
+\end_layout
+
+\begin_layout LyX-Code
+ -- Stores the current file name into f
+\end_layout
+
+\begin_layout LyX-Code
+ set f to (run "server-get-filename" with argument "")
+\end_layout
+
+\begin_layout LyX-Code
+ on error the error_message number the error_number
+\end_layout
+
+\begin_layout LyX-Code
+ display dialog "Error: " & the error_number & ".
+ " ¬
+\end_layout
+
+\begin_layout LyX-Code
+ & the error_message buttons {"OK"} default button 1
+\end_layout
+
+\begin_layout LyX-Code
+ end try
+\end_layout
+
+\begin_layout LyX-Code
+end tell
+\end_layout
+
\begin_layout Section
Notification
\end_layout
\end_layout
\begin_layout Quote
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Skim on Mac OSX and SumatraPDF on Windows.
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux
+\change_inserted 711066561 1405273809
+, Qpdfview on Unix
+\change_unchanged
+, Skim on Mac OSX and SumatraPDF on Windows.
\end_layout
\end_inset
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
-Enabling reverse search
+Automatic setup
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:rev-search"
+
+\end_inset
+
+
\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.
-\end_layout
+ in the menu
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
\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
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+.
+ 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
+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
+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
+
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=-1
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Please a
+\change_deleted 711066561 1405259326
+ö
+\change_inserted 711066561 1405259326
+l
+\change_unchanged
+so note that including the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+srcltx
+\end_layout
+
+\end_inset
+
+ package or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src-specials
+\end_layout
+
+\end_inset
+
+ 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
+srcltx
+\end_layout
+
+\end_inset
+
+ package or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src-specials
+\end_layout
+
+\end_inset
+
+.
+
+\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_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_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
\emph default
approach.
You need at least TeXLive 2008 or a recent MikTeX distribution in order
- to use it.
- Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
- already provide SyncTeX support.
+ to use it
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For some reason, MikTeX does not understand/obey the command LyX inserts
+ into the preamble when you check the "Enable Forward/Reverse Search" button
+ in the toolbar and does not generate the necessary info.
+\end_layout
+
+\begin_layout Plain Layout
+The generation of the required info can be forced by changing the converter
+ "LaTeX (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
+ from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
+ the -synctex=1 switch).
+\end_layout
+
+\end_inset
+
+.
+ Also note that only a few PDF viewers (
+\change_inserted 711066561 1405273879
+Okular and Qpdfview on Unix,
+\change_unchanged
+Skim on the Mac, SumatraPDF on Windows) already provide SyncTeX support.
\end_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
-DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
+DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-xdvi -editor 'lyxeditor.sh %f %l'
+xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
, where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Newline newline
\end_inset
-read < "${LYXPIPE}".out || exit
+read TMP < "${LYXPIPE}".out || exit
\end_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
\end_inset
- select Ly
-\begin_inset ERT
+ choose
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
+custom
+\end_layout
-{}
+\end_inset
+
+ preset and enter command
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+/Applications/LyX.app/Contents/MacOS/lyxeditor
\end_layout
\end_inset
-X.
+.
\end_layout
\begin_layout Standard
\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
Reverse search is triggered by SHIFT-click.
+\change_inserted 711066561 1405259853
+
+\end_layout
+
+\begin_layout Subsubsection*
+
+\change_inserted 711066561 1405273730
+Qpdfview (Unix)
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 711066561 1405263147
+Qpdfview supports SyncTeX since version 0.3.5.
+ Go to
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405260331
+Edit\SpecialChar \menuseparator
+Settings\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Behavior
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, click on the input field of the
+\begin_inset Quotes eld
+\end_inset
+
+Source editor
+\begin_inset Quotes erd
+\end_inset
+
+ item and add the command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405260473
+lyxclient -g %1 %2
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 711066561 1405260506
+Reverse search is triggered by double-click.
+\change_unchanged
+
\end_layout
\begin_layout Subsubsection*
\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
Reverse search is triggered by double-click.
\end_layout
-\begin_layout Chapter
-Special Document Classes
-\end_layout
-
\begin_layout Section
-A&A Paper
+Forward search
\end_layout
\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Introduction
-\end_layout
+opposite
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (www.edpsciences.fr/aa/
-\begin_inset Flex URL
+ of reverse search.
+ It allows you to let the viewer jump to a given position from within LyX.
+ If forward search is set up (as described in what follows), you can put
+ the cursor anywhere in your LyX document, and hit
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-http://www.edpsciences.fr/aa/
+Navigate\SpecialChar \menuseparator
+Forward search
\end_layout
\end_inset
-) using Version 5.01 of the document class
-\family typewriter
-aa.cls
+ (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
+
+\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
+reference "sub:rev-search"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Additionally, you need to configure LyX for using your viewers in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+General
+\end_layout
+
+\end_inset
+
+.
+ 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 (without path)
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$f
+\end_layout
+
+\end_inset
+
+: name of the (temporary) exported .tex file (including path)
+\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
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You might want to set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+okular --unique
+\end_layout
+
+\end_inset
+
+ in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File
+\begin_inset space ~
+\end_inset
+
+Formats
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted 711066561 1405264317
+, qpdfview
+\change_unchanged
+ and Sumatra
+\change_deleted 711066561 1405264282
+
+\change_unchanged
+PDF
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_deleted 711066561 1405264216
+For
+\change_unchanged
+Sumatra
+\change_inserted 711066561 1405264265
+PDF can also use DDE commands through the external program
+\change_unchanged
+ CMCDDE
+\change_deleted 711066561 1405264271
+ is needed
+\change_unchanged
+ --- downloadable from
+\begin_inset CommandInset href
+LatexCommand href
+target "ftp://ftp2.commence.com/pub/freebies/"
+
+\end_inset
+
+
+\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
+
+.
+ This 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
+Special Document Classes
+\end_layout
+
+\begin_layout Section
+A&A Paper
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Peter Sütterlin
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.edpsciences.fr/aa/
+\end_layout
+
+\end_inset
+
+) using Version 5.01 of the document class
+\family typewriter
+aa.cls
\family default
.
This package can be downloaded from the ftp site
\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:
.
\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
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
\end_inset
- module, which is loaded by default when when you select one of the AMS
- classes.
+ module, which is loaded by default when you select one of the AMS 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
\emph on
only
\emph default
- unnumbered results, the the module
-\begin_inset Flex CharStyle:Code
+ unnumbered results, the module
+\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.
-\end_layout
+.
+ It contains all infos you need.
+\end_layout
\begin_layout Section
Foils [aka
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
Comment
\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 Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
Definition*
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\emph on
\begin_inset space \space{}
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
\family sans
\end_layout
\begin_deeper
-\begin_layout Standard
+\begin_layout Plain Layout
\begin_inset space ~
\end_inset
\end_layout
\end_deeper
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
\end_inset
\family default
environments.
Again the only difference is the spacing between foilhead and body.
- Both of the short versions have 0.5 inches less separation between the foilhead
- and the body.
+ Both of the short versions have 0.5
+\begin_inset space ~
+\end_inset
+
+inches less separation between the foilhead and the body.
\end_layout
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
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
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_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\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
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
+, lots will probably never be supported, due to the limitations of LyX's
+ framework.
Of course you can still use all features with the help of some native LaTeX
commands (TeX code
\begin_inset Foot
\end_inset
).
- In this section, we can only list those features which are natively supported
+ In this section, we can only list those features that are natively supported
by LyX.
- For detailed descriptions (and for the rest of features) we 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
\begin_inset Quotes erd
\end_inset
-, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-without pagina).
+).
If you want an empty title page, type
\family typewriter
\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
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
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:
\family typewriter
chktex
\family default
- it from CTAN,
-\begin_inset CommandInset href
-LatexCommand href
+ from CTAN,
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset CommandInset href
+LatexCommand href
target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
\end_inset
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
\begin_inset Newline newline
\end_inset
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
+If you have bad luck, the text will break right between the referenced text
+ and reference number, and that's a pity.
See section
\begin_inset CommandInset ref
LatexCommand ref
\family sans
ChkTeX
\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
+, and this gap can make some warnings seem arcane or just plain silly.
\end_layout
\begin_layout Standard
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
\emph on
is
\emph default
- very configurable and extensible, you shouldn't expect to solve all problems
+ very configurable and extensible, you should not expect to solve all problems
with
\family sans
ChkTeX
\family default
by using
\family sans
-Edit\SpecialChar \menuseparator
-View
-\begin_inset space ~
-\end_inset
-
+Document\SpecialChar \menuseparator
LaTeX
\begin_inset space ~
\end_inset
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
+ to the internal document structure, some of the warnings will not appear
+ correctly.
There are two things you can do about this:
\end_layout
ChkTeX
\family default
invocation command line in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Outputs
-\family default
-,
-\family sans
-Misc
-\family default
-), or the global
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+LaTeX\SpecialChar \menuseparator
+CheckTeX command
+\end_layout
+
+\end_inset
+
+, or the global
\family sans
ChkTeX
\family default
).
See below to learn what warnings can be enabled and disabled on the command
line.
-
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- 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
+LyX supports some of the most basic RCS/CVS/SVN/GIT 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 advise
+ using SVN instead.
+ A good place to start learning 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 the 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
+Before you begin to use the version control features in LyX, you should
+ be familiar with RCS/CVS/SVN/GIT 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 the Messages pane if unsure.
+ Regular users of version control will appreciate VC toolbar, which can
+ be enabled via
+\family sans
+View\SpecialChar \menuseparator
+Toolbars\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
- package—no guarantees are made for older versions.
+Control
+\family default
+.
\end_layout
\begin_layout Standard
Control
\family default
submenu.
- LyX was tested against RCS 5.7.
+ LyX was tested against RCS 5.7/5.8
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Note that old DOS / MS Windows builds (5.7) need to setup environment variables
+ in order to work properly with LyX.
+ In particular time zone (TZ) should be set and more importantly RCSINIT
+ in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
+ expects archive to be found in file.lyx,v within the original document directory.
+ See also README shipped with Windows RCS binaries.
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Subsubsection
This is stored in the history log.
The version number is bumped, your changes are applied to the master RCS
file, the document is unlocked and set to Read-Only mode.
-
\end_layout
\begin_layout Standard
You will usually continue editing for a while and when you are finished
you check in your changes.
The status line is changed to reflect that you have locked the file.
-
\end_layout
\begin_layout Standard
\begin_layout Subsubsection
+\family sans
+Copy
+\end_layout
+
+\begin_layout Standard
+This will create a copy of the current document.
+ Since RCS does not support copy operations natively, the version history
+ is not preserved, and the copy is added as a new file.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the copy is loaded instead of the original document.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+RCS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Copy
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ci -q -u
+\family typewriter
+-i
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
\family sans
Undo Last Checkin
\end_layout
This makes as if the last check in never happened.
No changes are made to the document loaded into LyX, but the last version
is removed from the master RCS file.
-
\end_layout
\begin_layout Standard
\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
+.
+ 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 don'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_inset
+
+ file and add the line
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -r
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Check In Changes
+ 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
-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.
+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 Plain Layout
+Check Out
\end_layout
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs -q commit -m"<description>" "<file-name>"
+\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
-Revert To Repository Version
+ operation is possible and that makes your working copy readonly again after
+ transferring your changes to the repository.
\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.
+More information about CVS can be found here
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.nongnu.org/cvs
\end_layout
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs update
-\begin_inset Quotes eld
\end_inset
-<file-name>
-\begin_inset Quotes erd
-\end_inset
-
-
-\end_layout
+ and here
+\begin_inset Flex URL
+status collapsed
-\begin_layout Subsubsection
+\begin_layout Plain Layout
-\family sans
-Show History
+http://ximbiot.com/cvs
\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
-
-\family default
- is shown in a browser.
-\end_layout
-
-\begin_layout Subsection
-SVN commands in LyX
+.
\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
+Read
+\family typewriter
+man cvs
\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 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
-
-.
-\end_layout
-
-\end_inset
-
-
+ 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 the 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
-
-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
-
+\family sans
+Revert To Repository Version
\end_layout
-\end_inset
-
-
+\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
-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
-status collapsed
-
-\begin_layout Plain Layout
-.tex
+CVS command:
+\family typewriter
+cvs -q update "<file-name>"
\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.
-
+\begin_layout Standard
+If a reserved checkout is detected and the working copy has no changes only
+ the reservation is undone.
\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.
-
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q unedit "<file-name>"
\end_layout
-\begin_layout Standard
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Subsubsection
-\begin_layout Plain Layout
-Update local directory from repository
+\family sans
+Copy
\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.
+\begin_layout Standard
+This will create a copy of the current document.
+ Since CVS does not support copy operations natively, the version history
+ is not preserved, and the copy is added as a new file.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the copy is loaded instead of the original document.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-SVN
+CVS
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
-
-\begin_inset Flex CharStyle:Code
+Copy
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn diff $path
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
\end_inset
- (Ask if changes are detected.)
-\begin_inset Newline newline
+<file-name>
+\begin_inset Quotes erd
\end_inset
-\begin_inset Flex CharStyle: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 CharStyle:Code
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$path
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
\end_inset
- stands for the path to the document.
-\end_layout
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsubsection
-\family sans
-Show History
\end_layout
-\begin_layout Standard
-This show the complete history of the SVN document.
- The output of
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q add
\family typewriter
-svn log
+
\begin_inset Quotes eld
\end_inset
-<file-name>
+<new-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 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.
+\begin_layout Subsubsection
+
+\family sans
+Rename
\end_layout
\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.
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Automatical-Locking-Property"
+This will rename the current document.
+ Since CVS does not support rename operations natively, the version history
+ is not preserved, the renamed document is added as a new file, and the
+ original document is deleted.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
-) based on
-\begin_inset Flex CharStyle:Code
-status collapsed
+commands:
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-svn:needs-lock
-\end_layout
+\begin_inset Newline newline
\end_inset
- file svn property
-\begin_inset Foot
-status open
+Rename
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
\end_inset
-.
- 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:
-\end_layout
-\begin_layout Itemize
-Unlocked state.
- The loaded file is in the read-only mode.
- For editation on needs to check-out.
-
-\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.
-
-\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
+\end_inset
+
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Don't be puzzled by the fact that you will be asked for commit message anyway.
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
\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
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+cvs -q add
\family typewriter
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Automatical-Locking-Property"
+\begin_inset Quotes eld
\end_inset
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
-\family default
-Automatical Locking Property
-\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
-\bar default
-ile\SpecialChar \menuseparator
+\end_layout
-\bar under
-V
-\bar default
-ersion
-\begin_inset space ~
\end_inset
-Control\SpecialChar \menuseparator
-
-\bar under
-T
-\bar default
-oggle locking property
-\family default
-.
- This command is active only when the file is not locked on the svn server
- (i.e.
- you need to check-out before proceeding).
-\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-SVN
-\begin_inset space ~
+\begin_inset Newline newline
\end_inset
-commands:
-\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Set:
-\family typewriter
- svn propset svn:needs-lock ON "<file-name>"
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Unset:
+\begin_layout Plain Layout
+cvs -q remove
\family typewriter
-svn propdel svn:needs-lock "<file-name>"
-\end_layout
-\begin_layout Subsubsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:VCS-Revision-Information"
+\begin_inset Quotes eld
+\end_inset
+<file-name>
+\begin_inset Quotes erd
\end_inset
-Revision Information in Documents
-\end_layout
-\begin_layout Standard
-There are more possibilities how to activate revision information in our
- document.
\end_layout
-\begin_layout Itemize
-LyX supports directly:
-\end_layout
+\end_inset
-\begin_deeper
-\begin_layout Itemize
-tree revision information (
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-vcs-tree-revision
\end_layout
-\end_inset
+\begin_layout Subsubsection
+Update of the local directory checkout from repository
+\end_layout
-).
- The result is the output of the
-\begin_inset Flex CharStyle:Code
+\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
-svnversion
+.tex
\end_layout
\end_inset
- command, the following table gives you an idea, how to read the results.
+ 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
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="6" columns="2">
-<features tabularvalignment="middle">
-<column alignment="center" valignment="top" width="0">
-<column alignment="center" valignment="top" width="0">
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
+The
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Output
+Update local directory from repository
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+ 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
-Meaning
+<<<<<<<
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+ and
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-4123:4168
+>>>>>>>
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+ separated by
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-mixed revision working copy
+=======
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+.
+ 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
-4168M
+>
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-modified working copy
+ signs.
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-4123S
-\end_layout
+commands:
+\begin_inset space ~
+\end_inset
+
+\begin_inset Newline newline
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+
+
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-switched working copy
+cd $path; cvs diff
+\family typewriter
+"."
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+ (Ask if changes are detected.)
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-4123P
+cd $path; cvs -q update
+\family typewriter
+"."
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-partial working copy, from a sparse checkout
+
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+where
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-4123:4168MS
+$path
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Plain Layout
-mixed revision, modified, switched working copy
+ stands for the path to the document.
\end_layout
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+\begin_layout Subsubsection
-\end_inset
+\family sans
+Show History
+\end_layout
+\begin_layout Standard
+This shows the complete history of the CVS document.
+ The output of
+\family typewriter
+cvs log "<file-name>"
+\family default
+ is shown in a browser.
+\end_layout
+\begin_layout Subsubsection
+Revision info
\end_layout
-\begin_layout Itemize
-file revision information.
- The result comes from parsing the output of
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+LyX supports CVS version number, author name, date and time of last commit.
+ All those are extracted from
+\family typewriter
+cvs log -r <file-name>
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
-\begin_layout Plain Layout
-svn
-\begin_inset space ~
\end_inset
-info
-\begin_inset space ~
-\end_inset
+ for details.
+\end_layout
---xml
+\begin_layout Subsection
+SVN commands in LyX
+\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
-file.lyx
-\end_layout
+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, 1.6, 1.7 and 1.8
+\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 "sub:SVN-Repo-Update"
\end_inset
.
- Supported flags are:
+ There seems to be currently unresolved permissions problem under SVN 1.8
+ with reverting changes when file is locked.
\end_layout
-\begin_deeper
-\begin_layout Itemize
-version number of the last commit (
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_inset
+
-\begin_layout Plain Layout
-vcs-revision
\end_layout
-\end_inset
+\begin_layout Subsubsection
-)
+\family sans
+Register
\end_layout
-\begin_layout Itemize
-author of the last commit (
-\begin_inset Flex CharStyle:Code
-status collapsed
+\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 Plain Layout
-vcs-author
+\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.
+\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.
\end_layout
+\begin_layout Standard
+SVN command that is run:
+\family typewriter
+svn add -q
+\begin_inset Quotes eld
\end_inset
-)
-\end_layout
+<file-name>
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-date of the last commit (
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-vcs-date
\end_layout
-\end_inset
-
-)
+\begin_layout Standard
+Read
+\family typewriter
+man svn
+\family default
+ to understand the switches.
\end_layout
-\begin_layout Itemize
-time of the last commit (
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Subsubsection
-\begin_layout Plain Layout
-vcs-time
+\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
-\end_deeper
\begin_layout Standard
-You can obtain this info via InsetInfo (e.g.
-
-\begin_inset Flex CharStyle:Code
+SVN command:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-info-insert buffer vcs-date
-\end_layout
+In case locking is not enabled.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:SVN-File-Locking"
\end_inset
-).
- The information will be available only when you have the file stored under
- svn managment (i.e.
- the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-.svn
+.
\end_layout
\end_inset
- directory is available with your document).
+
+\family typewriter
+svn commit -q -m"<description>" <file-name>
\end_layout
-\end_deeper
-\begin_layout Itemize
-Another---a hacking one---possibility is to use svn keywords
-\begin_inset Foot
-status collapsed
+\begin_layout Subsubsection
-\begin_layout Plain Layout
-http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
+\family sans
+Check Out For Edit
\end_layout
-\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
-.
- In short -- you set file keywords property (e.g.
-
-\family sans
-svn propset svn:keywords 'Rev' file.lyx
-\family default
-) and then paste keyword ERT
+\begin_layout Standard
+SVN command:
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-This is an easy way how to ensure that LyX won't break the line in the middle
- of keyword tag.
+Ditto.
\end_layout
\end_inset
- tag in your document (e.g.
-\begin_inset ERT
-status open
+\family typewriter
+svn update --non-interactive
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+<file-name>
+\begin_inset Quotes erd
+\end_inset
-$Rev$
+
+\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
+
+\family sans
+Copy
+\end_layout
+
+\begin_layout Standard
+This will create a copy of the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the copy operation.
+ After that the copy is created, both locally and in the repository.
+ If the parent directories of the copied and original document differ, all
+ relative paths of included files of the copy are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
).
- This way svn client will automatically substitute revision number (e.g.
-
-\begin_inset ERT
-status open
+ Finally, the copy is loaded instead of the original document.
+\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 copy -q
+\family typewriter
-$Rev: 59 $
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+<file-name>
+\begin_inset Quotes erd
\end_inset
-) after each update and commit.
- There are more problems with this approach.
- Firstly, the '$' character is used in TeX world for math equations, so
- any occurence of math formula
-\begin_inset Formula $Rev$
+
+\begin_inset Quotes eld
\end_inset
- become
-\begin_inset Formula $Rev:59$
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
- in your LyX document.
- Similarly for other keywords like Id, Date, Author, etc.
- Secondly svn output is dependent on your locales, so its very easy that
- svn would produce some problematic strings once Date is used.
- Thirdly you get the whole 'Rev: 59' string in your document instead of
- the plain number.
- Until subversion implements user's custom keywords it will be hard to use
- this approach reliably or let LyX to support it directly.
+
\end_layout
-\begin_layout Subsection
-SVN and Windows Environment
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn commit
\end_layout
-\begin_layout Quote
-My inclination is to say that if the user cannot figure out the command
- line operations on their own fairly quickly, they would be well advised
- to use TortoiseSVN.
- ---P.
- A.
- Rubin
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
-Preparation
+
+\family sans
+Rename
\end_layout
\begin_layout Standard
-In addition to installing LyX, and having access to a Subversion repository,
- the user will need to install the Subversion client program.
- A Windows installer for the client program is available from
-\begin_inset CommandInset href
-LatexCommand href
-name "CollabNet"
-target "http://www.collab.net/nonav/downloads/subversion/"
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
\end_inset
-.
- The user may also want to install
-\begin_inset CommandInset href
-LatexCommand href
-name "TortoiseSVN"
-target "http://tortoisesvn.tigris.org/"
+commands:
+\begin_inset space ~
+\end_inset
+
+\begin_inset Newline newline
\end_inset
-, which integrates Subversion operations into the context (rightclick) menu
- of Windows Explorer.
- Operations done outside LyX will typically be more convenient using the
- Explorer context menu.
- Note that TortoiseSVN is not a replacement for the client program, which
- is what LyX itself will use.
-\end_layout
-\begin_layout Subsubsection
-Bringing a document under Subversion control
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Before a LyX document can be brought under version control in Subversion,
- its parent directory needs to be under version control.
- If the document is being added to a project already in the repository,
- this is accomplished by checking the project out to the directory where
- the new document will be placed.
- If the project itself is not yet under version control (for instance, if
- this document starts a new project), the directory must be imported into
- the repository.
- This is done outside LyX.
- Both import and checkout are easily accomplished from the Explorer context
- menu using TortoiseSVN, or alternatively can be done using the command
- line client at a DOS prompt.
- The procedure for importing the project using TortoiseSVN is described
- below, assuming an existing repository and a new project being started
- in
-\family typewriter
-C:
-\backslash
-new project
-\family default
-.
- For information on using the Subversion client program, run
+\begin_layout Plain Layout
+svn move -q
\family typewriter
-svn --help
-\family default
-in a DOS shell.
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
-\begin_layout Enumerate
-Locate
-\family typewriter
-C:
-\backslash
-new project
-\family default
-in Windows Explorer, right click it, and select
-\family typewriter
-TortoiseSVN > Repo-browser
-\family default
-.
- If necessary, adjust the URL for the repository, then click OK.
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn commit
\end_layout
-\begin_layout Enumerate
-Right click the level of the repository under which you want to place the
- new project folder (typically the top level) and click
-\family typewriter
-Create folder\SpecialChar \ldots{}
+\end_inset
+
-\family default
- Supply a name for the project folder and click OK.
- Add a message for the log file if desired, then click OK again.
- The new project folder should appear in the repository.
- Finally, click OK again to exit the repository browser.
\end_layout
-\begin_layout Enumerate
-Once again right click
-\family typewriter
-C:
-\backslash
-new project
+\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
+
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
+\end_inset
+
+Control\SpecialChar \menuseparator
+
+\bar under
+T
+\bar default
+oggle locking property
+\family default
+.
+ This command is active only when the file is not locked on the svn server
+ (i.e.
+ you need to check-out before proceeding).
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Set:
+\family typewriter
+ svn propset svn:needs-lock ON "<file-name>"
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Unset:
+\family typewriter
+svn propdel svn:needs-lock "<file-name>"
+\end_layout
+
+\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:VCS-Revision-Information"
+
+\end_inset
+
+Revision Information in Documents
+\end_layout
+
+\begin_layout Standard
+There are more possibilities how to activate revision information in our
+ document.
+\end_layout
+
+\begin_layout Itemize
+LyX supports directly:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+tree revision information (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-tree-revision
+\end_layout
+
+\end_inset
+
+).
+ The result is the output of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
+\end_layout
+
+\end_inset
+
+ command, the following table gives you an idea, how to read the results.
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="6" columns="2">
+<features rotate="0" tabularvalignment="middle">
+<column alignment="center" valignment="top">
+<column alignment="center" valignment="top">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Output
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Meaning
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123:4168
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mixed revision working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4168M
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+modified working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123S
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+switched working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123P
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+partial working copy, from a sparse checkout
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123:4168MS
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mixed revision, modified, switched working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+file revision information.
+ The result comes from parsing the output of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn
+\begin_inset space ~
+\end_inset
+
+info
+\begin_inset space ~
+\end_inset
+
+--xml
+\begin_inset space ~
+\end_inset
+
+file.lyx
+\end_layout
+
+\end_inset
+
+.
+ Supported flags are:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+version number of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-revision
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+author of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-author
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+date of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-date
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+time of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-time
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+You can obtain this info via InsetInfo (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+info-insert buffer vcs-date
+\end_layout
+
+\end_inset
+
+).
+ The information will be available only when you have the file stored under
+ svn managment (i.e.
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.svn
+\end_layout
+
+\end_inset
+
+ directory is available with your document).
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+Another---a hacking one---possibility is to use svn keywords
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
+\end_layout
+
+\end_inset
+
+.
+ In short -- you set file keywords property (e.g.
+
+\family sans
+svn propset svn:keywords 'Rev' file.lyx
+\family default
+) and then paste keyword TeX code
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This is an easy way how to ensure that LyX won't break the line in the middle
+ of keyword tag.
+\end_layout
+
+\end_inset
+
+ tag in your document (e.g.
+
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+$Rev$
+\end_layout
+
+\end_inset
+
+).
+ This way svn client will automatically substitute revision number (e.g.
+
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+$Rev: 59 $
+\end_layout
+
+\end_inset
+
+) after each update and commit.
+ There are more problems with this approach.
+ Firstly, the '$' character is used in TeX world for math equations, so
+ any occurence of math formula
+\begin_inset Formula $Rev$
+\end_inset
+
+ become
+\begin_inset Formula $Rev:59$
+\end_inset
+
+ in your LyX document.
+ Similarly for other keywords like Id, Date, Author, etc.
+ Secondly svn output is dependent on your locales, so its very easy that
+ svn would produce some problematic strings once Date is used.
+ Thirdly you get the whole 'Rev: 59' string in your document instead of
+ the plain number.
+ Until subversion implements user's custom keywords it will be hard to use
+ this approach reliably or let LyX to support it directly.
+\end_layout
+
+\begin_layout Subsection
+SVN and Windows Environment
+\end_layout
+
+\begin_layout Quote
+My inclination is to say that if the user cannot figure out the command
+ line operations on their own fairly quickly, they would be well advised
+ to use TortoiseSVN.
+ ---P.
+ A.
+ Rubin
+\end_layout
+
+\begin_layout Subsubsection
+Preparation
+\end_layout
+
+\begin_layout Standard
+In addition to installing LyX, and having access to a Subversion repository,
+ the user will need to install the Subversion client program.
+ A Windows installer for the client program is available from
+\begin_inset CommandInset href
+LatexCommand href
+name "CollabNet"
+target "http://www.collab.net/nonav/downloads/subversion/"
+
+\end_inset
+
+.
+ The user may also want to install
+\begin_inset CommandInset href
+LatexCommand href
+name "TortoiseSVN"
+target "http://tortoisesvn.tigris.org/"
+
+\end_inset
+
+, which integrates Subversion operations into the context (rightclick) menu
+ of Windows Explorer.
+ Operations done outside LyX will typically be more convenient using the
+ Explorer context menu.
+ Note that TortoiseSVN is not a replacement for the client program, which
+ is what LyX itself will use.
+\end_layout
+
+\begin_layout Subsubsection
+Bringing a document under Subversion control
+\end_layout
+
+\begin_layout Standard
+Before a LyX document can be brought under version control in Subversion,
+ its parent directory needs to be under version control.
+ If the document is being added to a project already in the repository,
+ this is accomplished by checking the project out to the directory where
+ the new document will be placed.
+ If the project itself is not yet under version control (for instance, if
+ this document starts a new project), the directory must be imported into
+ the repository.
+ This is done outside LyX.
+ Both import and checkout are easily accomplished from the Explorer context
+ menu using TortoiseSVN, or alternatively can be done using the command
+ line client at a DOS prompt.
+ The procedure for importing the project using TortoiseSVN is described
+ below, assuming an existing repository and a new project being started
+ in
+\family typewriter
+C:
+\backslash
+new project
+\family default
+.
+ For information on using the Subversion client program, run
+\family typewriter
+svn --help
+\family default
+in a DOS shell.
+\end_layout
+
+\begin_layout Enumerate
+Locate
+\family typewriter
+C:
+\backslash
+new project
+\family default
+in Windows Explorer, right click it, and select
+\family sans
+TortoiseSVN\SpecialChar \menuseparator
+Repo-browser
+\family default
+.
+ If necessary, adjust the URL for the repository, then click OK.
+\end_layout
+
+\begin_layout Enumerate
+Right click the level of the repository under which you want to place the
+ new project folder (typically the top level) and click
+\family sans
+Create folder
+\family default
+ Supply a name for the project folder and click OK.
+ Add a message for the log file if desired, then click OK again.
+ The new project folder should appear in the repository.
+ Finally, click OK again to exit the repository browser.
+\end_layout
+
+\begin_layout Enumerate
+Once again right click
+\family typewriter
+C:
+\backslash
+new project
+\family default
+, this time selecting SVN Checkout\SpecialChar \ldots{}
+ Select the URL of the project folder
+ you just created in the repository, and set the checkout directory to
+\family typewriter
+C:
+\backslash
+new project.
+
+\family default
+ Click OK.
+ You will be warned about a non-empty folder; click OK to proceed.
+ You should now have a
+\family typewriter
+.svn
+\family default
+ directory under
+\family typewriter
+C:
+\backslash
+new project.
+\end_layout
+
+\begin_layout Enumerate
+Create or open your document in LyX and click
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+
+Control\SpecialChar \menuseparator
+Register.
+
+\family default
+Add a log message and click OK to commit the document to version control.
+\end_layout
+
+\begin_layout Standard
+From this point onward, you should have full functionality in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+ menu.
+ You also have the option of checking the document in and out, viewing its
+ history, etc.
+ using the TortoiseSVN context menu in Windows Explorer or the Subversion
+ client program from a command prompt.
+\end_layout
+
+\begin_layout Subsubsection
+SSH tunnel used with SVN under Windows
+\end_layout
+
+\begin_layout Standard
+Compared with Linux setting up an svn client to communicate over ssh under
+ Windows is a rather troublesome task.
+ We will at least offer some hints how to setup the client side but prior
+ knowledge about ssh and the Windows command line is needed, also be prepared
+ for a great deal of frustration\SpecialChar \ldots{}
+
+\end_layout
+
+\begin_layout Enumerate
+Get an svn client for windows, as described in the previous sections.
+ When it is a fresh install run some svn command (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn --version
+\end_layout
+
+\end_inset
+
+) to create config files, which you will need to change later on.
+\end_layout
+
+\begin_layout Enumerate
+Choose an ssh client for Windows.
+ There are several possibilities, we will use the one from Putty tools
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+.
+ 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 Code
+status collapsed
+
+\begin_layout Plain Layout
+puttygen
+\end_layout
+
+\end_inset
+
+.
+ Save your private .ppk key file and put the public one on the server side.
+ 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 Code
+status collapsed
+
+\begin_layout Plain Layout
+~/.ssh/authorized_keys
+\end_layout
+
+\end_inset
+
+ /
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+authorized_keys2
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_layout Enumerate
+Get the Putty's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+plink
+\end_layout
+
+\end_inset
+
+.
+ In the SVN config file
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Exact path depends on Windows version, usually somewhere around
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+c:
+\backslash
+Documents and Settings
+\backslash
+user
+\backslash
+Application Data
+\backslash
+Subversion
+\backslash
+config
+\end_layout
+
+\end_inset
+
+ /
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AppData
+\backslash
+Roaming
+\backslash
+Subversion
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+, section [tunnels], setup ssh command, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ssh=c:/path/plink.exe -i c:/path/private_key.ppk
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+It will usually take a lot of time to get exact command right and it depends
+ on many things.
+ For example do not have some remote server saved as a default session in
+ Putty etc.
+ If things fail, try to connect via plink without SVN first.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Checkout the SVN archive, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn co svn+ssh://user@server/repository_path
+\end_layout
+
+\end_inset
+
+.
+\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
+GIT commands in LyX
+\end_layout
+
+\begin_layout Standard
+A minimal subset of GIT commands is now 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 GIT 1.7.
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Windows users please note that you need to ensure that git is on the path.
+ This can be set from within LyX at
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths\SpecialChar \menuseparator
+PATH prefix
+\family default
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+One big difference of GIT and the other supported version control systems
+ is the distributed nature of GIT: With traditional version control systems
+ there is one central server which hosts the repository.
+ Users commit their changes to the server, and get updates made by other
+ users from it.
+ With GIT, users commit to a local repository.
+ The local repository can be synchronized with one or more remote repositories
+ using the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pull
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+push
+\end_layout
+
+\end_inset
+
+ GIT commands.
+ LyX does not interact in any way with remote GIT repositories.
+ It works exclusively with the local repository in a very similar way as
+ with a central CVS or SVN repository.
+ If you use remote GIT repositories you need to do the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pull
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+push
+\end_layout
+
+\end_inset
+
+ operations with your favourite GIT client.
+\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 GIT your document ONLY in case you have already
+ the documents directory under GIT control (in particular
+\family typewriter
+.git/index
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+\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.
+\end_layout
+
+\begin_layout Standard
+GIT command that is run:
+\family typewriter
+git add
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Read
+\family typewriter
+man git
+\family default
+ to understand the switches.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
+\end_layout
+
+\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
+GIT command:
+\family typewriter
+git commit -q -m"<description>" <file-name>
+\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
+GIT command:
+\family typewriter
+git checkout -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+GIT
+\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
+git mv
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the GIT document.
+ The output of
+\family typewriter
+git 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
+Version Info
+\end_layout
+
+\begin_layout Standard
+LyX supports GIT hash number of the last commit to the file, author name,
+ date and time of last commit.
+ All those are extracted from
+\family typewriter
+git log -n 1 --pretty=format:%H%n%an%n%ai
+\family default
+.
+ Tree version information is obtained via
+\family typewriter
+git describe --abbrev --dirty --long
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
+
+\end_inset
+
+ for other details.
+\end_layout
+
+\begin_layout Subsection
+Further tuning
+\end_layout
+
+\begin_layout Standard
+With the recent addition of the vc-command function LyX power users are
+ allowed to create their own commands for revision control.
+\end_layout
+
+\begin_layout Standard
+As an example you can see how two TortoiseSVN commands could be integrated
+ directly:
+\end_layout
+
+\begin_layout Description
+Commit:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Revert:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\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 a complicated structure.
+ Hence we provide binding to the Document comparison feature.
+ There 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'.
+ We don't currently support GIT addressing of revisions, one can just compare
+ edited document with its revision X steps backs, where X is addressed as
+ HEAD~X.
+\end_layout
+
+\begin_layout Section
+Literate Programming
+\end_layout
+
+\begin_layout Standard
+Updated by
+\noun on
+Kayvan Sylvan
+\noun default
+(kayvan@sylvan.com)
+\noun on
+,
+\noun default
+original documentation written by
+\noun on
+Edmar Wienskoski Jr.
+
+\noun default
+ (edmar-w-jr@technologist.com)
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\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
+\begin_inset Quotes eld
+\end_inset
+
+tangling
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+weaving
+\begin_inset Quotes erd
+\end_inset
+
+ means.
+ If that is not the case, please follow the web links provided in the following
+ sections.
+ There is a lot of good documentation out there covering old development
+ history to the latest tools tips.
+\end_layout
+
+\begin_layout Standard
+It is also assumed that you are familiar with LyX itself to a point that
+ you are comfortable changing your LyX preferences, and X resources file.
+ If that is not the case please refer to other LyX documentation to cover
+ your specific needs.
+\end_layout
+
+\begin_layout Subsection
+Literate Programming
+\end_layout
+
+\begin_layout Standard
+From the Literate Programming FAQ:
+\end_layout
+
+\begin_layout Quotation
+Literate programming is the combination of documentation and source together
+ in a fashion suited for reading by human beings.
+ In fact, literate programs should be enjoyable reading, even inviting!
+ (Sorry Bob, I couldn't resist!) In general, literate programs combine source
+ and documentation in a single file.
+ Literate programming tools then parse the file to produce either readable
+ documentation or compilable source.
+ The WEB style of literate programming was created by D.
+\begin_inset space \thinspace{}
+\end_inset
+
+E.
+ Knuth during the development of his TeX typesetting software.
+
+\end_layout
+
+\begin_layout Standard
+Another excerpt says:
+\end_layout
+
+\begin_layout Quotation
+
+\emph on
+How is literate programming different from verbose commenting?
+\end_layout
+
+\begin_layout Quotation
+There are three distinguishing characteristics.
+ In order of importance, they are:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+flexible order of elaboration
+\end_layout
+
+\begin_layout Itemize
+automatic support for browsing
+\end_layout
+
+\begin_layout Itemize
+typeset documentation, especially diagrams and mathematics
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+Now that I sparked your curiosity, take a look in the references.
+\end_layout
+
+\begin_layout Subsubsection
+References
+\end_layout
+
+\begin_layout Standard
+The complete Literate Programming FAQ can be found at:
+\end_layout
+
+\begin_layout Quote
+Literate Programming FAQ
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.literateprogramming.com/lpfaq.pdf
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The FAQ lists 23 (twenty three!) different literate programming tools.
+ Where some are specialized or
+\begin_inset Quotes eld
+\end_inset
+
+tailored
+\begin_inset Quotes erd
+\end_inset
+
+ for particular programming languages, while other have general scope.
+ I selected
+\noun on
+Noweb
+\noun default
+ for my own use for several reasons:
+\end_layout
+
+\begin_layout Itemize
+It can generate the documentation either in LaTeX or HTML.
+\end_layout
+
+\begin_layout Itemize
+It has a open architecture, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+it is easy to plug in new filters and to perform special processing that
+ you may need.
+
+\end_layout
+
+\begin_layout Itemize
+There is a good selection of filters available already (the HTML is one
+ of them).
+\end_layout
+
+\begin_layout Itemize
+It is free.
+\end_layout
+
+\begin_layout Standard
+The Noweb web page can be found at:
+\end_layout
+
+\begin_layout Quote
+Noweb home page
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.cs.virginia.edu/~nr/noweb/
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Starting from there you can reach many other interesting links and even
+ some literate program examples.
+\end_layout
+
+\begin_layout Subsection
+LyX and Literate Programming with Noweb
+\end_layout
+
+\begin_layout Standard
+The LyX support for Literate Programming is provided by using the generic
+ LyX converters mechanism.
+ This support is provided in a
+\begin_inset Quotes eld
+\end_inset
+
+Noweb independent
+\begin_inset Quotes erd
+\end_inset
+
+ way, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+you will be able to use this new LyX feature with some other literate programmin
+g tool of your choice by just changing your LyX preferences.
+\end_layout
+
+\begin_layout Subsubsection
+Generating documents and code (weaving and tangling)
+\end_layout
+
+\begin_layout Paragraph
+Using the noweb module
+\end_layout
+
+\begin_layout Standard
+If you have installed Noweb and LyX successfully, whenever you open a new
+ document, after you have chosen its document class, use the Document->Settings
+ menu to add the
+\begin_inset Quotes eld
+\end_inset
+
+noweb
+\begin_inset Quotes erd
+\end_inset
+
+ module.
+ If Noweb is correctly installed, when you click on the
+\begin_inset Quotes eld
+\end_inset
+
+Modules
+\begin_inset Quotes erd
+\end_inset
+
+ link, you will see the
+\begin_inset Quotes eld
+\end_inset
+
+noweb
+\begin_inset Quotes erd
+\end_inset
+
+ module in the available list and you can add it to your document.
+\end_layout
+
+\begin_layout Paragraph
+Typing code in
+\end_layout
+
+\begin_layout Standard
+LyX enables you to write code with a layout named
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Chunk
+\end_layout
+
+\end_inset
+
+.
+ Noweb delimits chunks like this:
+\end_layout
+
+\begin_layout LyX-Code
+<<My code>>=
+\end_layout
+
+\begin_layout LyX-Code
+ code
+\end_layout
+
+\begin_layout LyX-Code
+ more code
+\end_layout
+
+\begin_layout LyX-Code
+ even more code
+\end_layout
+
+\begin_layout LyX-Code
+ @
+\end_layout
+
+\begin_layout Standard
+The problem is that whatever is written in between the << and the
+\family typewriter
+@
+\family default
+ must be taken literally, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+LyX should be prevented from making any special interpretation of what has
+ been written.
+ This is also handled by
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Chunk
+\end_layout
+
+\end_inset
+
+, that works like a normal paragraph but has a free spacing capability.
+\end_layout
+
+\begin_layout Standard
+As a special note, you can also use the
+\begin_inset Quotes eld
+\end_inset
+
+%def
+\begin_inset Quotes erd
+\end_inset
+
+ construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
+rence:
+\end_layout
+
+\begin_layout LyX-Code
+<<My chunk>>=
+\end_layout
+
+\begin_layout LyX-Code
+def some_function(args):
+\end_layout
+
+\begin_layout LyX-Code
+ "This is the doc string for this function."
+\end_layout
+
+\begin_layout LyX-Code
+ print "My args: ", args
+\end_layout
+
+\begin_layout LyX-Code
+@ %def some_function
+\end_layout
+
+\begin_layout Standard
+For an example of this usage and the resulting cross-reference output, look
+ at the Literate python program in
+\emph on
+LIBDIR/examples/listerrors.lyx
+\emph default
+ which should make this all clear.
+\end_layout
+
+\begin_layout Paragraph
+Generating the documentation
+\end_layout
+
+\begin_layout Standard
+At this point you already have a new document file with a proper document
+ class, and with some code and text on it.
+ How do I print it? The answer is simple, you select
+\family sans
+View\SpecialChar \menuseparator
+DVI,
+\family default
+ etc.
+ Just like you would do for a plain document.
+ No special procedure is required.
+\end_layout
+
+\begin_layout Standard
+To help orientate you, I will now explain what happens inside LyX:
+\end_layout
+
+\begin_layout Enumerate
+When the
+\family sans
+Update\SpecialChar \menuseparator
+DVI
+\family default
+ menu option is chosen, a LaTeX file is generated.
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+If the document is of any literate class the generated file will be named
+ with an extension name defined by the
+\begin_inset Quotes eld
+\end_inset
+
+literate
+\begin_inset Quotes erd
+\end_inset
+
+ format (defined in the Preferences panel), otherwise the file will have
+ the usual
+\family typewriter
+.tex
+\family default
+ extension.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Note that the only difference so far is in the name of the file, no special
+ processing is required by LyX.
+ Given that you formatted the code using the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Chunk
+\end_layout
+
+\end_inset
+
+ layout that, by itself, takes care of the business.
+\end_layout
+
+\begin_layout Enumerate
+If the document is of any literate class LyX will then use the internal
+ LyX to Noweb converter, followed by the Noweb to LaTeX converter
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The converters are defined in the
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences
+\family default
+ panel, under the
+\begin_inset Quotes eld
+\end_inset
+
+Conversion
+\begin_inset Quotes erd
+\end_inset
+
+ tab.
+ See section
+\emph on
+Converters
+\emph default
+ of the
+\emph on
+Customization
+\emph default
+ manual for general information about converters.
+\end_layout
+
+\end_inset
+
+ to generate the LaTeX file.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+Otherwise it will just skip this step.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Finally, LaTeX is invoked and the regular post processing continues as in
+ a plain document.
+\end_layout
+
+\begin_layout Standard
+Independence from a particular
+\begin_inset Quotes eld
+\end_inset
+
+literate tool
+\begin_inset Quotes erd
+\end_inset
+
+ is easily achieved by changing the commands that are run by the various
+ converters.
+\end_layout
+
+\begin_layout Paragraph
+Generating the code
+\end_layout
+
+\begin_layout Standard
+When the build menu option is chosen or the corresponding button in the
+ toolbar is pressed, a LaTeX file is generated just like step 1 above.
+ Next, LyX invokes the
+\family typewriter
+Noweb->Program
+\family default
+ converter.
+ This converter needs to be defined by the user and is not installed by
+ default, though the Program format is.
+ This converter (like any other converter) will have two parts:
+\end_layout
+
+\begin_layout Enumerate
+The converter program itself.
+ This program performs the conversion from the one format to the other (in
+ this case, from the Noweb format to the Program pseudo-format).
+\end_layout
+
+\begin_layout Enumerate
+The error log parser.
+ This is a program whose sole purpose is to rewrite error messages in a
+ format that LyX understands.
+ This makes it possible for LyX to place error boxes in the right places
+ in the file buffer.
+\end_layout
+
+\begin_layout Standard
+The first part, the
+\begin_inset Quotes eld
+\end_inset
+
+Converter
+\begin_inset Quotes erd
+\end_inset
+
+ setting, should be set to
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+build-script $$i
+\family default
+ $$r
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+This basically means that LyX will call
+\begin_inset Quotes eld
+\end_inset
+
+build-script
+\begin_inset Quotes erd
+\end_inset
+
+ (a program or script) with the name of the Noweb file (normally a file
+ in the LyX temp directory) and the directory path of the original LyX file.
+
+\end_layout
+
+\begin_layout Standard
+This is an implementation of
+\begin_inset Quotes eld
+\end_inset
+
+build-script
+\begin_inset Quotes erd
+\end_inset
+
+ that you can place in a directory on your path:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage pagebreak
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\family sans
+#!/bin/sh
+\end_layout
+
+\begin_layout Standard
+
+\family sans
+#
+\end_layout
+
+\begin_layout Standard
+
+\family sans
+notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The next part of the converter setting is the
+\begin_inset Quotes eld
+\end_inset
+
+Flags
+\begin_inset Quotes erd
+\end_inset
+
+ which is to be set to
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+parselog=$$s/scripts/listerrors
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+This will run any errors that are generated by the
+\begin_inset Quotes eld
+\end_inset
+
+build-script
+\begin_inset Quotes erd
+\end_inset
+
+ process through the
+\begin_inset Quotes eld
+\end_inset
+
+listerrors
+\begin_inset Quotes erd
+\end_inset
+
+ program.
+\end_layout
+
+\begin_layout Standard
+The build will normally take place in LyX's temporary directory, so the
+ files produced by the conversion will be in that directory.
+ LyX will copy out what it regards as the `main' file, but the
+\family typewriter
+Noweb->Program
+\family default
+ conversion may produce several files, and so most of these would then be
+ deleted when LyX was closed.
+ This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
+ the build-script chunk can place the generated files in that location.
+\end_layout
+
+\begin_layout Paragraph
+Build instructions in the document
+\end_layout
+
+\begin_layout Standard
+The last piece of the integration between LyX and noweb is the
+\begin_inset Quotes eld
+\end_inset
+
+build-script
+\begin_inset Quotes erd
+\end_inset
+
+ chunk.
+ Generally, the instructions for building your program should be embedded
+ in a chunk of its own.
+ The noweb-specific
+\begin_inset Quotes eld
+\end_inset
+
+build-script
+\begin_inset Quotes erd
+\end_inset
+
+ above uses the notangle command to look for this chunk (called
+\begin_inset Quotes eld
+\end_inset
+
+build-script
+\begin_inset Quotes erd
+\end_inset
+
+) and runs its contents through
+\begin_inset Quotes eld
+\end_inset
+
+sh
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Typically, such a chunk would look something like this:
+\end_layout
+
+\begin_layout LyX-Code
+<<build-script>>=
+\end_layout
+
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
+
+if [ -z "${NOWEB_SOURCE}" ]
+\begin_inset Newline newline
+\end_inset
+
+then
+\end_layout
+
+\begin_layout LyX-Code
+NOWEB_SOURCE=myfile.nw
+\begin_inset Newline newline
+\end_inset
+
+fi
+\begin_inset Newline newline
+\end_inset
+
+[...
+ code to extract files ...
+ use NOWEB_OUTPUT_DIR here ...]
+\begin_inset Newline newline
+\end_inset
+
+[...
+ code to compile files ...]
+\begin_inset Newline newline
+\end_inset
+
+@
+\end_layout
+
+\begin_layout Standard
+Look in
+\emph on
+LIBDIR/examples/listerrors.lyx
+\emph default
+ or in
+\emph on
+LIBDIR/examples/Literate.lyx
+\emph default
+ which implement two versions of the
+\begin_inset Quotes eld
+\end_inset
+
+listerrors
+\begin_inset Quotes erd
+\end_inset
+
+ program for some illustrations of how all of these pieces go together or
+ in
+\emph on
+LIBDIR/examples/noweb2lyx.lyx.
+
+\emph default
+ Interestingly, these three files show off the language-indepence of the
+ LyX literate programming support since they are written in Python, C and
+ Perl respectively.
+\end_layout
+
+\begin_layout Subsubsection
+Configuring LyX
+\end_layout
+
+\begin_layout Standard
+All the Literate Programming support is configured by the
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences
+\family default
+ panel in the
+\begin_inset Quotes eld
+\end_inset
+
+File Handling
+\begin_inset Quotes erd
+\end_inset
+
+ tab.
+ The important parts are:
+\end_layout
+
+\begin_layout Description
+the
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+NoWeb
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset space ~
+\end_inset
+
+format Set up via the File Formats tab, this is where the Noweb-specific
+ pieces are set up.
+ The
+\family sans
+GUI Name
\family default
-, this time selecting SVN Checkout\SpecialChar \ldots{}
- Select the URL of the project folder
- you just created in the repository, and set the checkout directory to
+ is set to
\family typewriter
-C:
-\backslash
-new project.
-
+NoWeb
\family default
- Click OK.
- You will be warned about a non-empty folder; click OK to proceed.
- You should now have a
+, the file extension is set to
\family typewriter
-.svn
+.nw
\family default
- directory under
+.
+ This tells LyX to create a file with a
\family typewriter
-C:
-\backslash
-new project.
+.nw
+\family default
+ extension in the first step of the conversion process.
\end_layout
-\begin_layout Enumerate
-Create or open your document in LyX and click
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-V
-\bar default
-ersion
+\begin_layout Description
+the
\begin_inset space ~
\end_inset
-Control\SpecialChar \menuseparator
-\bar under
-R
-\bar default
-egister.
-
+\family sans
+Program
\family default
-Add a log message and click OK to commit the document to version control.
+
+\begin_inset space ~
+\end_inset
+
+format This is an empty format whose sole purpose is to be the endpoint
+ of a conversion (which then allows us to set up a converter for it).
\end_layout
-\begin_layout Standard
-From this point onward, you should have full functionality in the
+\begin_layout Description
+
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+NoWeb
+\family default
+->
+\family sans
+LaTeX
+\family default
+ This converter performs the
+\begin_inset Quotes eld
+\end_inset
-\bar under
-V
-\bar default
-ersion
-\begin_inset space ~
+weaving
+\begin_inset Quotes erd
\end_inset
-Control
+ of the literate document.
+ For Noweb, it is set to
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+noweave -delay -index $$i > $$o
\family default
- menu.
- You also have the option of checking the document in and out, viewing its
- history, etc.
- using the TortoiseSVN context menu in Windows Explorer or the Subversion
- client program from a command prompt.
-\end_layout
-\begin_layout Subsubsection
-SSH tunel used with SVN under Windows
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+
-\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...
\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.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Description
-\begin_layout Plain Layout
-svn --version
-\end_layout
+\family sans
+NoWeb
+\family default
+->
+\family sans
+Program
+\family default
+ This performs the
+\begin_inset Quotes eld
+\end_inset
+tangling step
+\begin_inset Quotes erd
\end_inset
-) to have created config files, which you will need to change later on.
-\end_layout
+.
+ As stated above, the Converter is set to
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Enumerate
-Choose ssh client for Windows.
- There are more possibilities, we will use the one from Putty tools
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-\begin_inset Flex URL
-status collapsed
+\family typewriter
+build-script $$i
+\family default
+ $$r
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+, with Flags set to
+\begin_inset Newline newline
+\end_inset
-http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
-\end_layout
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\family typewriter
+parselog=$$s/scripts/listerrors
+\family default
+\begin_inset Quotes erd
\end_inset
.
- You will need to automatize connection, so 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
-status collapsed
-
-\begin_layout Plain Layout
-puttygen
+\begin_layout Subsubsection
+Debug extensions
\end_layout
+\begin_layout Standard
+There is also a new function implemented in the LyX server, the
+\begin_inset Quotes eld
\end_inset
-.
- 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 “
-\emph on
-Public key for pasting into OpenSSH authorized_keys file
-\emph default
-:” edit field into the server's
-\begin_inset Flex CharStyle:Code
-status collapsed
+server-goto-file-row" function, to be used with ddd/gdb or other debugger.
+
+\end_layout
-\begin_layout Plain Layout
-~/.ssh/authorized_keys
+\begin_layout Standard
+When debugging code with ddd/gdb, it is possible to invoke a text editor
+ at the current execution position with a single key stroke.
+ The default ddd configuration for that is shift-ctrl-V.
+ It happens that you can define the editor command line invocation in ddd
+ by accessing the
+\family sans
+Edit\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Helpers
+\family default
+ dialog and changing the "Edit Sources" entry.
\end_layout
+\begin_layout Standard
+I take advantage of the newly created LyX server function and this ddd feature,
+ and set
+\begin_inset Quotes eld
\end_inset
-/
-\begin_inset Flex CharStyle:Code
-status collapsed
+Edit Sources
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-authorized_keys2
+ to:
\end_layout
+\begin_layout Standard
+\begin_inset VSpace defskip
\end_inset
- file.
+
\end_layout
-\begin_layout Enumerate
-Get the Putty's
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
-\begin_layout Plain Layout
-plink
+\family sans
+echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
\end_layout
+\begin_layout Standard
+\begin_inset VSpace defskip
\end_inset
-.
- In the SVN config file
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-Exact path depends on Windows version, usually somewhere around
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-c:
-\backslash
-Documents and Settings
-\backslash
-user
-\backslash
-Application Data
-\backslash
-Subversion
-\backslash
-config
+\begin_layout Standard
+With this, whenever you are using ddd and find a point in the program that
+ you want to edit, you just press shift-ctrl-V (in the ddd window), and
+ ddd will forward this information to LyX through the LyX server and then
+ the LyX window will show the same file with the cursor at the same position
+ ddd was pointing to.
+ No more guessing or long scrolling to locate a point in the program back
+ from debugging !
\end_layout
+\begin_layout Standard
+Note however that you must enable the LyX server to get this feature working
+ (it is disabled by default).
+ You can enable it in
+\family sans
+Preferences
+\family default
+ (tabs
+\family sans
+Inputs
+\family default
+,
+\family sans
+Paths
+\family default
+) by entering in the
+\family sans
+LyXserver pipe
+\family default
+ a path like
+\begin_inset Quotes eld
\end_inset
- /
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-AppData
-\backslash
-Roaming
-\backslash
-Subversion
-\end_layout
+\family typewriter
+/home/<your-home-directory>/.lyx/lyxpipe
+\family default
+\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-\end_inset
+\end_layout
-, section [tunnels], setup ssh command, e.g.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+Read the LyX server documentation in the
+\emph on
+Customization Manual
+\emph default
+ for further information.
+\end_layout
-\begin_layout Plain Layout
-ssh=c:/path/plink.exe -i c:/path/private_key.ppk
+\begin_layout Subsubsection
+Toolbar extensions
\end_layout
+\begin_layout Standard
+There are six new buttons that can be added to your LyX toolbar.
+ Five of these buttons are short cuts to layout styles:
+\family sans
+Standard
+\family default
+,
+\family sans
+Section
+\family default
+,
+\family sans
+LaTeX
+\family default
+,
+\family sans
+LyX-Code
+\family default
+, and
+\family sans
+Chunk
+\family default
+.
+ The last one is a short cut to the
+\begin_inset Quotes eld
\end_inset
-.
-\begin_inset Foot
-status collapsed
+Build Program
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-It will usually take a lot of time to get exact command right and it depends
- on many things.
- For example do not have some remote server saved as a default session in
- Putty etc.
- If things fail, try to connect via plink without SVN first.
+ File menu entry.
+
\end_layout
-\end_inset
+\begin_layout Standard
+LyX has a range of buttons that are available for tool bar customization.
+ In my toolbar I like to combine the six short cuts above with two more:
+ One for
+\family sans
+Document
+\family default
+\SpecialChar \menuseparator
+\family sans
+Update
+\family default
+\SpecialChar \menuseparator
+\family sans
+DVI
+\family default
+ and the other for
+\family sans
+Document\SpecialChar \menuseparator
+View\SpecialChar \menuseparator
+DVI
+\family default
+ File menu entries.
+ Here is how it looks like:
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Checkout the SVN archive, e.g.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-svn co svn+ssh://user@server/repository_path
+\begin_layout LyX-Code
+Toolbar
\end_layout
-\end_inset
-
-.
+\begin_layout LyX-Code
+ Layouts
\end_layout
-\begin_layout Subsection
-Further tuning
+\begin_layout LyX-Code
+ Icon "layout Standard"
\end_layout
-\begin_layout Standard
-With the recent addition of the vc-command function LyX power users are
- allowed to create their own commands for revision control.
+\begin_layout LyX-Code
+ Icon "layout Section"
\end_layout
-\begin_layout Standard
-As an example you can see how two TortoiseSVN commands could be integrated
- directly:
+\begin_layout LyX-Code
+ Icon "layout LaTeX"
\end_layout
-\begin_layout Description
-Commit:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+\begin_layout LyX-Code
+ Icon "layout LyX-Code"
\end_layout
-\end_inset
-
+\begin_layout LyX-Code
+ Icon "layout Chunk"
+\end_layout
+\begin_layout LyX-Code
+ Separator
\end_layout
-\begin_layout Description
-Revert:
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+ Icon "buffer-view"
+\end_layout
-\begin_layout Plain Layout
-vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+\begin_layout LyX-Code
+ Icon "buffer-typeset"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ Icon "build-program"
+\end_layout
+\begin_layout LyX-Code
+ Separator
+\end_layout
+\begin_layout LyX-Code
+.
\end_layout
-\begin_layout Section
-Literate Programming
+\begin_layout LyX-Code
+.
\end_layout
-\begin_layout Standard
-Updated by
-\noun on
-Kayvan Sylvan
-\noun default
-(kayvan@sylvan.com)
-\noun on
-,
-\noun default
-original documentation written by
-\noun on
-Edmar Wienskoski Jr.
+\begin_layout LyX-Code
+.
+\end_layout
-\noun default
- (edmar-w-jr@technologist.com)
+\begin_layout LyX-Code
+End
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Subsubsection
+Colors customization
\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
-\begin_inset Quotes eld
-\end_inset
-
-tangling
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-weaving
-\begin_inset Quotes erd
-\end_inset
-
- means.
- If that is not the case, please follow the web links provided in the following
- sections.
- There is a lot of good documentation out there covering old development
- history to the latest tools tips.
+There are a number of colors in LyX that can be customized in
+\family sans
+Preferences
+\family default
+.
+ One of the things that bothers people is the LaTeX font color.
+ The default color is red, since the chunks uses LaTeX font, and there is
+ a lot of chunks in literate documents, you may get tired of seeing everything
+ in red.
+ You can change it by going to the tabs
+\family sans
+Look&Feel
+\family default
+,
+\family sans
+Colors.
\end_layout
\begin_layout Standard
-It is also assumed that you are familiar with LyX itself to a point that
- you are comfortable changing your LyX preferences, and X resources file.
- If that is not the case please refer to other LyX documentation to cover
- your specific needs.
+The next thing is the visible presence of the newline character in the screen.
+ You can choose the color of this particular character and make it blend
+ in the background.
+ I recommend you choosing a color that is close to the background but not
+ equal, that way you still can see it is there, but it is not bothering
+ you anymore.
\end_layout
\begin_layout Subsection
-Literate Programming
+LyX and knitr/Sweave
\end_layout
\begin_layout Standard
-From the Literate Programming FAQ:
-\end_layout
-
-\begin_layout Quotation
-Literate programming is the combination of documentation and source together
- in a fashion suited for reading by human beings.
- In fact, literate programs should be enjoyable reading, even inviting!
- (Sorry Bob, I couldn't resist!) In general, literate programs combine source
- and documentation in a single file.
- Literate programming tools then parse the file to produce either readable
- documentation or compilable source.
- The WEB style of literate programming was created by D.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
- Knuth during the development of his TeX typesetting software.
-
+Support for
+\family sans
+knitr
+\family default
+ and
+\family sans
+Sweave
+\family default
+ is documented in the
+\emph on
+knitr.lyx
+\emph default
+ example file and in the Sweave manual (menu
+\family sans
+Help\SpecialChar \menuseparator
+Specific Manuals
+\family default
+).
\end_layout
-\begin_layout Standard
-Another excerpt says:
+\begin_layout Chapter
+Special features
\end_layout
-\begin_layout Quotation
-
+\begin_layout Standard
+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
-How is literate programming different from verbose commenting?
-\end_layout
+Embedded
+\begin_inset space ~
+\end_inset
-\begin_layout Quotation
-There are three distinguishing characteristics.
- In order of importance, they are:
+Objects
+\emph default
+ manual.
\end_layout
-\begin_deeper
-\begin_layout Itemize
-flexible order of elaboration
+\begin_layout Section
+Multiple Text Columns
\end_layout
-\begin_layout Itemize
-automatic support for browsing
-\end_layout
+\begin_layout Standard
+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 Itemize
-typeset documentation, especially diagrams and mathematics
+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
-\end_deeper
\begin_layout Standard
-Now that I sparked your curiosity, take a look in the references.
-\end_layout
-
-\begin_layout Subsubsection
-References
+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
+ installed.
\end_layout
\begin_layout Standard
-The complete Literate Programming FAQ can be found at:
+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
+.
\end_layout
-\begin_layout Quote
-Literate Programming FAQ
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
-
-http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+\begin_layout Subsection
+Basics
\end_layout
+\begin_layout Standard
+If you want to have 2
+\begin_inset space ~
\end_inset
+columns in your text, insert a multicolumn inset via the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Custom
+\begin_inset space ~
+\end_inset
-\end_layout
-
-\begin_layout Standard
-The FAQ lists 23 (twenty three!) different literate programming tools.
- Where some are specialized or
-\begin_inset Quotes eld
+Insets\SpecialChar \menuseparator
+Multiple
+\begin_inset space ~
\end_inset
-tailored
-\begin_inset Quotes erd
+Columns
+\family default
+ where the columns should start.
+ Write all text that should be printed in 2
+\begin_inset space ~
\end_inset
- for particular programming languages, while other have general scope.
- I selected
-\noun on
-Noweb
-\noun default
- for my own use for several reasons:
+columns into this inset.
\end_layout
-\begin_layout Itemize
-It can generate the documentation either in LaTeX or HTML.
+\begin_layout Standard
+Here is an example:
\end_layout
-\begin_layout Itemize
-It has a open architecture, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Standard
+\noindent
+\begin_inset Flex Multiple Columns
+status open
-it is easy to plug in new filters and to perform special processing that
- you may need.
-
-\end_layout
+\begin_layout Plain Layout
+\noindent
-\begin_layout Itemize
-There is a good selection of filters available already (the HTML is one
- of them).
-\end_layout
+\series bold
+\size small
+The Adventure of the Empty House
+\series default
-\begin_layout Itemize
-It is free.
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-The Noweb web page can be found at:
+by Sir Arthur Conan Doyle
\end_layout
-\begin_layout Quote
-Noweb home page
-\begin_inset Flex URL
-status collapsed
-
\begin_layout Plain Layout
-http://www.cs.virginia.edu/~nr/noweb/
+\size small
+It was in the spring of the year 1894 that all London was interested, and
+ the fashionable world dismayed, by the murder of the Honourable Ronald
+ Adair under most unusual and inexplicable circumstances.
+ The public has already learned those particulars of the crime which came
+ out in the police investigation, but a good deal was suppressed upon that
+ occasion, since the case for the prosecution was so overwhelmingly strong
+ that it was not necessary to bring forward all the facts.
+ Only now, at the end of nearly ten years, am I allowed to supply those
+ missing links which make up the whole of that remarkable chain.
+ The crime was of interest in itself, but that interest was as nothing to
+ me compared to the inconceivable sequel, which afforded me the greatest
+ shock and surprise of any event in my adventurous life.
+ Even now, after this long interval, I find myself thrilling as I think
+ of it, and feeling once more that sudden flood of joy, amazement, and increduli
+ty which utterly submerged my mind.
+ Let me say to that public, which has shown some interest in those glimpses
+ which I have occasionally given them of the thoughts and actions of a very
+ remarkable man, that they are not to blame me if I have not shared my knowledge
+ with them, for I should have considered it my first duty to do so, had
+ I not been barred by a positive prohibition from his own lips, which was
+ only withdrawn upon the third of last month.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-Starting from there you can reach many other interesting links and even
- some literate program examples.
-\end_layout
+To get 3 or more columns, set the cursor into the multicolumn inset and
+ use the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Number
+\begin_inset space ~
+\end_inset
-\begin_layout Subsection
-LyX and Literate Programming
-\end_layout
+of
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-The LyX support for Literate Programming is provided by using the generic
- LyX converters mechanism.
- This support is provided in a
+Columns
+\family default
+.
+ The number of the desired columns is written into that inset (for 3
+\begin_inset space ~
+\end_inset
+
+columns write
\begin_inset Quotes eld
\end_inset
-Noweb independent
+3
\begin_inset Quotes erd
\end_inset
- way, i.
-\begin_inset space \thinspace{}
+).
+\begin_inset Newline newline
\end_inset
-g.
-\begin_inset space \space{}
+Here is an example with 3
+\begin_inset space ~
\end_inset
-you will be able to use this new LyX feature with some other literate programmin
-g tool of your choice by just changing your LyX preferences.
-\end_layout
-
-\begin_layout Subsubsection
-Generating documents and code (weaving and tangling)
-\end_layout
-
-\begin_layout Paragraph
-Selecting the document class
+columns:
\end_layout
\begin_layout Standard
-If you have installed Noweb and LyX successfully, whenever you open a new
- document or try to change the document class of an existing one, you will
- find that there are three new document classes available:
-\end_layout
-
-\begin_layout Itemize
-Article (Noweb)
-\end_layout
-
-\begin_layout Itemize
-Book (Noweb)
-\end_layout
-
-\begin_layout Itemize
-Report (Noweb)
-\end_layout
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout Standard
-You must select one of them to create your literate documents from.
-
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-Note that literate documents are not limited to these three classes.
- New classes can be generated from other styles like letter or in combination
- with other class variations like Article (AMS).
- If you have special needs that cannot be covered by one of the existing
- classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
- will arrange to insert a new entry, or teach you how to do it.
-\begin_inset Foot
-status collapsed
+\size footnotesize
+\begin_inset Argument 1
+status open
\begin_layout Plain Layout
-It is very simple, it involves the creation of a file with four lines, and
- re-running of the auto configuration.
+3
\end_layout
\end_inset
- Moreover, if you use a literate tool other than Noweb you may need to create
- a new set of document classes for it.
-\end_layout
-
-\begin_layout Paragraph
-Typing code in
+It can be imagined that my close intimacy with Sherlock Holmes had interested
+ me deeply in crime, and that after his disappearance I never failed to
+ read with care the various problems which came before the public.
+ And I even attempted, more than once, for my own private satisfaction,
+ to employ his methods in their solution, though with indifferent success.
+ There was none, however, which appealed to me like this tragedy of Ronald
+ Adair.
+ As I read the evidence at the inquest, which led up to a verdict of willful
+ murder against some person or persons unknown, I realized more clearly
+ than I had ever done the loss which the community had sustained by the
+ death of Sherlock Holmes.
+ There were points about this strange business which would, I was sure,
+ have specially appealed to him, and the efforts of the police would have
+ been supplemented, or more probably anticipated, by the trained observation
+ and the alert mind of the first criminal agent in Europe.
+ All day, as I drove upon my round, I turned over the case in my mind and
+ found no explanation which appeared to me to be adequate.
+ At the risk of telling a twice-told tale, I will recapitulate the facts
+ as they were known to the public at the conclusion of the inquest.
\end_layout
-\begin_layout Standard
-LyX enables you to write code with a layout named
-\noun on
-Scrap
-\noun default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The equivalent Noweb term is
-\begin_inset Quotes eld
-\end_inset
-
-Chunk
-\begin_inset Quotes erd
-\end_inset
-
-.
- For historical reasons, I got used to the term
-\begin_inset Quotes eld
\end_inset
-scrap
-\begin_inset Quotes erd
-\end_inset
- introduced by other literate tool named Nuweb, which I used for many years
- before rendering myself to Noweb.
\end_layout
+\begin_layout Standard
+You can have up to 10
+\begin_inset space ~
\end_inset
- Noweb delimits scraps like this:
+columns if you want to, but that might not be very pleasant for the readers
+ of your document.
\end_layout
-\begin_layout LyX-Code
-<<My scrap>>=
-\end_layout
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
-\begin_layout LyX-Code
- code
-\end_layout
-\begin_layout LyX-Code
- more code
\end_layout
-\begin_layout LyX-Code
- even more code
+\begin_layout Subsection
+Columns inside Columns
\end_layout
-\begin_layout LyX-Code
- @
+\begin_layout Standard
+You can also have columns inside columns:
\end_layout
\begin_layout Standard
-The problem is that whatever is written in between the << and the
-\family typewriter
-@
-\family default
- must be taken literally, i.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_inset Flex Multiple Columns
+status open
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Plain Layout
-LyX should be prevented from making any special interpretation of what has
- been written.
- This is handled by a special layout named Scrap, that works like a normal
- paragraph but has a free spacing capability.
+\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
-The down side of the Scrap paragraph layout is that consecutive paragraphs
- of code will be spaced with one empty line in the source code and also
- in the printed documentation.
- The work around is to enter each line of code within a single Scrap, with
- a newline (ctrl-return).
- The example above will look like this:
-\begin_inset Foot
-status collapsed
+\begin_layout Plain Layout
+\begin_inset Flex Multiple Columns
+status open
\begin_layout Plain Layout
-If you have a printed version of this document you will not see any difference
- between the previous example and this one.
+
+\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
\end_inset
\end_layout
-\begin_layout LyX-Code
-<<My scrap>>=
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
- code
-\begin_inset Newline newline
-\end_inset
+\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.
- more code
-\begin_inset Newline newline
-\end_inset
+\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
- even more code
-\begin_inset Newline newline
\end_inset
- @
+
+\end_layout
+
+\begin_layout Subsection
+Advanced Examples
\end_layout
\begin_layout Standard
-This layout works fine.
- The only real inconvenience is that you have to type ctrl-return instead
- of a plain return.
-\begin_inset Foot
-status collapsed
+The examples in this section show some more special features of multiple
+ columns.
+\end_layout
-\begin_layout Plain Layout
-It is in my list of
-\begin_inset Quotes eld
-\end_inset
+\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 CommandInset citation
+LatexCommand cite
+key "multicol"
-improvements
-\begin_inset Quotes erd
\end_inset
- to fix that.
+.
\end_layout
-\end_inset
+\begin_layout Subsubsection
+Preface
+\end_layout
+\begin_layout Standard
+To add a preface text for multiple columns, set the cursor into the multicolumn
+ inset and use the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Preface
+\family default
+.
+ Write your preface text into that inset.
+\begin_inset Newline newline
+\end_inset
+This is an example with some preface text:
\end_layout
\begin_layout Standard
-As a special note, you can also use the
-\begin_inset Quotes eld
+\begin_inset VSpace bigskip
\end_inset
-%def
-\begin_inset Quotes erd
-\end_inset
- construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
-rence:
\end_layout
-\begin_layout LyX-Code
-<<My scrap>>=
-\begin_inset Newline newline
-\end_inset
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
- def some_function(args):
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
- "This is the doc string for this function."
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+And the story continues and continues and continues and continues\SpecialChar \ldots{}
- print "My args: ", args
\end_layout
-\begin_layout LyX-Code
-@ %def some_function
-\end_layout
+\end_inset
-\begin_layout Standard
-For an example of this usage and the resulting cross-reference output, look
- at the Literate python program in
-\emph on
-LIBDIR/examples/listerrors.lyx
-\emph default
- which should make this all clear.
-\end_layout
-\begin_layout Paragraph
-Generating the documentation
+\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 Standard
-At this point you already have a new document file with a proper document
- class, and with some code and text on it.
- How do I print it? The answer is simple, you select
-\family sans
-View\SpecialChar \menuseparator
-DVI,
-\family default
- etc.
- Just like you would do for a plain document.
- No special procedure is required.
-\end_layout
+\end_inset
+
-\begin_layout Standard
-To help orientate you, I will now explain what happens inside LyX:
\end_layout
-\begin_layout Enumerate
-When the
-\family sans
-Update\SpecialChar \menuseparator
-DVI
-\family default
- menu option is chosen, a LaTeX file is generated.
-
+\begin_layout Standard
+You can also use a section heading as the preface if you use a section command
+ as TeX Code.
+ For example the command
\end_layout
-\begin_deeper
\begin_layout Standard
-If the document is of any literate class the generated file will be named
- with an extension name defined by the
-\begin_inset Quotes eld
-\end_inset
-literate
-\begin_inset Quotes erd
-\end_inset
+\series bold
- format (defined in the Preferences panel), otherwise the file will have
- the usual
-\family typewriter
-.tex
-\family default
- extension.
+\backslash
+subsection{subsection title}
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Note that the only difference so far is in the name of the file, no special
- processing is required by LyX.
- Given that you formatted the code using the Scrap layout that, by itself,
- takes care of the business.
+\begin_layout Standard
+creates a subsection.
+ In this example the preface is a subsubsection:
\end_layout
-\begin_layout Enumerate
-If the document is of any literate class LyX will then use the internal
- LyX to Noweb converter, followed by the Noweb to LaTeX converter
-\begin_inset Foot
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
+
+\begin_layout Plain Layout
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-The converters are defined in the
-\family sans
-Tools\SpecialChar \menuseparator
-Preferences
-\family default
- panel, under the
-\begin_inset Quotes eld
-\end_inset
-Conversion
-\begin_inset Quotes erd
-\end_inset
- tab.
- See section
-\emph on
-Converters
-\emph default
- of the
-\emph on
-Customization
-\emph default
- manual for general information about converters.
+\backslash
+subsubsection{
\end_layout
\end_inset
- to generate the LaTeX file.
-\end_layout
+This is a subsubsection heading as a preface
+\begin_inset ERT
+status collapsed
-\begin_deeper
-\begin_layout Standard
-Otherwise it will just skip this step.
-\end_layout
+\begin_layout Plain Layout
-\end_deeper
-\begin_layout Enumerate
-Finally, LaTeX is invoked and the regular post processing continues as in
- a plain document.
+}
\end_layout
-\begin_layout Standard
-Independence from a particular
-\begin_inset Quotes eld
-\end_inset
-
-literate tool
-\begin_inset Quotes erd
\end_inset
- is easily achieved by changing the commands that are run by the various
- converters.
-\end_layout
-\begin_layout Paragraph
-Generating the code
\end_layout
-\begin_layout Standard
-When the build menu option is chosen or the corresponding button in the
- toolbar is pressed, a LaTeX file is generated just like step 1 above.
- Next, LyX invokes the
-\family typewriter
-Noweb->Program
-\family default
- converter.
- This converter needs to be defined by the user and is not installed by
- default, though the Program format is.
- This converter (like any other converter) will have two parts:
-\end_layout
+\end_inset
-\begin_layout Enumerate
-The converter program itself.
- This program performs the conversion from the one format to the other (in
- this case, from the Noweb format to the Program pseudo-format).
+
+\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 Enumerate
-The error log parser.
- This is a program whose sole purpose is to rewrite error messages in a
- format that LyX understands.
- This makes it possible for LyX to place error boxes in the right places
- in the file buffer.
+\end_inset
+
+
\end_layout
\begin_layout Standard
-The first part, the
-\begin_inset Quotes eld
+If there is less vertical space than 6
+\begin_inset space ~
\end_inset
-Converter
-\begin_inset Quotes erd
+text lines is left on the page at the beginning of the multiple columns,
+ 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 space.
+ This is done by setting the cursor into the mulitcolumn inset behind the
+ preface (if there is any) and using the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Space
+\begin_inset space ~
\end_inset
- setting, should be set to
-\begin_inset Quotes eld
+Before
+\begin_inset space ~
\end_inset
+Page
+\begin_inset space ~
+\end_inset
-\family typewriter
-build-script $$i
+Break
\family default
+.
+ Insert into that inset the amount of space like e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-.
- This basically means that LyX will call
+
\begin_inset Quotes eld
\end_inset
-build-script
+5cm
\begin_inset Quotes erd
\end_inset
- (a program or script) with the name of the Noweb file (normally a file
- in the LyX temp directory).
-
-\end_layout
+.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-This is an implementation of
+In this example the space is set to 7
+\begin_inset space ~
+\end_inset
+
+text lines by using
\begin_inset Quotes eld
\end_inset
-build-script
+7
+\backslash
+baselineskip
\begin_inset Quotes erd
\end_inset
- that you can place in a directory on your path:
-\end_layout
+ (where the command
+\series bold
-\begin_layout LyX-Code
-#!/bin/sh
+\backslash
+baselineskip
+\series default
+ needs to be inserted as TeX code):
\end_layout
-\begin_layout LyX-Code
-#
-\end_layout
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout LyX-Code
-notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
+\begin_layout Plain Layout
+\begin_inset Argument 3
+status open
+
+\begin_layout Plain Layout
+7
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+baselineskip
\end_layout
-\begin_layout Standard
-The next part of the converter setting is the
-\begin_inset Quotes eld
\end_inset
-Flags
-\begin_inset Quotes erd
-\end_inset
- which is to be set to
-\begin_inset Quotes eld
+\end_layout
+
\end_inset
-\family typewriter
-parselog=listerrors
-\family default
+\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_inset Quotes erd
\end_inset
+
+\end_layout
+
+\begin_layout Subsubsection
+Surrounding Space
+\end_layout
+
+\begin_layout Standard
+The amount of space before and after multiple columns can be changed by
+ changing the length
+\series bold
+
+\backslash
+multicolsep
+\series default
.
- This will run any errors that are generated by the
-\begin_inset Quotes eld
-\end_inset
+ For example the command
+\end_layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
- process through the
-\begin_inset Quotes eld
+\series bold
+
+\backslash
+setlength{
+\backslash
+multicolsep}{3cm}
+\end_layout
+
+\begin_layout Standard
+in TeX Code changes its value to 3
+\begin_inset space \thinspace{}
\end_inset
-listerrors
-\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
- program.
+pt.
\end_layout
\begin_layout Standard
-The converter code looks in
-\emph on
-MYLYXDIR/scripts
-\emph default
- first, then in
-\emph on
-LIBDIR/scripts
-\emph default
- then on the path for the
-\begin_inset Quotes eld
-\end_inset
+For this example
+\series bold
-listerrors
-\begin_inset Quotes erd
+\backslash
+multicolsep
+\series default
+ was set to 2.5
+\begin_inset space \thinspace{}
\end_inset
- program.
+cm:
\end_layout
\begin_layout Standard
-The build will normally take place in LyX's temporary directory, so the
- files produced by the conversion will be in that directory.
- LyX will copy out what it regards as the `main' file, but the
-\family typewriter
-Noweb->Program
-\family default
- conversion may produce several files, and so most of these would then be
- deleted when LyX was closed.
- The present solution is to use a `copier',
-\begin_inset Foot
-status collapsed
+\begin_inset ERT
+status open
\begin_layout Plain Layout
-See section
-\emph on
-Copiers
-\emph default
- of the
-\emph on
-Customization
-\emph default
- manual for information on these.
+
+
+\backslash
+setlength{
+\backslash
+multicolsep}{2.5cm}
\end_layout
\end_inset
- in this case, the
-\family typewriter
-ext_copy.py
-\family default
- script in its default mode, so that the entire contents of the temporary
- directory is copied.
- More will get copied than is needed, to be sure, but nothing will be lost.
- If, however, you know what extensions the generated files will have, this
- can be improved by using the
-\family typewriter
--e
-\family default
- option to
-\family typewriter
-ext_copy
-\family default
-.
- This option takes a comma-separated list of extensions to copy.
- So, for example, if the conversion will generate only files with the extensions
-
-\family typewriter
-.c
-\family default
- and
-\family typewriter
-.h
-\family default
-, then the correct definition would be:
-\end_layout
-\begin_layout LyX-Code
-python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
\end_layout
\begin_layout Standard
-The result will be that only files with these two extensions will be copied
- out.
-\end_layout
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout Paragraph
-Build instructions in the document
+\begin_layout Plain Layout
+
+\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
-\begin_layout Standard
-The last piece of the integration between LyX and noweb is the
-\begin_inset Quotes eld
\end_inset
-build-script
-\begin_inset Quotes erd
-\end_inset
- scrap.
- Generally, the instructions for building your program should be embedded
- in a scrap of its own.
- The noweb-specific
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
- above uses the notangle command to look for this scrap (called
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\series bold
+Note:
+\series default
+ The values you set with
+\series bold
-) and runs its contents through
-\begin_inset Quotes eld
-\end_inset
+\backslash
+setlength
+\series default
+ will be used for all following multiple columns until you change them again.
+\end_layout
-sh
-\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-\begin_layout Standard
-Typically, such a scrap would look something like this:
\end_layout
-\begin_layout LyX-Code
-<<build-script>>=
-\begin_inset Newline newline
-\end_inset
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
-#!/bin/sh
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
-\begin_inset Newline newline
-\end_inset
+\backslash
+setlength{
+\backslash
+multicolsep}{13pt}
+\end_layout
-if [ -z "${NOWEB_SOURCE}" ]
-\begin_inset Newline newline
\end_inset
-then
-\begin_inset Newline newline
-\end_inset
- NOWEB_SOURCE=myfile.nw
-\begin_inset Newline newline
-\end_inset
+\begin_inset Note Note
+status collapsed
-fi
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+go back to the default
+\end_layout
-[...
- code to extract files ...]
-\begin_inset Newline newline
\end_inset
-[...
- code to compile files ...]
-\begin_inset Newline newline
-\end_inset
-@
\end_layout
\begin_layout Standard
-Look in
-\emph on
-LIBDIR/examples/listerrors.lyx
-\emph default
- or in
-\emph on
-LIBDIR/examples/Literate.lyx
-\emph default
- which implement two versions of the
-\begin_inset Quotes eld
+\begin_inset Newpage newpage
\end_inset
-listerrors
-\begin_inset Quotes erd
-\end_inset
-
- program for some illustrations of how all of these pieces go together or
- in
-\emph on
-LIBDIR/examples/noweb2lyx.lyx.
-\emph default
- Interestingly, these three files show off the language-indepence of the
- LyX literate programming support since they are written in Python, C and
- Perl respectively.
\end_layout
\begin_layout Subsubsection
-Configuring LyX
+Column Breaks
\end_layout
\begin_layout Standard
-All the Literate Programming support is configured by the
-\family sans
-Tools\SpecialChar \menuseparator
-Preferences
-\family default
- panel in the
-\begin_inset Quotes eld
-\end_inset
+A column break can be forced by inserting the command
+\series bold
-Conversion
-\begin_inset Quotes erd
+\backslash
+columnbreak{}
+\series default
+ as TeX-Code to that position in the text where the column should be broken.
+ Note that this leads in most cases to whitespace in the text.
+\begin_inset Newline newline
\end_inset
- tab.
- The important parts are:
+Here is an example:
\end_layout
-\begin_layout Description
-the
-\begin_inset space ~
-\end_inset
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+\begin_layout Plain Layout
+\size small
\begin_inset Quotes eld
\end_inset
-literate
+You're surprised to see me, sir,
\begin_inset Quotes erd
\end_inset
+ said he, in a strange, croaking voice.
+\end_layout
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
-format Set up via the Formats tab, this is where the Noweb-specific pieces
- are set up.
- The
-\family sans
-GUI Name
-\family default
- is set to
-\family typewriter
-NoWeb
-\family default
-, the file extension is set to
-\family typewriter
-.nw
-\family default
-.
- This tells LyX to create a file with a
-\family typewriter
-.nw
-\family default
- extension in the first step of the conversion process.
+\size small
+I acknowledged that I was.
\end_layout
-\begin_layout Description
-the
-\begin_inset space ~
-\end_inset
-
+\begin_layout Plain Layout
-\family sans
-Program
-\family default
+\size small
+\begin_inset Quotes eld
+\end_inset
-\begin_inset space ~
+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
-format This is an empty format whose sole purpose is to be the endpoint
- of a conversion (which then allows us to set up a converter for it).
+
\end_layout
-\begin_layout Description
+\begin_layout Plain Layout
-\family sans
-NoWeb
-\family default
-->
-\family sans
-LaTeX
-\family default
- This converter performs the
+\size small
\begin_inset Quotes eld
\end_inset
-weaving
+You make too much of a trifle,
\begin_inset Quotes erd
\end_inset
- of the literate document.
- For Noweb, it is set to
+ said I.
+
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-noweave -delay -index $$i > $$o
-\family default
-
+May I ask how you knew who I was?
\begin_inset Quotes erd
\end_inset
+ AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
+\begin_inset ERT
+status collapsed
-\end_layout
-
-\begin_layout Description
+\begin_layout Plain Layout
-\family sans
-NoWeb
-\family default
-->
-\family sans
-Program
-\family default
- This performs the
-\begin_inset Quotes eld
-\end_inset
-tangling step
-\begin_inset Quotes erd
-\end_inset
+\backslash
+columnbreak{}
+\end_layout
-.
- As stated above, the Converter is set to
-\begin_inset Quotes eld
\end_inset
-\family typewriter
-build-script $$i
-\family default
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-, with Flags set to
+\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
-originaldir,parselog=listerrors
-\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
-.
-\end_layout
-\begin_layout Subsubsection
-Debug extensions
\end_layout
-\begin_layout Standard
-There is also a new function implemented in the LyX server, the
-\begin_inset Quotes eld
\end_inset
-server-goto-file-row" function, to be used with ddd/gdb or other debugger.
-
+
\end_layout
-\begin_layout Standard
-When debugging code with ddd/gdb, it is possible to invoke a text editor
- at the current execution position with a single key stroke.
- The default ddd configuration for that is shift-ctrl-V.
- It happens that you can define the editor command line invocation in ddd
- by accessing the
-\family sans
-Edit\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Helpers
-\family default
- dialog and changing the "Edit Sources" entry.
+\begin_layout Subsubsection
+Column Separation
\end_layout
\begin_layout Standard
-I take advantage of the new created LyX server function and this ddd feature,
- and set
-\begin_inset Quotes eld
-\end_inset
+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
-Edit Sources
-\begin_inset Quotes erd
+\backslash
+columnsep
+\series default
+.
+ Its predefined value is 10
+\begin_inset space \thinspace{}
\end_inset
- to:
-\end_layout
+pt.
+ Here is an example where
+\series bold
-\begin_layout LyX-Code
-echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
-\end_layout
+\backslash
+columnsep
+\series default
+ is set to 3
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-With this, whenever you are using ddd and find a point in the program that
- you want to edit, you just press shift-ctrl-V (in the ddd window), and
- ddd you forward this information to LyX through the LyX server and then
- the LyX window will show the same file with the cursor at the same position
- ddd was pointing to.
- No more guessing or long scrolling to locate a point in the program back
- from debugging !
+cm:
\end_layout
\begin_layout Standard
-Note however that you must enable the LyX server to get this feature working
- (it is disabled by default).
- You can enable it in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Inputs
-\family default
-,
-\family sans
-Paths
-\family default
-) by entering in the
-\family sans
-LyXserver pipe
-\family default
- a path like
-\begin_inset Quotes eld
-\end_inset
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
-\family typewriter
-/home/<your-home-directory>/.lyx/lyxpipe
-\family default
-\begin_inset Quotes erd
+\backslash
+setlength{
+\backslash
+columnsep}{3cm}
+\end_layout
+
\end_inset
\end_layout
\begin_layout Standard
-Read the LyX server documentation in the
-\emph on
-Customization Manual
-\emph default
- for further information.
-\end_layout
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout Subsubsection
-Toolbar extensions
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-There are six new buttons that can be added to your LyX toolbar.
- Five of these buttons are short cuts to layout styles:
-\family sans
-Standard
-\family default
-,
-\family sans
-Section
-\family default
-,
-\family sans
-LaTeX
-\family default
-,
-\family sans
-LyX-Code
-\family default
-, and
-\family sans
-Scrap
-\family default
-.
- The last one is a short cut to the
-\begin_inset Quotes eld
+\size small
+My observations of No.
+\begin_inset space \space{}
\end_inset
-Build Program
-\begin_inset Quotes erd
+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
+
\end_inset
- File menu entry.
-
+
\end_layout
\begin_layout Standard
-LyX has a range of buttons that are available for tool bar customization.
- In my toolbar I like to combine the six short cuts above with two more:
- One for
-\family sans
-View
-\family default
-\SpecialChar \menuseparator
+\begin_inset ERT
+status collapsed
-\family sans
-Update
-\family default
-\SpecialChar \menuseparator
+\begin_layout Plain Layout
-\family sans
-DVI
-\family default
- and the other for
-\family sans
-View\SpecialChar \menuseparator
-DVI
-\family default
- File menu entries.
- Here is how it looks like:
-\end_layout
-\begin_layout LyX-Code
-Toolbar
+\backslash
+setlength{
+\backslash
+columnsep}{10pt}
\end_layout
-\begin_layout LyX-Code
- Layouts
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- Icon "layout Standard"
-\end_layout
-\begin_layout LyX-Code
- Icon "layout Section"
-\end_layout
+\begin_inset Note Note
+status collapsed
-\begin_layout LyX-Code
- Icon "layout LaTeX"
+\begin_layout Plain Layout
+go back to the default
\end_layout
-\begin_layout LyX-Code
- Icon "layout LyX-Code"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- Icon "layout Scrap"
-\end_layout
-\begin_layout LyX-Code
- Separator
\end_layout
-\begin_layout LyX-Code
- Icon "buffer-view"
+\begin_layout Subsubsection
+Vertical Lines
\end_layout
-\begin_layout LyX-Code
- Icon "buffer-typeset"
-\end_layout
+\begin_layout Standard
+Between the columns a rule with a width of the length
+\series bold
-\begin_layout LyX-Code
- Icon "build-program"
-\end_layout
+\backslash
+columnseprule
+\series default
+ is placed.
+ If this rule width is set to 0
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
- Separator
-\end_layout
+pt (this is the default), the rule is suppressed.
+ In the following example the rule is 2
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-.
+pt wide:
\end_layout
-\begin_layout LyX-Code
-.
-\end_layout
+\begin_layout Standard
+\begin_inset ERT
+status open
-\begin_layout LyX-Code
-.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-End
+
+\backslash
+setlength{
+\backslash
+columnseprule}{2pt}
\end_layout
-\begin_layout Subsubsection
-Colors customization
+\end_inset
+
+
\end_layout
\begin_layout Standard
-There are a number of colors in LyX that can be customized in
-\family sans
-Preferences
-\family default
-.
- One of the things that bothers people is the LaTeX font color.
- The default color is red, since the scraps uses LaTeX font, and there is
- a lot of scraps in literate documents, you may get tired of seeing everything
- in red.
- You can change it by going to the tabs
-\family sans
-Look&Feel
-\family default
-,
-\family sans
-Colors.
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+
+ said he, in a strange, croaking voice.
\end_layout
-\begin_layout Standard
-The next thing is the visible presence of the newline character in the screen.
- You can choose the color of this particular character and make it blend
- in the background.
- I recommend you choosing a color that is close to the background but not
- equal, that way you still can see it is there, but it is not bothering
- you anymore.
-
+\begin_layout Plain Layout
+
+\size small
+I acknowledged that I was.
\end_layout
-\begin_layout Chapter
-Secrets of the LaTeX Masters
-\begin_inset CommandInset label
-LatexCommand label
-name "cha:secrets"
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+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
\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_layout Plain Layout
+
+\size small
\begin_inset Quotes eld
\end_inset
-TeX
+You make too much of a trifle,
\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.
+ said I.
-\emph on
-Do try this at home
-\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.
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Section
-Multiple Columns
-\end_layout
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-by
-\noun on
-Lars Gullik Bjønnes
-\end_layout
-\begin_layout Subsection
-Purpose
\end_layout
-\begin_layout Standard
-The aim for this chapter
-\begin_inset Foot
-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
-\end_layout
+\size small
+\begin_inset Quotes eld
\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
-\end_layout
+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
+
+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
-\begin_layout Standard
-The
-\family typewriter
-multicol
-\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
+\end_inset
+
+
\end_layout
\begin_layout Standard
-If you want to have two columns in your text, you have use LaTeX mode to
- insert
-\family typewriter
+\begin_inset VSpace defskip
+\end_inset
-\backslash
-begin{multicols}{2}
-\family default
- at the point where you want the two column layout to start, and then
-\family typewriter
-\backslash
-end{multicols}
-\family default
- where you want it to end.
- Like this:
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+The rule can be colored by redefining the command
+\series bold
+
+\backslash
+columnseprulecolor
+\series default
+.
+ This is done by inserting the command
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
+\series bold
\backslash
-begin{multicols}{2}
-\end_layout
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{red}}
+\series default
+\begin_inset Newline newline
\end_inset
+as TeX-Code before the multicolumn inset.
+ Replace
+\series bold
+red
+\series default
+ in this command by a color of your choice.
+ You can use all pre- and self-defined colors.
+ See the
+\emph on
+EmbeddedObjects
+\emph default
+ manual, section
+\emph on
+Colored
+\begin_inset space ~
+\end_inset
-\end_layout
+Tables
+\emph default
+ for more information about pre- and self-defined colors.
+ To go back to the default color insert the command
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-\noindent
\series bold
-\size small
-The Adventure of the Empty House
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
\series default
\begin_inset Newline newline
\end_inset
-by
-\noun on
-Sir Arthur Conan Doyle
-\end_layout
-
-\begin_layout Standard
+Here is the example with a cyan rule and 1
+\begin_inset space \thinspace{}
+\end_inset
-\size small
-It was in the spring of the year 1894 that all London was interested, and
- the fashionable world dismayed, by the murder of the Honourable Ronald
- Adair under most unusual and inexplicable circumstances.
- The public has already learned those particulars of the crime which came
- out in the police investigation, but a good deal was suppressed upon that
- occasion, since the case for the prosecution was so overwhelmingly strong
- that it was not necessary to bring forward all the facts.
- Only now, at the end of nearly ten years, am I allowed to supply those
- missing links which make up the whole of that remarkable chain.
- The crime was of interest in itself, but that interest was as nothing to
- me compared to the inconceivable sequel, which afforded me the greatest
- shock and surprise of any event in my adventurous life.
- Even now, after this long interval, I find myself thrilling as I think
- of it, and feeling once more that sudden flood of joy, amazement, and increduli
-ty which utterly submerged my mind.
- Let me say to that public, which has shown some interest in those glimpses
- which I have occasionally given them of the thoughts and actions of a very
- remarkable man, that they are not to blame me if I have not shared my knowledge
- with them, for I should have considered it my first duty to do so, had
- I not been barred by a positive prohibition from his own lips, which was
- only withdrawn upon the third of last month.
+cm column separation:
\end_layout
\begin_layout Standard
\backslash
-end{multicols}
+setlength{
+\backslash
+columnsep}{1cm}
\end_layout
-\end_inset
+\begin_layout Plain Layout
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{cyan}}
\end_layout
-\begin_layout Subsubsection
-Multiple columns
-\end_layout
+\end_inset
+
-\begin_layout Standard
-The same pattern is used when you want more than two columns:
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Flex Multiple Columns
status open
\begin_layout Plain Layout
-
-\backslash
-begin{multicols}{3}
-\end_layout
-
+\size small
+\begin_inset Quotes eld
\end_inset
+You're surprised to see me, sir,
+\begin_inset Quotes erd
+\end_inset
+ said he, in a strange, croaking voice.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
-\size footnotesize
-It can be imagined that my close intimacy with Sherlock Holmes had interested
- me deeply in crime, and that after his disappearance I never failed to
- read with care the various problems which came before the public.
- And I even attempted, more than once, for my own private satisfaction,
- to employ his methods in their solution, though with indifferent success.
- There was none, however, which appealed to me like this tragedy of Ronald
- Adair.
- As I read the evidence at the inquest, which led up to a verdict of willful
- murder against some person or persons unknown, I realized more clearly
- than I had ever done the loss which the community had sustained by the
- death of Sherlock Holmes.
- There were points about this strange business which would, I was sure,
- have specially appealed to him, and the efforts of the police would have
- been supplemented, or more probably anticipated, by the trained observation
- and the alert mind of the first criminal agent in Europe.
- All day, as I drove upon my round, I turned over the case in my mind and
- found no explanation which appeared to me to be adequate.
- At the risk of telling a twice-told tale, I will recapitulate the facts
- as they were known to the public at the conclusion of the inquest.
+\size small
+I acknowledged that I was.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
\begin_layout Plain Layout
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+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
+
-\backslash
-end{multicols}
\end_layout
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
\end_inset
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-You can have more than 3 columns if you want to, but that might not be very
- pleasant for the eye.
-\end_layout
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsubsection
-Columns inside columns
-\end_layout
-\begin_layout Standard
-You can even have columns inside columns:
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
\begin_layout Plain Layout
+\size small
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+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
+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
\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}
+setlength{
+\backslash
+columnseprule}{0pt}
\end_layout
-\end_inset
+\begin_layout Plain Layout
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
\end_layout
-\begin_layout Standard
+\end_inset
-\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 Standard
-\begin_inset ERT
-status open
+\begin_inset Note Note
+status collapsed
\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
+go back to the default
\end_layout
\end_inset
\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.
+\begin_layout Section
+Non-standard Paragraph Shapes
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
+\noindent
+LaTeX as well as any other text processor uses by default rectangular paragraphs.
+ For special cases like for example posters, invitation cards or poems you
+ can modify the paragraph shape to one of your choice.
+ This can be done by using the LaTeX-package
+\series bold
+shapepar
+\series default
+ which is loaded by using in the document settings the module
+\family sans
+Custom paragraph shapes
+\family default
+.
\end_layout
-\end_inset
+\begin_layout Subsection
+Predefined shapes
+\end_layout
+\begin_layout Standard
+\series bold
+shapepar
+\series default
+ provides the following shapes:
\end_layout
\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.
+\begin_inset Tabular
+<lyxtabular version="3" rows="13" columns="3">
+<features rotate="0" booktabs="true" islongtable="true" longtabularalignment="center">
+<column alignment="center" valignment="middle" width="16col%">
+<column alignment="center" valignment="middle" width="40col%">
+<column alignment="center" valignment="middle" width="35col%">
+<row endhead="true">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Name
\end_layout
-\begin_layout Section
-Numbering in the
-\family sans
-Enumerate
-\family default
- Paragraph Environment
-\begin_inset OptArg
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Numbering in Enumerate
+Description
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-
+\begin_layout Plain Layout
+Annotation
\end_layout
-\begin_layout Standard
-by
-\noun on
-John Weiss
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+CDlabel
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-
+\begin_layout Plain Layout
+Circle with circular hole (in the size of a CD/DVD)
\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:
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Cannot be scaled, take care there is not too much text
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-Roman{enumi}.}
+\begin_layout Plain Layout
+Circle
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumii}.}
+\begin_layout Plain Layout
+Circle
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-arabic{enumiii}.}
+\begin_layout Plain Layout
+Fragile, calculation might fail
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumiv}{
-\backslash
-alph{enumiv}.)}
+\begin_layout Plain Layout
+Diamond
\end_layout
-\begin_layout Standard
-\SpecialChar \ldots{}
- which changes the numbering scheme to uppercase Roman numerals, uppercase
- letters, Arabic numbers, and lowercase letter.
-\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\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_layout Plain Layout
+Rhomboid (symbolizing a
\begin_inset Quotes eld
\end_inset
-I.
+diamond
\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
-\end_inset
+)
+\end_layout
-I.
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
-,
-\begin_inset space ~
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Heart
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Heart-like shape
+\end_layout
-A.
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
-,
-\begin_inset space ~
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Hexagon
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Hexagon
+\end_layout
-1.
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
-,
-\begin_inset space ~
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Nut
+\end_layout
-\begin_inset Quotes eld
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Nut for bolt (hexagon with circular hole)
+\end_layout
-a.)
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
->.
-
+\begin_layout Plain Layout
+-
\end_layout
-\begin_layout Standard
-As you can see in the example, there is a label command for each nesting
- level,
-\family typewriter
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-labelenumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
+\begin_layout Plain Layout
+Square
+\end_layout
-\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
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Square
+\end_layout
-number printing
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
- commands,
-\family typewriter
+\begin_layout Plain Layout
+-
+\end_layout
-\backslash
-arabic{}
-\family default
-,
-\family typewriter
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-roman{}
-\family default
-,
-\family typewriter
+\begin_layout Plain Layout
+Star
+\end_layout
-\backslash
-Roman{}
-\family default
-,
-\family typewriter
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-alph{}
-\family default
-, and
-\family typewriter
+\begin_layout Plain Layout
+Five-point star
+\end_layout
-\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_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
\end_layout
-\begin_layout Standard
-You can get really fancy with these.
- For example:
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Candle
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-#
-\backslash
-Alph{enumi}
-\backslash
-#}
+\begin_layout Plain Layout
+Burning candle
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumi}.
-\backslash
-arabic{enumii}}
+\begin_layout Plain Layout
+-
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-alph{enumiii}+}
+\begin_layout Plain Layout
+Drop down/up
\end_layout
-\begin_layout LyX-Code
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-renewcommand{
-\backslash
-labelenumiv}{(
-\backslash
-roman{enumiv})}
+\begin_layout Plain Layout
+Normal/reversed rain drop
\end_layout
-\begin_layout Standard
-produces the somewhat out of hand numbering scheme: <
-\begin_inset Quotes eld
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Fragile, calculation might fail
+\end_layout
-#A#
-\begin_inset Quotes erd
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+TeX
+\end_layout
-,
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+The TeX logo
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+-
+\end_layout
-A.1
-\begin_inset Quotes erd
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-,
-\begin_inset space ~
+\begin_layout Plain Layout
+Triangle up/down/
+\begin_inset Newline newline
\end_inset
+left/right
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-a+
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Triangles in different orientations
+\end_layout
-,
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+-
+\end_layout
-\begin_inset Quotes eld
\end_inset
+</cell>
+</row>
+</lyxtabular>
-(i)
-\begin_inset Quotes erd
\end_inset
->.
-
+
\end_layout
\begin_layout Standard
-
+To use a shape for your paragraph, simply select it in LyX's pull-down box
+ for environments in the toolbar.
\end_layout
-\begin_layout Section
-Dropped Capitals
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
\end_layout
\begin_layout Standard
-by
-\noun on
-Mike Ressler
+Here is an example paragraph in the shape of a nut:
\end_layout
\begin_layout Standard
\end_layout
-\begin_layout Standard
-\noindent
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
+\begin_layout Nut
-\backslash
-newfont{
-\backslash
-tmpfont}{cmr17 scaled 2500}{
-\backslash
-tmpfont T}
-\backslash
-vspace*{-8.4ex}
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-\noindent
-\begin_inset ERT
+\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
-
-\backslash
-hangindent=3.3em
-\backslash
-hangafter=-3
+\series bold
+Note
+\series default
+: shapepar paragraphs cannot run over a page break.
\end_layout
\end_inset
- hose of you who like the style of old books probably also like
-\begin_inset Quotes eld
-\end_inset
-
-dropped capitals
-\begin_inset Quotes erd
-\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.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
+\begin_inset VSpace bigskip
+\end_inset
-\backslash
-verb+
-\backslash
-bigdrop{-1em}{3}{ptmri}{T}+
\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
+\begin_layout Standard
+\series bold
+shapepar
+\series default
+ takes care that the shape will always be preserved, no matter how much
+ text is in the paragraph.
+ Therefore the paragraph size changes with the amount of contained text.
+ This can lead to paragraph sizes exceeding the page margins.
+ To demonstrate the size scaling, here is the same example paragraph but
+ with twice as much text:
+\end_layout
-\family typewriter
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
-\backslash
-verb
-\family default
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- and the pluses from the TeX code at the beginning of the paragraph, and
- add
-\family typewriter
+\begin_layout Nut
-\backslash
-usepackage{dropcaps}
-\family default
- to your LaTeX preamble, you will get a nice Times Roman Italic
-\begin_inset Quotes eld
-\end_inset
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+\end_layout
-T
-\begin_inset Quotes erd
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
-, whose height is three lines of text and which protrudes 1 em into the
- margin.
- (Make certain you have copied
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-\family typewriter
-dropcaps.sty
+\begin_layout Standard
+An exception is the shape
+\family sans
+CDlabel
\family default
-
-\begin_inset Quotes erd
+.
+ It cannot be scaled because it must fit the size of a CD/DVD.
+ Therefore the amount of text that fits into the shape is limited.
+\begin_inset Newline newline
\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
+The
+\family sans
+drop
+\family default
+ shapes and the
+\family sans
+circle
\family default
- directory for possibilities).
- My personal favorite is
+ shape are fragile, meaning that the calculation of their size can fail,
+ depending on the amount of text.
+ You will then get the LaTeX error
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-yinit
-\family default
-
+Arithmetic overflow
\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
-
-\backslash
-dropping
-\family default
- command.
-\end_layout
-
-\begin_layout Section
-Non-standard Paragraph Shapes
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+
+.
+ In this case one can try to remove or add some text; if nothing works one
+ has to use another shape.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+For shapes with tips you will maybe see that LaTeX's hyphenation routine
+ fails for text in the tips.
+ Therefore it is often necessary to add hyphenation points
+\family sans
+(
+\begin_inset Info
+type "shortcut"
+arg "specialchar-insert hyphenation"
+\end_inset
-\backslash
-begin{sloppypar}
+\family default
+) to the corresponding text parts.
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
+Shapepar paragraphs are either always centered or placed on the page so
+ that their left border touches the left page margin.
+ You can therefore not use the paragraph dialog to align such paragraphs.
+ A solution is to put the paragraph into a minipage or parbox and align
+ the box.
+ The problem is hereby to find the right width for the box.
+ Because if it is too wide and you center the box, the paragraph is not
+ centered too because it sticks at the left side of the box.
+ So you might have to play a bit with the width until it fits.
+ Here are two heart-shaped paragraphs, the first one is not aligned, the
+ second one is right-aligned:
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
-\backslash
-newdimen
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
-
+\begin_layout Heart
+\noindent
-\backslash
-setlength{
-\backslash
-varunit}{4.5in}
+\lang latin
+Lo\SpecialChar \-
+rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\begin_layout Standard
\noindent
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+\align right
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 1
+use_makebox 0
+width "42col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
+\begin_layout Heart
+\noindent
-\backslash
-parshape 19 0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
+\lang latin
+Lo\SpecialChar \-
+rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
\end_layout
-\begin_layout Plain Layout
+\end_inset
+
-0.40
-\backslash
-varunit 0.300
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Subsection
+Custom shapes
+\end_layout
-0.35
-\backslash
-varunit 0.293
-\backslash
-varunit
+\begin_layout Standard
+You can define any shape you want.
+ Doing this manually is a lot of work because every coordinate must be specified.
+ But there is a way to let the computer calculate the coordinates:
\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
+Install the program
+\begin_inset CommandInset href
+LatexCommand href
+name "Jpgfdraw"
+target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
-0.30
-\backslash
-varunit 0.300
-\backslash
-varunit
+\end_inset
+
+.
\end_layout
+\begin_layout Enumerate
+In
+\family sans
+Jpgfdraw
+\family default
+ go to the menu
+\family sans
+Te
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.25
-\backslash
-varunit 0.317
-\backslash
-varunit
+{}
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.20
-\backslash
-varunit 0.342
-\backslash
-varunit
-\end_layout
+X/LaT
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
-0.15
-\backslash
-varunit 0.373
-\backslash
-varunit
+{}
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.10
-\backslash
-varunit 0.410
-\backslash
-varunit
-\end_layout
+eX\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Set Normal Size
+\family default
+ and select the font size you are using in your document.
+ For example this document uses the size 12
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
+pt.
+\end_layout
-0.05
-\backslash
-varunit 0.453
-\backslash
-varunit
+\begin_layout Enumerate
+Draw a shape.
\end_layout
+\begin_layout Enumerate
+Use the menu
+\family sans
+Te
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.00
-\backslash
-varunit 0.500
-\backslash
-varunit
+{}
\end_layout
+\end_inset
+
+X/LaT
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.05
-\backslash
-varunit 0.453
-\backslash
-varunit
+{}
\end_layout
+\end_inset
+
+eX\SpecialChar \menuseparator
+Shapepar
+\family default
+ to export the shape to coordinates.
+ In the appearing dialog use either the outline of your shape for the coordinate
+s or the path itself.
+\begin_inset Foot
+status collapsed
+
\begin_layout Plain Layout
+For more information see
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
+
+\end_inset
+
-0.10
-\backslash
-varunit 0.410
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\end_inset
+
-0.15
-\backslash
-varunit 0.373
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+The coordinates are written into a TeX-file.
+ To use it for your LyX document
+\end_layout
-0.20
-\backslash
-varunit 0.342
-\backslash
-varunit
+\begin_layout Enumerate
+Place the cursor before the first character of your paragraph (or into a
+ new empty one).
\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
+Open in LyX the menu
+\family sans
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
-0.25
-\backslash
-varunit 0.317
-\backslash
-varunit
+Document
+\family default
+, select the file and use
+\family sans
+Input
+\family default
+ as
+\family sans
+Include Type.
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
-0.30
-\backslash
-varunit 0.300
-\backslash
-varunit
\end_layout
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
\begin_layout Plain Layout
-0.35
-\backslash
-varunit 0.293
-\backslash
-varunit
+\series bold
+Note
+\series default
+: The changed shape only applies to the current paragraph; everything is
+ reset to normal for the next paragraph.
+ Therefore the shape definition file must be input into every paragraph
+ with the desired shape.
\end_layout
-\begin_layout Plain Layout
+\end_inset
+
-0.40
-\backslash
-varunit 0.300
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
\end_layout
+\begin_layout Standard
+\begin_inset CommandInset include
+LatexCommand input
+filename "SpecialParagraphShape.tex"
+
\end_inset
-There are times when the tyranny of rectangular paragraphs must be overthrown.
- In such situations, a call to the delightful plain TeX command
-\family typewriter
-\backslash
-parshape
-\family default
- is called for.
- As you can see, completely arbitrary shapes can be laid out with a suitable
- set of linelength 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.
- which will benefit from such handcrafting.
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-The syntax is
-\family typewriter
-\backslash
-parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
- #nindent #nlength
-\family default
-, where
-\family typewriter
-numlines
-\family default
- is the number of lines of text which define the paragraph.
- If there turn out to be fewer lines, the shape is truncated; if there are
- more, the excess lines have the same dimensions as the last line of the
- definition.
- The
-\family typewriter
-#nindent
+\series bold
+A tip:
+\series default
+ to draw complexer shapes in
+\family sans
+Jpgfdraw
\family default
- and
-\family typewriter
-#nlength
+ you can draw the shape in a program of your choice and import the resulting
+ image to
+\family sans
+Jpgfdraw
\family default
- entries specify the indentation of the line from the left margin, and the
- length of the line as measured from that point.
- The shape applies only to the current paragraph; everything is reset to
- normal for the next paragraph.
+.
+ Then you only need to draw a line or spline along the outline of the image.
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The module
+\family sans
+Custom paragraph shapes
+\family default
+ also provides the two commands
+\family sans
+shapepar
+\family default
+ and
+\family sans
+Shapepar
+\family default
+ which can be used to define custom shapes coordinate by coordinate.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
+These commands are internally used for all shapes described here.
+\end_layout
+\end_inset
-\backslash
-end{sloppypar}
+ For information how these styles are used and about further customization
+ possibilities, have a look at the documentation of the package
+\series bold
+shapepar
+\series default
+,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "shapepar"
+
+\end_inset
+
+.
\end_layout
+\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
\end_layout
-\begin_layout Section
-Summary
-\end_layout
+\begin_layout Bibliography
+\begin_inset CommandInset bibitem
+LatexCommand bibitem
+key "shapepar"
+
+\end_inset
+
+Documentation of the LaTeX-package
+\begin_inset CommandInset href
+LatexCommand href
+name "shapepar"
+target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
+
+\end_inset
+
-\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_layout
\end_body
projects / lyx.git / blobdiff