-#LyX 2.0 created this file. For more info see http://www.lyx.org/
-\lyxformat 413
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 474
\begin_document
\begin_header
\textclass scrbook
\cleardoublepage
\pagenumbering{arabic}}
-% used for multi-column text
-\usepackage{multicol}
-
% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
\end_preamble
theorems-ams
theorems-ams-extended
multicol
+shapepar
\end_modules
\maintain_unincluded_children false
\begin_local_layout
\font_roman default
\font_sans default
\font_typewriter default
+\font_math auto
\font_default_family default
\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
\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"
-\papersize default
+\papersize a4paper
\use_geometry false
-\use_amsmath 1
-\use_esint 0
-\use_mhchem 1
-\use_mathdots 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
\end_layout
\begin_layout Subtitle
-Version 2.0.x
+Version 2.1.x
\end_layout
\begin_layout Author
User's Guide\SpecialChar \@.
\emph default
- The reason for separating this document out is simple: the
+ The reason for separating the two documents is simple: the
\emph on
User's Guide
\emph default
\begin_layout Plain Layout
View\SpecialChar \menuseparator
Source
+\begin_inset space ~
+\end_inset
+
+Pane
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Format
+Document\SpecialChar \menuseparator
+View
\end_layout
\end_inset
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 Standard
-If you've run LaTeX using
+If you have run LaTeX using
\begin_inset Flex MenuItem
status collapsed
\end_inset
, LyX then runs a DVI viewer to display the DVI-file.
- If you've used
+ If you have used
\begin_inset Flex MenuItem
status collapsed
TeX Code
\end_layout
+\end_inset
+
+ or the keyboard shortcut
+\begin_inset Info
+type "shortcut"
+arg "ert-insert"
\end_inset
.
\begin_inset Newline newline
\end_inset
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You
\begin_inset Newline newline
\end_inset
box containing this text is directly after this paragraph.
Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\begin_inset ERT
-status collapsed
+status open
\begin_layout Plain Layout
\begin_layout Plain Layout
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\end_layout
\end_inset
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Itemize
-Beware reinventing the wheel.
+Beware of reinventing the wheel.
\end_layout
\begin_layout Standard
\end_inset
- for details, and see chapter
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
+ for details.
\end_layout
\begin_layout Standard
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
+ In addition to providing special commands, the inclusion of a package can
+ change the document.
For example, the package
\begin_inset Flex Code
status collapsed
\begin_inset Newline newline
\end_inset
-There are several LaTeX counters and variables which
+There are several LaTeX counters and variables that
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- (There are variables which you can set and reset inside the document, too.)
- Margins are a good example of something which must be set in the preamble.
+ (There are variables that you can set and reset inside the document, too.)
+ Margins are a good example of something that must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\begin_layout Standard
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
- Also, there are more examples and an assortment of LaTeX
-\begin_inset Quotes eld
-\end_inset
-
-dirty tricks
-\begin_inset Quotes erd
-\end_inset
-
- given in Chapter
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
-
\end_layout
\begin_layout Section
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
It then uses the logfile from the LaTeX run to do a post-mortem.
- After analyzing the logfile,LyX displays a dialog listing the errors.
+ After analyzing the logfile, LyX displays a dialog listing the errors.
Clicking on any one of them will take you to the position in your LyX file
where the error occurred.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
- LaTeX Error: File
+LaTeX Error: File
\begin_inset Quotes els
\end_inset
\end_inset
-, than the established
+, then the established
\begin_inset Flex Code
status collapsed
.
You are free to use the same or different styles for each section.
- Additionally, you can chose if the bibliography section should contain
+ Additionally, you can choose if the bibliography section should contain
\begin_inset Quotes eld
\end_inset
\end_inset
- removes the bibliography title, you have manually re-add that, too (as
+ removes the bibliography title, you have to manually re-add that, too (as
a chapter* or section*, for instance).
\end_layout
\end_inset
(those commands have to be inserted as TeX code).
- The bibliography will contain all references which have been cited in the
+ The bibliography will contain all references that have been cited in the
current
\begin_inset Flex Code
status collapsed
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
+ that files that are
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- are typeset beginning on a new page, while files which are
+ are typeset beginning on a new page, while files that are
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
+g, while the included files are converted to LaTeX files that do not have
all the preamble information.
\end_layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
First, open all the files in question: let's call them A and B in a two
file example, where B is included in A.
Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
+ Open the cross-reference dialog whilst in document B, and you can select
the
\begin_inset Quotes eld
\end_inset
\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 Code
status collapsed
\begin_layout Standard
You will now see your name in the upper left.
If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer, simply include a command
+ the page number appears in the central footer) simply include a command
with a blank argument, e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Standard
The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+ The following table shows the mappings from button name to LaTeX package.
\end_layout
\begin_layout Standard
\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_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
\end_inset
- on Windows (but any working path can be used).
+ 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
\end_layout
\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
+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
+Another useful tool is the command-line based client
+\change_inserted 711066561 1405258403
+
+\change_unchanged
+found in
\begin_inset Flex Code
status collapsed
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
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
\end_layout
\begin_layout Standard
-Please note that including the
+Note that the method
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=1
+\end_layout
+
+\end_inset
+
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=-1
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Please a
+\change_deleted 711066561 1405259326
+ö
+\change_inserted 711066561 1405259326
+l
+\change_unchanged
+so note that including the
\begin_inset Flex Code
status collapsed
\end_inset
.
+
\end_layout
\begin_layout Standard
\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
status collapsed
\begin_layout Plain Layout
-The
+Note that the option
\begin_inset Flex Code
status collapsed
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
status collapsed
\begin_layout Plain Layout
-xdvi -editor 'lyxeditor.sh %f %l'
+xdvi -editor "lyxeditor.sh %f %l"
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
-read < "${LYXPIPE}".out || exit
+read TMP < "${LYXPIPE}".out || exit
\end_layout
\begin_layout Standard
\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
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_inset Quotes erd
\end_inset
- to reverse search.
+ of reverse search.
It allows you to let the viewer jump to a given position from within LyX.
If forward search is set up (as described in what follows), you can put
the cursor anywhere in your LyX document, and hit
can select from the drop down list.
If none of these configurations suits you, you have to find out and enter
a suitable configuration yourself.
- The definition syntax uses the following placeholders:
+ The definition syntax uses the following placeholders:
\end_layout
\begin_layout Itemize
\end_inset
-: name of the (temporary) exported .tex file
+: 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
\begin_layout Standard
Note that only some of the viewers provide full forward search functionality,
- among them yap, xdvi, okular and Sumatra PDF.
+ among them yap, xdvi, okular
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-For Sumatra CMCDDE is needed --- downloadable from
-\begin_inset CommandInset href
-LatexCommand href
-target "http://www.istri.fr/zip/CMCDDE.zip"
+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
- 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
+\end_layout
-near
-\begin_inset Quotes erd
\end_inset
-.
- These latter functionality is provided by an external call of synctex (see
- the predefined example configurations).
-
-\end_layout
+
+\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.
\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 Code
\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
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
+, lots will probably never be supported, due to the limitations of LyX's
+ framework.
Of course you can still use all features with the help of some native LaTeX
commands (TeX code
\begin_inset Foot
\end_inset
).
- In this section, we can only list those features which are natively supported
+ In this section, we can only list those features that are natively supported
by LyX.
For detailed descriptions (and for the rest of features) we recommend you
have a look at the detailed manual of the Memoir class
\begin_inset Quotes erd
\end_inset
-, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-without pagina).
+).
If you want an empty title page, type
\family typewriter
\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset Argument
+\begin_inset Argument status
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\family typewriter
chktex
\family default
- it from CTAN,
+ from CTAN,
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset CommandInset href
LatexCommand href
target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
\begin_inset Newline newline
\end_inset
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
+If you have bad luck, the text will break right between the referenced text
+ and reference number, and that's a pity.
See section
\begin_inset CommandInset ref
LatexCommand ref
\family sans
ChkTeX
\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
+, and this gap can make some warnings seem arcane or just plain silly.
\end_layout
\begin_layout Standard
\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 been done.
- LyX now supports some of the most basic RCS/CVS/SVN commands.
+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
-Also note that CVS support is not as good as subversion support so we advice
+Also note that CVS support is not as good as subversion support so we advise
using SVN instead.
- Good place to start with Subversion is SVN Book
+ A good place to start learning Subversion is SVN Book
\begin_inset Foot
status open
\end_inset
.
- In case of RCS you should read
+ In the case of RCS you should read
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
Before you begin to use the version control features in LyX, you should
- be familiar with RCS/CVS/SVN usage.
+ 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.
+ package — no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
- you can check them in Messages pane if unsure.
+ you can check them in the Messages pane if unsure.
+ 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
+
+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
-Undo Last Checkin
+Copy
\end_layout
\begin_layout Standard
-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.
-
+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 Standard
-RCS command:
-\family typewriter
-rcs -o<version> <file-name>
-\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+RCS
+\begin_inset space ~
+\end_inset
-\begin_layout Subsubsection
+commands:
+\begin_inset space ~
+\end_inset
-\family sans
-Show History
-\end_layout
-\begin_layout Standard
-This shows the complete history of the RCS document.
- The output of
-\family typewriter
-rlog <file-name>
-\family default
- is shown in a browser.
- See
-\family typewriter
-man rlog
-\family default
- for more info.
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsubsection
-Revision info
-\end_layout
+Copy
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
-\begin_layout Standard
-LyX supports RCS version number, author name, date and time of last commit.
- All those are extracted from
\family typewriter
-rlog -r <file-name>
-\family default
-.
- For other details see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:VCS-Revision-Information"
+\begin_inset Quotes eld
+\end_inset
+<file-name>
+\begin_inset Quotes erd
\end_inset
- for details.
-\end_layout
-\begin_layout Subsection
-CVS commands in LyX
\end_layout
-\begin_layout Standard
-A subset of CVS operations is 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.
- The version control system SVN is more powerful, so please use it instead
- of CVS if possible.
-\end_layout
+ 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
+
+\begin_layout Standard
+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
+RCS command:
+\family typewriter
+rcs -o<version> <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the RCS document.
+ The output of
+\family typewriter
+rlog <file-name>
+\family default
+ is shown in a browser.
+ See
+\family typewriter
+man rlog
+\family default
+ for more info.
+\end_layout
+
+\begin_layout Subsubsection
+Revision info
+\end_layout
+
+\begin_layout Standard
+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_inset
+
+ for details.
+\end_layout
+
+\begin_layout Subsection
+CVS commands in LyX
+\end_layout
+
+\begin_layout Standard
+A subset of CVS operations is 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.
+ The version control system SVN is more powerful, so please use it instead
+ of CVS if possible.
+\end_layout
\begin_layout Subsubsection
If your documents are under revision control and others are using the same
repository problems arise when different changes to the same document at
the same location happen.
- Standard CVS repositories doesn't operate with a file locking mechanism.
+ 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
\end_inset
- in case you have already the documents directory under CVS control (in
- particular
+ in the case you have already the documents directory under CVS control
+ (in particular
\family typewriter
CVS/Entries
\family default
\end_layout
\begin_layout Subsubsection
-Update of the local directory checkout from repository
+
+\family sans
+Copy
\end_layout
\begin_layout Standard
-Once your documents gets more complex, containing sub-documents and pictures,
- including external
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.tex
+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
+CVS
+\begin_inset space ~
\end_inset
- files and so on using version control becomes more complicated.
- LyX supports updating the whole tree in which resides the document.
- This become especially useful once you cooperate with people which neither
- have detailed knowledge about CVS usage nor they have ambition to commit
- additional material to the repository.
- You have to organize the files structure so that all external files are
- in the same directory or subdirectories of the document.
- It's good practice anyway to store multipart documents in an extra directory.
-\end_layout
+commands:
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-The
+
+\begin_inset Newline newline
+\end_inset
+
+Copy
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Update local directory from repository
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
\end_inset
- command updates the whole directory.
- If local changes are detected user is warned before update starts.
- In case of merge conflicts both versions of the conflicting document parts
- are placed in the final document.
- You have to review and correct the result of the merge.
- You'll find the conflicts enclosed in pairs of
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-<<<<<<<
\end_layout
\end_inset
- and
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
->>>>>>>
-\end_layout
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
- separated by
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-=======
\end_layout
\end_inset
-.
- 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 Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
->
+cvs -q add
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
\end_inset
- signs.
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+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
\begin_inset Newline newline
\end_inset
-
+Rename
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cd $path; cvs diff
-\family typewriter
-"."
-\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
+\end_layout
+
+\end_inset
+
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cd $path; cvs -q update
+
\family typewriter
-"."
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Standard
-where
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-$path
-\end_layout
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q add
+\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
+cvs -q remove
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Update of the local directory checkout from repository
+\end_layout
+
+\begin_layout Standard
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
+\end_layout
+
+\end_inset
+
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
+\end_inset
+
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<<<<<<<
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>>>>>>>
+\end_layout
+
+\end_inset
+
+ separated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+=======
+\end_layout
+
+\end_inset
+
+.
+ 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
+>
+\end_layout
+
+\end_inset
+
+ signs.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\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
+cd $path; cvs diff
+\family typewriter
+"."
+\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
+cd $path; cvs -q update
+\family typewriter
+"."
+\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
is shown in a browser.
\end_layout
+\begin_layout Subsubsection
+Revision info
+\end_layout
+
+\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"
+
+\end_inset
+
+ for details.
+\end_layout
+
\begin_layout Subsection
SVN commands in LyX
\end_layout
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
+ LyX was tested against SVN 1.5, 1.6, 1.7 and 1.8
\begin_inset Foot
status open
\end_inset
.
+ There seems to be currently unresolved permissions problem under SVN 1.8
+ with reverting changes when file is locked.
\end_layout
\end_inset
egister
\family default
item is not visible.
-
\end_layout
\begin_layout Standard
\family default
file exists).
This means you have to checkout the archive by yourself.
-
\end_layout
\begin_layout Standard
man svn
\family default
to understand the switches.
-
\end_layout
\begin_layout Subsubsection
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
\end_layout
\begin_layout Subsubsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:SVN-Repo-Update"
-\end_inset
+\family sans
+Copy
+\end_layout
-Update of the local directory checkout from repository
-\begin_inset Foot
-status collapsed
+\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{}
+).
+ Finally, the copy is loaded instead of the original document.
+\end_layout
-\begin_layout Plain Layout
-Note that this command will work only with subversion
-\begin_inset Formula $\geqq1.5$
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
\end_inset
+commands:
+\begin_inset space ~
+\end_inset
-\end_layout
+\begin_inset Newline newline
\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
+svn copy -q
+\family typewriter
+\begin_inset Quotes eld
\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
+<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
+svn commit
+\end_layout
+
+\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
+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 move -q
+\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
+svn commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:SVN-Repo-Update"
+
+\end_inset
+
+Update of the local directory checkout from repository
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this command will work only with subversion
+\begin_inset Formula $\geqq1.5$
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+All the commands above have one shortcomming - they deal with the current
+ document only.
+ Once your document contains pictures, includes external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
+\end_layout
+
+\end_inset
+
+ files and so on administration becomes more complicated.
+ LyX now supports updating the whole tree in which resides the document
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
One need to organize the files structure so that all external files are
in the same directory or subdirectories of the document.
\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">
+<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
new project
\family default
in Windows Explorer, right click it, and select
-\family typewriter
-TortoiseSVN > Repo-browser
+\family sans
+TortoiseSVN\SpecialChar \menuseparator
+Repo-browser
\family default
.
If necessary, adjust the URL for the repository, then click OK.
\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{}
-
+\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.
\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
+File\SpecialChar \menuseparator
+Version
\begin_inset space ~
\end_inset
Control\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-egister.
+Register.
\family default
Add a log message and click OK to commit the document to version control.
\begin_layout Standard
From this point onward, you should have full functionality in the
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-V
-\bar default
-ersion
+File\SpecialChar \menuseparator
+Version
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Standard
-Compared with Linux setting up svn client to communicate over ssh under
+Compared with Linux setting up an svn client to communicate over ssh under
Windows is a rather troublesome task.
We will at least offer some hints how to setup the client side but prior
knowledge about ssh and the Windows command line is needed, also be prepared
\end_layout
\begin_layout Enumerate
-Get a svn client for windows, as described in the previous sections.
+Get an svn client for windows, as described in the previous sections.
When it is a fresh install run some svn command (e.g.
\begin_inset Flex Code
\end_layout
\begin_layout Enumerate
-Choose a ssh client for Windows.
+Choose an ssh client for Windows.
There are several possibilities, we will use the one from Putty tools
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
\begin_inset Flex URL
\end_inset
-/
+ /
\begin_inset Flex Code
status collapsed
\end_deeper
\begin_layout Enumerate
-Checkout the SVN archive, e.g.
-
+Checkout the SVN archive, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\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.
+GIT commands in LyX
\end_layout
\begin_layout Standard
-As an example you can see how two TortoiseSVN commands could be integrated
- directly:
-\end_layout
+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
-\begin_layout Description
-Commit:
-\begin_inset Flex Code
-status collapsed
+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
-vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+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 Description
-Revert:
+\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
-vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+pull
\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
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-diff
+push
\end_layout
\end_inset
- dumps.
- While this is useful for plain text files, it is much less useful in the
- case of LyX files, which have more complicated structure.
- Hence we provide binding to the Document comparison feature.
- They are two ways of calling this feature - either by direct call of
+ 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
-VC_COMPARE
+pull
\end_layout
\end_inset
- LyX function (for details see LyX functions manual) or by icon/menu item
-
-\begin_inset Flex MenuItem
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Compare with older revision...
+push
\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
+ operations with your favourite GIT client.
\end_layout
-\end_inset
+\begin_layout Subsubsection
-' revisions back means comparison of the edited file with last commited
- revision).
-
+\family sans
+Register
\end_layout
\begin_layout Standard
-This feature is supported for SVN and RCS though due to the more complicated
- versioning scheme of RCS there is a constraint -- when addressing the revisions
- in dialog, numbers always point to the last number in RCS revision number,
- i.e.
- '35' in '1.2.35'.
-\end_layout
-
-\begin_layout Section
-Literate Programming
+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
-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)
+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 Subsection
-Introduction
+\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
-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
+GIT command that is run:
+\family typewriter
+git add
\begin_inset Quotes eld
\end_inset
-tangling
+<file-name>
\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.
+Read
+\family typewriter
+man git
+\family default
+ to understand the switches.
\end_layout
-\begin_layout Subsection
-Literate Programming
-\end_layout
+\begin_layout Subsubsection
-\begin_layout Standard
-From the Literate Programming FAQ:
+\family sans
+Check In Changes
\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.
-
+\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
-Another excerpt says:
+GIT command:
+\family typewriter
+git commit -q -m"<description>" <file-name>
\end_layout
-\begin_layout Quotation
+\begin_layout Subsubsection
-\emph on
-How is literate programming different from verbose commenting?
+\family sans
+Revert To Repository Version
\end_layout
-\begin_layout Quotation
-There are three distinguishing characteristics.
- In order of importance, they are:
+\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_deeper
-\begin_layout Itemize
-flexible order of elaboration
-\end_layout
+\begin_layout Standard
+GIT command:
+\family typewriter
+git checkout -q
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-automatic support for browsing
-\end_layout
+<file-name>
+\begin_inset Quotes erd
+\end_inset
-\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
+
+\family sans
+Rename
\end_layout
\begin_layout Standard
-The complete Literate Programming FAQ can be found at:
+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 Quote
-Literate Programming FAQ
-\begin_inset Flex URL
-status collapsed
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+GIT
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
+commands:
+\begin_inset space ~
+\end_inset
-http://www.literateprogramming.com/lpfaq.pdf
-\end_layout
+\begin_inset Newline newline
\end_inset
-\end_layout
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git mv
+\family typewriter
-\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
+<file-name>
\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{}
+
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset space \space{}
+<new-file-name>
+\begin_inset Quotes erd
\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
+\end_inset
-\begin_layout Standard
-The Noweb web page can be found at:
-\end_layout
-\begin_layout Quote
-Noweb home page
-\begin_inset Flex URL
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-http://www.cs.virginia.edu/~nr/noweb/
+git commit
\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 Subsubsection
-\begin_layout Subsection
-LyX and Literate Programming
+\family sans
+Show History
\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
+This shows the complete history of the GIT document.
+ The output of
+\family typewriter
+git log
\begin_inset Quotes eld
\end_inset
-Noweb independent
+<file-name>
\begin_inset Quotes erd
\end_inset
- way, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\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.
+\family default
+ is shown in a browser.
\end_layout
\begin_layout Subsubsection
-Generating documents and code (weaving and tangling)
-\end_layout
-
-\begin_layout Paragraph
-Selecting the document class
+Version Info
\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)
+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
-You must select one of them to create your literate documents from.
-
+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
-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
+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
-It is very simple, it involves the creation of a file with four lines, and
- re-running of the auto configuration.
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
\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
\end_layout
-\begin_layout Standard
-LyX enables you to write code with a layout named
-\noun on
-Scrap
-\noun default
-.
-\begin_inset Foot
+\begin_layout Description
+Revert:
+\begin_inset Flex Code
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.
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
\end_layout
\end_inset
- Noweb delimits scraps like this:
-\end_layout
-
-\begin_layout LyX-Code
-<<My scrap>>=
-\end_layout
-\begin_layout LyX-Code
- code
\end_layout
-\begin_layout LyX-Code
- more code
+\begin_layout Subsection
+Version control and Document comparison
\end_layout
-\begin_layout LyX-Code
- even more code
-\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 LyX-Code
- @
+\begin_layout Plain Layout
+diff
\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
-
-g.
-\begin_inset space \space{}
\end_inset
-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.
-\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
+ 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
-If you have a printed version of this document you will not see any difference
- between the previous example and this one.
+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
-\begin_layout LyX-Code
-<<My scrap>>=
-\begin_inset Newline newline
\end_inset
- code
-\begin_inset Newline newline
-\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
- more code
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+0
+\end_layout
- even more code
-\begin_inset Newline newline
\end_inset
- @
+' revisions back means comparison of the edited file with last commited
+ revision).
+
\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
-
-\begin_layout Plain Layout
-It is in my list of
-\begin_inset Quotes eld
-\end_inset
-
-improvements
-\begin_inset Quotes erd
-\end_inset
+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
- to fix that.
+\begin_layout Section
+Literate Programming
\end_layout
-\end_inset
+\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
-As a special note, you can also use the
+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
-%def
+tangling
\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
+ and
+\begin_inset Quotes eld
\end_inset
- def some_function(args):
-\begin_inset Newline newline
+weaving
+\begin_inset Quotes erd
\end_inset
- "This is the doc string for this function."
-\begin_inset Newline newline
-\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
- print "My args: ", args
+\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 LyX-Code
-@ %def some_function
+\begin_layout Subsection
+Literate Programming
\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.
+From the Literate Programming FAQ:
\end_layout
-\begin_layout Paragraph
-Generating the documentation
+\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
-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.
+Another excerpt says:
\end_layout
-\begin_layout Standard
-To help orientate you, I will now explain what happens inside LyX:
+\begin_layout Quotation
+
+\emph on
+How is literate programming different from verbose commenting?
\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 Quotation
+There are three distinguishing characteristics.
+ In order of importance, they are:
\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
+\begin_layout Itemize
+flexible order of elaboration
+\end_layout
-literate
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+automatic support for browsing
+\end_layout
- format (defined in the Preferences panel), otherwise the file will have
- the usual
-\family typewriter
-.tex
-\family default
- extension.
+\begin_layout Itemize
+typeset documentation, especially diagrams and mathematics
\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
+Now that I sparked your curiosity, take a look in the references.
\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 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
-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.
+http://www.literateprogramming.com/lpfaq.pdf
\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
+The FAQ lists 23 (twenty three!) different literate programming tools.
+ Where some are specialized or
\begin_inset Quotes eld
\end_inset
-literate tool
+tailored
\begin_inset Quotes erd
\end_inset
- is easily achieved by changing the commands that are run by the various
- converters.
+ 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 Paragraph
-Generating the code
+\begin_layout Itemize
+It can generate the documentation either in LaTeX or HTML.
\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:
+\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 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).
+\begin_layout Itemize
+There is a good selection of filters available already (the HTML is one
+ of them).
\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.
+\begin_layout Itemize
+It is free.
\end_layout
\begin_layout Standard
-The first part, the
-\begin_inset Quotes eld
-\end_inset
-
-Converter
-\begin_inset Quotes erd
-\end_inset
+The Noweb web page can be found at:
+\end_layout
- setting, should be set to
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Quote
+Noweb home page
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family typewriter
-build-script $$i
-\family default
+http://www.cs.virginia.edu/~nr/noweb/
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- This basically means that LyX will call
-\begin_inset Quotes eld
-\end_inset
-build-script
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- (a program or script) with the name of the Noweb file (normally a file
- in the LyX temp directory).
-
+\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
-This is an implementation of
+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
-build-script
+Noweb independent
\begin_inset Quotes erd
\end_inset
- that you can place in a directory on your path:
-\end_layout
+ way, i.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-#!/bin/sh
+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 LyX-Code
-#
+\begin_layout Subsubsection
+Generating documents and code (weaving and tangling)
\end_layout
-\begin_layout LyX-Code
-notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
+\begin_layout Paragraph
+Using the noweb module
\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
+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
-
-\family typewriter
-parselog=listerrors
-\family default
-
+noweb
\begin_inset Quotes erd
\end_inset
-.
- This will run any errors that are generated by the
+ module.
+ If Noweb is correctly installed, when you click on the
\begin_inset Quotes eld
\end_inset
-build-script
+Modules
\begin_inset Quotes erd
\end_inset
- process through the
+ link, you will see the
\begin_inset Quotes eld
\end_inset
-listerrors
+noweb
\begin_inset Quotes erd
\end_inset
- program.
+ module in the available list and you can add it to your document.
\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
-
-listerrors
-\begin_inset Quotes erd
-\end_inset
-
- program.
+\begin_layout Paragraph
+Typing code in
\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
+LyX enables you to write code with a layout named
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-See section
-\emph on
-Copiers
-\emph default
- of the
-\emph on
-Customization
-\emph default
- manual for information on these.
+Chunk
\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:
+ Noweb delimits chunks like this:
\end_layout
\begin_layout LyX-Code
-python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
+<<My code>>=
\end_layout
-\begin_layout Standard
-The result will be that only files with these two extensions will be copied
- out.
+\begin_layout LyX-Code
+ code
\end_layout
-\begin_layout Paragraph
-Build instructions in the document
+\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 last piece of the integration between LyX and noweb is the
-\begin_inset Quotes eld
+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
-build-script
-\begin_inset Quotes erd
+e.
+\begin_inset space \space{}
\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
+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
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Chunk
+\end_layout
- above uses the notangle command to look for this scrap (called
-\begin_inset Quotes eld
\end_inset
-build-script
-\begin_inset Quotes erd
-\end_inset
+, that works like a normal paragraph but has a free spacing capability.
+\end_layout
-) and runs its contents through
+\begin_layout Standard
+As a special note, you can also use the
\begin_inset Quotes eld
\end_inset
-sh
+%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 Standard
-Typically, such a scrap would look something like this:
+\begin_layout LyX-Code
+<<My chunk>>=
\end_layout
\begin_layout LyX-Code
-<<build-script>>=
-\begin_inset Newline newline
-\end_inset
-
-#!/bin/sh
-\begin_inset Newline newline
-\end_inset
-
+def some_function(args):
+\end_layout
-\begin_inset Newline newline
-\end_inset
+\begin_layout LyX-Code
+ "This is the doc string for this function."
+\end_layout
-if [ -z "${NOWEB_SOURCE}" ]
-\begin_inset Newline newline
-\end_inset
+\begin_layout LyX-Code
+ print "My args: ", args
+\end_layout
-then
-\begin_inset Newline newline
-\end_inset
+\begin_layout LyX-Code
+@ %def some_function
+\end_layout
- NOWEB_SOURCE=myfile.nw
-\begin_inset Newline newline
-\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
-fi
-\begin_inset Newline newline
-\end_inset
+\begin_layout Paragraph
+Generating the documentation
+\end_layout
-[...
- code to extract files ...]
-\begin_inset Newline newline
-\end_inset
+\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
-[...
- code to compile files ...]
-\begin_inset Newline newline
-\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.
+
\end_layout
+\begin_deeper
\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
+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
-listerrors
+literate
\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.
+ format (defined in the Preferences panel), otherwise the file will have
+ the usual
+\family typewriter
+.tex
+\family default
+ extension.
+\end_layout
-\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_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
-\begin_layout Subsubsection
-Configuring LyX
+\end_inset
+
+ layout that, by itself, takes care of the business.
\end_layout
-\begin_layout Standard
-All the Literate Programming support is configured by the
+\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 in the
+ panel, under the
\begin_inset Quotes eld
\end_inset
\end_inset
tab.
- The important parts are:
+ See section
+\emph on
+Converters
+\emph default
+ of the
+\emph on
+Customization
+\emph default
+ manual for general information about converters.
\end_layout
-\begin_layout Description
-the
-\begin_inset space ~
\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
+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_inset space ~
-\end_inset
+\begin_layout Paragraph
+Generating the code
+\end_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
+\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
-.nw
+Noweb->Program
\family default
- extension in the first step of the conversion process.
+ 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 Description
-the
-\begin_inset space ~
-\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).
+\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
-\family sans
-Program
-\family default
-
-\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 Description
-
-\family sans
-NoWeb
-\family default
-->
-\family sans
-LaTeX
-\family default
- This converter performs the
+\begin_layout Standard
+The first part, the
\begin_inset Quotes eld
\end_inset
-weaving
+Converter
\begin_inset Quotes erd
\end_inset
- of the literate document.
- For Noweb, it is set to
+ setting, should be set to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\family typewriter
-noweave -delay -index $$i > $$o
+build-script $$i
\family default
-
+ $$r
\begin_inset Quotes erd
\end_inset
+.
+\begin_inset Newline newline
+\end_inset
-\end_layout
-
-\begin_layout Description
-
-\family sans
-NoWeb
-\family default
-->
-\family sans
-Program
-\family default
- This performs the
+This basically means that LyX will call
\begin_inset Quotes eld
\end_inset
-tangling step
+build-script
\begin_inset Quotes erd
\end_inset
-.
- As stated above, the Converter is set to
+ (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
-
-\family typewriter
-build-script $$i
-\family default
-
+build-script
\begin_inset Quotes erd
\end_inset
-, with Flags set to
-\begin_inset Quotes eld
+ that you can place in a directory on your path:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
\end_inset
-\family typewriter
-originaldir,parselog=listerrors
-\family default
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Standard
+\begin_inset Newpage pagebreak
\end_inset
-.
+
\end_layout
-\begin_layout Subsubsection
-Debug extensions
+\begin_layout Standard
+
+\family sans
+#!/bin/sh
\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.
-
+\family sans
+#
\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.
+notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
\end_layout
\begin_layout Standard
-I take advantage of the new created LyX server function and this ddd feature,
- and set
+\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
-Edit Sources
+Flags
\begin_inset Quotes erd
\end_inset
- to:
-\end_layout
-
-\begin_layout LyX-Code
-echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
-\end_layout
+ which is to be set to
+\begin_inset Newline newline
+\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 !
-\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
\family typewriter
-/home/<your-home-directory>/.lyx/lyxpipe
+parselog=$$s/scripts/listerrors
\family default
\begin_inset Quotes erd
\end_inset
+.
+\begin_inset Newline newline
+\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
+This will run any errors that are generated by the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsubsection
-Toolbar extensions
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\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
+ process through the
\begin_inset Quotes eld
\end_inset
-Build Program
+listerrors
\begin_inset Quotes erd
\end_inset
- File menu entry.
-
+ program.
\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
-
-\family sans
-Update
-\family default
-\SpecialChar \menuseparator
-
-\family sans
-DVI
-\family default
- and the other for
-\family sans
-View\SpecialChar \menuseparator
-DVI
+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
- File menu entries.
- Here is how it looks like:
+ 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 LyX-Code
-Toolbar
+\begin_layout Paragraph
+Build instructions in the document
\end_layout
-\begin_layout LyX-Code
- Layouts
-\end_layout
+\begin_layout Standard
+The last piece of the integration between LyX and noweb is the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- Icon "layout Standard"
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
- Icon "layout Section"
-\end_layout
+ 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
-\begin_layout LyX-Code
- Icon "layout LaTeX"
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
- Icon "layout LyX-Code"
-\end_layout
+ above uses the notangle command to look for this chunk (called
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- Icon "layout Scrap"
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
- Separator
-\end_layout
+) and runs its contents through
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- Icon "buffer-view"
-\end_layout
+sh
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
- Icon "buffer-typeset"
+.
\end_layout
-\begin_layout LyX-Code
- Icon "build-program"
+\begin_layout Standard
+Typically, such a chunk would look something like this:
\end_layout
\begin_layout LyX-Code
- Separator
+<<build-script>>=
\end_layout
\begin_layout LyX-Code
-.
-\end_layout
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
-.
+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 LyX-Code
-End
+\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
-Colors customization
+Configuring LyX
\end_layout
\begin_layout Standard
-There are a number of colors in LyX that can be customized in
+All the Literate Programming support is configured by the
\family sans
+Tools\SpecialChar \menuseparator
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.
-\end_layout
+ panel in the
+\begin_inset Quotes eld
+\end_inset
-\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.
-
-\end_layout
+File Handling
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Chapter
-Special features
+ tab.
+ The important parts are:
\end_layout
-\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
-EmbeddedObjects
-\emph default
- manual.
-\end_layout
+\begin_layout Description
+the
+\begin_inset space ~
+\end_inset
-\begin_layout Section
-Multiple Text Columns
-\end_layout
-\begin_layout Standard
-This feature is independent of the option
+\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
-Two-column document
+GUI Name
\family default
- in the document settings under
-\family sans
-Text Layout
+ is set to
+\family typewriter
+NoWeb
+\family default
+, the file extension is set to
+\family typewriter
+.nw
\family default
.
- If you want to have 2
+ This tells LyX to create a file with a
+\family typewriter
+.nw
+\family default
+ extension in the first step of the conversion process.
+\end_layout
+
+\begin_layout Description
+the
\begin_inset space ~
\end_inset
-columns for the whole document, it is recommended to use the
+
\family sans
-Two-column document
+Program
\family default
- option.
- For all other cases use this feature.
+
+\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
-To use multiple text columns in your document, you have to load the module
-
+\begin_layout Description
+
\family sans
-Multiple Columns
+NoWeb
\family default
- (menu
+->
\family sans
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
-Modules
+LaTeX
\family default
-) and must have the LaTeX-package
-\series bold
-multicol
-\series default
-
-\begin_inset Index idx
-status collapsed
+ This converter performs the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-LaTeX-packages ! multicol
-\end_layout
+weaving
+\begin_inset Quotes erd
+\end_inset
+ of the literate document.
+ For Noweb, it is set to
+\begin_inset Quotes eld
\end_inset
- installed.
-\end_layout
-\begin_layout Standard
-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 typewriter
+noweave -delay -index $$i > $$o
\family default
-.
-\end_layout
-\begin_layout Subsection
-Basics
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
-\begin_layout Standard
-If you want to have 2 columns in your text, use the style
+\begin_layout Description
+
\family sans
-Begin Multiple Columns
+NoWeb
\family default
- where the columns should start.
- The content of the style is the number of the columns, so in this case
- use a
+->
+\family sans
+Program
+\family default
+ This performs the
\begin_inset Quotes eld
\end_inset
-2
+tangling step
\begin_inset Quotes erd
\end_inset
.
- At the point where the columns should end use the style
-\family sans
-End Multiple Columns
-\family default
- and keep it empty.
-\end_layout
+ As stated above, the Converter is set to
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+build-script $$i
+\family default
+ $$r
+\begin_inset Quotes erd
+\end_inset
+
+, with Flags 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
+
+.
+\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.
+\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
+
+Edit Sources
+\begin_inset Quotes erd
+\end_inset
+
+ to:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\family sans
+echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\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
+
+
+\family typewriter
+/home/<your-home-directory>/.lyx/lyxpipe
+\family default
+
+\begin_inset Quotes erd
+\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_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
+
+Build Program
+\begin_inset Quotes erd
+\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
+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
+
+\begin_layout LyX-Code
+Toolbar
+\end_layout
+
+\begin_layout LyX-Code
+ Layouts
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "layout Standard"
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "layout Section"
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "layout LaTeX"
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "layout LyX-Code"
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "layout Chunk"
+\end_layout
+
+\begin_layout LyX-Code
+ Separator
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "buffer-view"
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "buffer-typeset"
+\end_layout
+
+\begin_layout LyX-Code
+ Icon "build-program"
+\end_layout
+
+\begin_layout LyX-Code
+ Separator
+\end_layout
+
+\begin_layout LyX-Code
+.
+\end_layout
+
+\begin_layout LyX-Code
+.
+\end_layout
+
+\begin_layout LyX-Code
+.
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Subsubsection
+Colors customization
+\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 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
+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
+LyX and knitr/Sweave
+\end_layout
+
+\begin_layout Standard
+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 Chapter
+Special features
+\end_layout
+
+\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
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
+\emph default
+ manual.
+\end_layout
+
+\begin_layout Section
+Multiple Text Columns
+\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
+
+columns for the whole document, it is recommended to use the
+\family sans
+Two-column document
+\family default
+ option.
+ For all other cases use this feature.
+\end_layout
+
+\begin_layout Standard
+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
+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 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
+
+Insets\SpecialChar \menuseparator
+Multiple
+\begin_inset space ~
+\end_inset
+
+Columns
+\family default
+ where the columns should start.
+ Write all text that should be printed in 2
+\begin_inset space ~
+\end_inset
+
+columns into this inset.
+\end_layout
+
+\begin_layout Standard
+Here is an example:
+\end_layout
+
+\begin_layout Standard
+\noindent
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\noindent
+
+\series bold
+\size small
+The Adventure of the Empty House
+\series default
+
+\begin_inset Newline newline
+\end_inset
+
+by Sir Arthur Conan Doyle
+\end_layout
+
+\begin_layout Plain Layout
+
+\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
+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
+
+of
+\begin_inset space ~
+\end_inset
+
+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
+
+3
+\begin_inset Quotes erd
+\end_inset
+
+).
+\begin_inset Newline newline
+\end_inset
+
+Here is an example with 3
+\begin_inset space ~
+\end_inset
+
+columns:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size footnotesize
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+3
+\end_layout
+
+\end_inset
+
+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
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+You can have up to 10
+\begin_inset space ~
+\end_inset
+
+columns if you want to, but that might not be very pleasant for the readers
+ of your document.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Columns inside Columns
+\end_layout
+
+\begin_layout Standard
+You can also have columns inside columns:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\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 Plain Layout
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\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 Plain Layout
+
+\size footnotesize
+Ronald Adair was fond of cards–playing continually, but never for such stakes
+ as would hurt him.
+ He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
+ It was shown that, after dinner on the day of his death, he had played
+ a rubber of whist at the latter club.
+ He had also played there in the afternoon.
+
+\size default
+
+\size footnotesize
+The evidence of those who had played with him– Mr.
+ Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
+ and that there was a fairly equal fall of the cards.
+ Adair might have lost five pounds, but not more.
+ His fortune was a considerable one, and such a loss could not in any way
+ affect him.
+ He had played nearly every day at one club or other, but he was a cautious
+ player, and usually rose a winner.
+ It came out in evidence that, in partnership with Colonel Moran, he had
+ actually won as much as four hundred and twenty pounds in a sitting, some
+ weeks before, from Godfrey Milner and Lord Balmoral.
+ So much for his recent history as it came out at the inquest.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Advanced Examples
+\end_layout
+
+\begin_layout Standard
+The examples in this section show some more special features of multiple
+ columns.
+\end_layout
+
+\begin_layout Standard
+For more features of multiple columns, have a look at the documentation
+ of the LaTeX-package
+\series bold
+multicol
+\series default
+,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "multicol"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+Preface
+\end_layout
+
+\begin_layout Standard
+To add a preface text for multiple columns, 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
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
+
+\begin_layout Plain Layout
+And the story continues and continues and continues and continues\SpecialChar \ldots{}
+
+\end_layout
+
+\end_inset
+
+
+\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
+
+\end_inset
+
+
+\end_layout
+
+\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_layout Standard
+
+\series bold
+
+\backslash
+subsection{subsection title}
+\end_layout
+
+\begin_layout Standard
+creates a subsection.
+ In this example the preface is a subsubsection:
+\end_layout
+
+\begin_layout 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
+
+
+\backslash
+subsubsection{
+\end_layout
+
+\end_inset
+
+This is a subsubsection heading as a preface
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\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
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+If there is less vertical space than 6
+\begin_inset space ~
+\end_inset
+
+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
+
+Before
+\begin_inset space ~
+\end_inset
+
+Page
+\begin_inset space ~
+\end_inset
+
+Break
+\family default
+.
+ Insert into that inset the amount of space like e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+5cm
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+In this example the space is set to 7
+\begin_inset space ~
+\end_inset
+
+text lines by using
+\begin_inset Quotes eld
+\end_inset
+
+7
+\backslash
+baselineskip
+\begin_inset Quotes erd
+\end_inset
+
+ (where the command
+\series bold
+
+\backslash
+baselineskip
+\series default
+ needs to be inserted as TeX code):
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\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
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\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
+
+\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
+.
+ For example the command
+\end_layout
+
+\begin_layout Standard
+
+\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
+
+cm.
+ The change must be made before the multiple columns' start.
+ The predefined value is 13
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
+\end_layout
+
+\begin_layout Standard
+For this example
+\series bold
+
+\backslash
+multicolsep
+\series default
+ was set to 2.5
+\begin_inset space \thinspace{}
+\end_inset
+
+cm:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+multicolsep}{2.5cm}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\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
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note:
+\series default
+ The values you set with
+\series bold
+
+\backslash
+setlength
+\series default
+ will be used for all following multiple columns until you change them again.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+multicolsep}{13pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Column Breaks
+\end_layout
\begin_layout Standard
+A column break can be forced by inserting the command
+\series bold
+
+\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
+
Here is an example:
\end_layout
-\begin_layout Begin Multiple Columns
-2
+\begin_layout Standard
+\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 Plain Layout
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\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 Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+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
+
+\begin_layout Plain Layout
+
+
+\backslash
+columnbreak{}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\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
+
+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
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Column Separation
\end_layout
\begin_layout Standard
-\noindent
+The width of the columns is automatically calculated, but you can modify
+ the space between the columns.
+ This is done by changing the length
+\series bold
+
+\backslash
+columnsep
+\series default
+.
+ Its predefined value is 10
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
+ Here is an example where
+\series bold
+
+\backslash
+columnsep
+\series default
+ is set to 3
+\begin_inset space \thinspace{}
+\end_inset
+
+cm:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{3cm}
+\end_layout
+
+\end_inset
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+
+\size small
+My observations of No.
+\begin_inset space \space{}
+\end_inset
+
+427 Park Lane did little to clear up the problem in which I was interested.
+ The house was separated from the street by a low wall and railing, the
+ whole not more than five feet high.
+ It was perfectly easy, therefore, for anyone to get into the garden, but
+ the window was entirely inaccessible, since there was no water pipe or
+ anything which could help the most active man to climb it.
+ More puzzled than ever, I retraced my steps to Kensington.
+ I had not been in my study five minutes when the maid entered to say that
+ a person desired to see me.
+ To my astonishment it was none other than my strange old book collector,
+ his sharp, wizened face peering out from a frame of white hair, and his
+ precious volumes, a dozen of them at least, wedged under his right arm.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnsep}{10pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Vertical Lines
+\end_layout
+
+\begin_layout Standard
+Between the columns a rule with a width of the length
\series bold
-\size small
-The Adventure of the Empty House
+
+\backslash
+columnseprule
\series default
+ is placed.
+ If this rule width is set to 0
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset Newline newline
+pt (this is the default), the rule is suppressed.
+ In the following example the rule is 2
+\begin_inset space \thinspace{}
\end_inset
-by
-\noun on
-Sir Arthur Conan Doyle
+pt wide:
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
-\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
+\begin_layout Plain Layout
-\begin_layout End Multiple Columns
+\backslash
+setlength{
+\backslash
+columnseprule}{2pt}
\end_layout
-\begin_layout Standard
-Here is an example with 3
-\begin_inset space ~
\end_inset
-columns:
-\end_layout
-\begin_layout Begin Multiple Columns
-3
\end_layout
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
-\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.
-\end_layout
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
+\end_inset
-\begin_layout End Multiple Columns
+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
-You can have up to 10
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
-columns if you want to, but that might not be very pleasant for the readers
- of your document.
+\size small
+I acknowledged that I was.
\end_layout
-\begin_layout Standard
-\begin_inset Newpage newpage
+\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 Subsection
-Columns inside Columns
\end_layout
-\begin_layout Standard
-You can also have columns inside columns:
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
+\size small
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+You make too much of a trifle,
+\begin_inset Quotes erd
+\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
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Begin Multiple Columns
-2
-\end_layout
+May I ask how you knew who I was?
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\size footnotesize
-The youth moved in the best society–had, so far as was known, no enemies
- and no particular vices.
- He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
- had been broken off by mutual consent some months before, and there was
- no sign that it had left any very profound feeling behind it.
- For the rest {sic} the man's life moved in a narrow and conventional circle,
- for his habits were quiet and his nature unemotional.
- Yet it was upon this easy-going young aristocrat that death came, in most
- strange and unexpected form, between the hours of ten and eleven-twenty
- on the night of March 30, 1894.
\end_layout
-\begin_layout End Multiple Columns
+\begin_layout Plain Layout
-\end_layout
+\size small
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+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
-\size footnotesize
-Ronald Adair was fond of cards–playing continually, but never for such stakes
- as would hurt him.
- He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
- It was shown that, after dinner on the day of his death, he had played
- a rubber of whist at the latter club.
- He had also played there in the afternoon.
-\size default
-
-\size footnotesize
-The evidence of those who had played with him– Mr.
- Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
- and that there was a fairly equal fall of the cards.
- Adair might have lost five pounds, but not more.
- His fortune was a considerable one, and such a loss could not in any way
- affect him.
- He had played nearly every day at one club or other, but he was a cautious
- player, and usually rose a winner.
- It came out in evidence that, in partnership with Colonel Moran, he had
- actually won as much as four hundred and twenty pounds in a sitting, some
- weeks before, from Godfrey Milner and Lord Balmoral.
- So much for his recent history as it came out at the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
-\end_layout
-\begin_layout Subsection
-Advanced Examples
\end_layout
\begin_layout Standard
-The examples in this section show some more special features of multiple
- columns.
+\begin_inset VSpace defskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
-For more features of multiple columns, have a look at the documentation
- of the LaTeX-package
+The rule can be colored by redefining the command
\series bold
-multicol
+
+\backslash
+columnseprulecolor
\series default
+.
+ This is done by inserting the command
+\begin_inset Newline newline
+\end_inset
-\begin_inset Index idx
-status collapsed
-\begin_layout Plain Layout
-LaTeX-packages ! multicol
-\end_layout
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{red}}
+\series default
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset CommandInset citation
-LatexCommand cite
-key "multicol"
+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
+
+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
+
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\series default
+\begin_inset Newline newline
\end_inset
-.
-\end_layout
+Here is the example with a cyan rule and 1
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsubsection
-Preface
+cm column separation:
\end_layout
\begin_layout Standard
-To add a preface text for multiple columns, add the command
-\end_layout
+\begin_inset ERT
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
-\series bold
-}[
-\end_layout
-\begin_layout Standard
-as TeX Code behind the number of columns in the
-\family sans
- Begin Multiple Columns
-\family default
- style.
- behind the command write the text.
- At the end of the style use the command
+\backslash
+setlength{
+\backslash
+columnsep}{1cm}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
-\series bold
-]{
+
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{cyan}}
\end_layout
-\begin_layout Standard
-as TeX Code.
- An example with some preface text:
+\end_inset
+
+
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+\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 Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
-
\begin_layout Plain Layout
-}[
+\size small
+I acknowledged that I was.
\end_layout
+\begin_layout Plain Layout
+
+\size small
+\begin_inset Quotes eld
\end_inset
-And the story continues and continues and continues and continues\SpecialChar \ldots{}
+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
-\begin_inset ERT
-status collapsed
+
+\end_layout
\begin_layout Plain Layout
-]{
-\end_layout
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+
+May I ask how you knew who I was?
+\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\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 eld
+\end_inset
-\begin_layout End Multiple Columns
+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
-You can also use a section heading as the preface if you use a section command
- as TeX Code behind the first TeX Code.
- For example the command
\end_layout
-\begin_layout Standard
+\end_inset
-\series bold
-\backslash
-subsection{subsection title}
\end_layout
\begin_layout Standard
-creates a subsection.
- In this example the preface is a subsubsection:
-\end_layout
-
-\begin_layout Begin Multiple Columns
-2
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-}[
-\end_layout
-
-\end_inset
-
-\begin_inset ERT
-status collapsed
+\backslash
+setlength{
+\backslash
+columnseprule}{0pt}
+\end_layout
\begin_layout Plain Layout
\backslash
-subsubsection{
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
\end_layout
\end_inset
-This is a subsubsection heading as a preface
-\begin_inset ERT
+
+\begin_inset Note Note
status collapsed
\begin_layout Plain Layout
-
-}
+go back to the default
\end_layout
\end_inset
-\begin_inset ERT
-status collapsed
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Section
+Non-standard Paragraph Shapes
+\end_layout
-]{
+\begin_layout Standard
+\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
+\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
-\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.
+\begin_layout Plain Layout
+Name
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Description
\end_layout
-\begin_layout Standard
-If there is less vertical space left on the page at the beginning of the
- multiple columns than needed for 6
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-text lines, a page break will be inserted before the multiple columns.
- Depending on the number of lines of the preface text, you might want to
- change this value.
- It is determined by inserting the command
+\begin_layout Plain Layout
+Annotation
\end_layout
-\begin_layout Standard
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\series bold
-][number
-\backslash
-baselineskip
+\begin_layout Plain Layout
+CDlabel
+\end_layout
+
+\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
-as TeX Code behind the preface definition but before the final
-\series bold
-]{
-\series default
- command.
-
-\emph on
-number
-\emph default
- is hereby the number of text lines.
- In this example the space is set to 7
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-text lines:
+\begin_layout Plain Layout
+Cannot be scaled, take care there is not too much text
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-
-}[
+Circle
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Circle
+\end_layout
-\begin_inset ERT
-status collapsed
+\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
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-subsubsection{
+\begin_layout Plain Layout
+Diamond
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-This is the sectioning command
-\begin_inset Newline newline
+\begin_layout Plain Layout
+Rhomboid (symbolizing a
+\begin_inset Quotes eld
\end_inset
-as a preface and
-\begin_inset Newline newline
+diamond
+\begin_inset Quotes erd
\end_inset
-with multiple text lines
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-}
+)
\end_layout
\end_inset
-
-
-\begin_inset ERT
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-
-][7
-\backslash
-baselineskip
+-
\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
+Heart
+\end_layout
-\begin_inset ERT
-status collapsed
+\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
\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
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\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.
+\begin_layout Plain Layout
+Hexagon
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Hexagon
\end_layout
-\begin_layout Subsubsection
-Surrounding Space
+\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
-The amount of space before and after multiple columns can be changed by
- changing the length
-\series bold
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-multicolsep
-\series default
-.
- For example the command
+\begin_layout Plain Layout
+Nut
\end_layout
-\begin_layout Standard
-
-\series bold
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-setlength{
-\backslash
-multicolsep}{3cm}
+\begin_layout Plain Layout
+Nut for bolt (hexagon with circular hole)
\end_layout
-\begin_layout Standard
-in TeX Code changes its value to 3
-\begin_inset space \thinspace{}
\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
-cm.
- The change must be made before the multiple columns' start.
- The predefined value is 13
-\begin_inset space \thinspace{}
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-pt.
+\begin_layout Plain Layout
+Square
\end_layout
-\begin_layout Standard
-For this example
-\series bold
-
-\backslash
-multicolsep
-\series default
- was set to 2.5
-\begin_inset space \thinspace{}
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-cm:
+\begin_layout Plain Layout
+Square
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
+\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
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-setlength{
-\backslash
-multicolsep}{2.5cm}
+\begin_layout Plain Layout
+Star
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-
+\begin_layout Plain Layout
+Five-point star
\end_layout
-\begin_layout Begin Multiple Columns
-2
+\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
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\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.
+\begin_layout Plain Layout
+Candle
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+Burning candle
\end_layout
-\begin_layout Standard
-\begin_inset Note Greyedout
-status open
+\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
-\series bold
-Note:
-\series default
- The values you set with
-\series bold
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-\backslash
-setlength
-\series default
- will be used for all following multiple columns until to change them again.
+\begin_layout Plain Layout
+Drop down/up
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-
+\begin_layout Plain Layout
+Normal/reversed rain drop
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-
-
-\backslash
-setlength{
-\backslash
-multicolsep}{13pt}
+Fragile, calculation might fail
\end_layout
\end_inset
-
-
-\begin_inset Note Note
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-go back to the default
+TeX
\end_layout
\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_layout Subsubsection
-Column Separation
-\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\begin_layout Standard
-The width of the columns is automatically calculated, but you can modify
- the space between the columns.
- This is done by changing the length
-\series bold
+\begin_layout Plain Layout
+-
+\end_layout
-\backslash
-columnsep
-\series default
-.
- Its predefined value is 10
-\begin_inset space \thinspace{}
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-pt.
- Here is an example where
-\series bold
-
-\backslash
-columnsep
-\series default
- is set to 3
-\begin_inset space \thinspace{}
+\begin_layout Plain Layout
+Triangle up/down/
+\begin_inset Newline newline
\end_inset
-cm:
+left/right
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-
-
-\backslash
-setlength{
-\backslash
-columnsep}{3cm}
+Triangles in different orientations
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-
-\end_layout
-
-\begin_layout Begin Multiple Columns
-2
+\begin_layout Plain Layout
+-
\end_layout
-\begin_layout Standard
-
-\size small
-My observations of No.
-\begin_inset space \space{}
\end_inset
+</cell>
+</row>
+</lyxtabular>
-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
-\begin_layout End Multiple Columns
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-setlength{
-\backslash
-columnsep}{10pt}
+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 Standard
+\begin_inset Newpage newpage
\end_inset
-\begin_inset Note Note
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-go back to the default
+\begin_layout Standard
+Here is an example paragraph in the shape of a nut:
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
-\begin_layout Subsubsection
-Vertical Lines
+\begin_layout Nut
+
+\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
-Between the columns a rule with a width of the length
-\series bold
-
-\backslash
-columnseprule
-\series default
- is placed.
- If this rule width is set to 0
-\begin_inset space \thinspace{}
+\begin_inset VSpace bigskip
\end_inset
-pt (this is the default), the rule is suppressed.
- In the following example, the line separating the columns is 2
-\begin_inset space \thinspace{}
-\end_inset
-pt wide.
\end_layout
\begin_layout Standard
-\begin_inset ERT
+\begin_inset Note Greyedout
status open
\begin_layout Plain Layout
-
-\backslash
-setlength{
-\backslash
-columnseprule}{2pt}
+\series bold
+Note
+\series default
+: shapepar paragraphs cannot run over a page break.
\end_layout
\end_inset
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
-
-\size small
-\begin_inset Quotes eld
+\begin_inset VSpace bigskip
\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
-\size small
-I acknowledged that I was.
+\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
\begin_layout Standard
-
-\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
+\begin_inset Newpage newpage
\end_inset
\end_layout
-\begin_layout Standard
-
-\size small
-\begin_inset Quotes eld
-\end_inset
-
-You make too much of a trifle,
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Nut
- said I.
-
-\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
-May I ask how you knew who I was?
-\begin_inset Quotes erd
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-
-\size small
-\begin_inset Quotes eld
+An exception is the shape
+\family sans
+CDlabel
+\family default
+.
+ 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
-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 ~
+The
+\family sans
+drop
+\family default
+ shapes and the
+\family sans
+circle
+\family default
+ 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
-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?
+Arithmetic overflow
\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout End Multiple Columns
-
+.
+ 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
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+\begin_inset VSpace bigskip
+\end_inset
-\backslash
-setlength{
-\backslash
-columnseprule}{0pt}
\end_layout
+\begin_layout Standard
+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
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Plain Layout
-go back to the default
+\family default
+) to the corresponding text parts.
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
+\begin_layout Standard
+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 Standard
\begin_inset Newpage newpage
\end_inset
\end_layout
-\begin_layout Section
-Non-standard Paragraph Shapes
+\begin_layout Heart
+\noindent
+
+\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 ERT
-status collapsed
+\begin_inset VSpace bigskip
+\end_inset
-\begin_layout Plain Layout
+\end_layout
-\backslash
-begin{sloppypar}
+\begin_layout Standard
+\noindent
+\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
+
+\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
\end_inset
\end_layout
+\begin_layout Subsection
+Custom shapes
+\end_layout
+
\begin_layout Standard
-\begin_inset ERT
-status collapsed
+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"
+\end_inset
-\backslash
-newdimen
-\backslash
-varunit
+.
\end_layout
-\begin_layout Plain 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
-\backslash
-setlength{
-\backslash
-varunit}{4.5in}
+{}
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-\noindent
+X/LaT
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-
-\backslash
-parshape 19 0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
+{}
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.40
-\backslash
-varunit 0.300
-\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.35
-\backslash
-varunit 0.293
-\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.30
-\backslash
-varunit 0.300
-\backslash
-varunit
+{}
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.25
-\backslash
-varunit 0.317
-\backslash
-varunit
-\end_layout
+X/LaT
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
-0.20
-\backslash
-varunit 0.342
-\backslash
-varunit
+{}
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.15
-\backslash
-varunit 0.373
-\backslash
-varunit
-\end_layout
+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"
-0.10
-\backslash
-varunit 0.410
-\backslash
-varunit
-\end_layout
+\end_inset
-\begin_layout Plain Layout
-0.05
-\backslash
-varunit 0.453
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\end_inset
+
-0.00
-\backslash
-varunit 0.500
-\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.05
-\backslash
-varunit 0.453
-\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.10
-\backslash
-varunit 0.410
-\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.15
-\backslash
-varunit 0.373
-\backslash
-varunit
\end_layout
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
\begin_layout Plain Layout
-0.20
-\backslash
-varunit 0.342
-\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.25
-\backslash
-varunit 0.317
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-0.30
-\backslash
-varunit 0.300
-\backslash
-varunit
-\end_layout
-\begin_layout Plain Layout
+\end_layout
-0.35
-\backslash
-varunit 0.293
-\backslash
-varunit
+\begin_layout Standard
+Here is an example:
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-0.40
-\backslash
-varunit 0.300
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset CommandInset include
+LatexCommand input
+filename "SpecialParagraphShape.tex"
-0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
-\end_layout
+\end_inset
-\begin_layout Plain Layout
+\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
-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
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+A tip:
+\series default
+ to draw complexer shapes in
+\family sans
+Jpgfdraw
\family default
- is called for.
- As you can see, completely arbitrary shapes can be laid out with a suitable
- set of line length definitions.
- While this parshape may look a bit silly and useless, one could conceive
- of situations such as finely tuned dropped capitals, word wrapping around
- non-rectangular graphics, etc.
- which will benefit from such handcrafting.
+ you can draw the shape in a program of your choice and import the resulting
+ image to
+\family sans
+Jpgfdraw
+\family default
+.
+ Then you only need to draw a line or spline along the outline of the image.
\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
+The module
+\family sans
+Custom paragraph shapes
\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
+ also provides the two commands
+\family sans
+shapepar
\family default
and
-\family typewriter
-#nlength
+\family sans
+Shapepar
\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.
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
+ which can be used to define custom shapes coordinate by coordinate.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-
-\backslash
-end{sloppypar}
+These commands are internally used for all shapes described here.
\end_layout
\end_inset
+ 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
\end_inset
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-LaTeX-packages ! multicol
\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
projects / lyx.git / blobdiff