#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 431
+\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 1
+\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize 12
\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_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 numerical
+\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\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
\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
+Document\SpecialChar \menuseparator
View
\end_layout
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator
Update
\end_layout
\end_layout
\begin_layout Standard
-As the bibliography list is in a comment, LaTeX won't use use it and the
- references will look like this: [?], instead of like this: [1].
+As the bibliography list is in a comment, LaTeX won't use it and the references
+ will look like this: [?], instead of like this: [1].
One solution is to use the LaTeX-package
\begin_inset Flex Code
status collapsed
\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 the command-line based clientfound 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 aöso note that including the
+Please a
+\change_deleted 711066561 1405259326
+ö
+\change_inserted 711066561 1405259326
+l
+\change_unchanged
+so note that including the
\begin_inset Flex Code
status collapsed
\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
-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
\begin_layout Standard
Reverse search is triggered by SHIFT-click.
+\change_inserted 711066561 1405259853
+
+\end_layout
+
+\begin_layout Subsubsection*
+
+\change_inserted 711066561 1405273730
+Qpdfview (Unix)
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 711066561 1405263147
+Qpdfview supports SyncTeX since version 0.3.5.
+ Go to
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405260331
+Edit\SpecialChar \menuseparator
+Settings\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Behavior
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, click on the input field of the
+\begin_inset Quotes eld
+\end_inset
+
+Source editor
+\begin_inset Quotes erd
+\end_inset
+
+ item and add the command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 711066561 1405260473
+lyxclient -g %1 %2
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted 711066561 1405260506
+Reverse search is triggered by double-click.
+\change_unchanged
+
\end_layout
\begin_layout Subsubsection*
\begin_layout Standard
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
+You might want to set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+okular --unique
+\end_layout
+
+\end_inset
+
+ in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File
+\begin_inset space ~
+\end_inset
+
+Formats
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\change_inserted 711066561 1405264317
+, qpdfview
+\change_unchanged
+ and Sumatra
+\change_deleted 711066561 1405264282
+
+\change_unchanged
+PDF
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-For Sumatra CMCDDE is needed --- downloadable from
+
+\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 "http://www.istri.fr/zip/CMCDDE.zip"
+target "ftp://ftp2.commence.com/pub/freebies/"
\end_inset
\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
- 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
\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_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset Argument
+\begin_inset Argument status
status collapsed
\begin_layout Plain Layout
\family typewriter
chktex
\family default
- 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"
\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_layout
\begin_layout Standard
-LyX 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
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 the Messages pane if unsure.
Regular users of version control will appreciate VC toolbar, which can
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 Labeling
+\labelwidthstring 00.00.0000
+RCS
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Copy
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ci -q -u
+\family typewriter
+-i
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Undo Last Checkin
+\end_layout
+
+\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
rlog -r <file-name>
\family default
.
- For other details see
+ See
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:VCS-Revision-Information"
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_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
+
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+\end_layout
+
+\end_inset
+
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cd $path; cvs diff
+
\family typewriter
-"."
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
\end_inset
- (Ask if changes are detected.)
+
\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-cd $path; cvs -q update
+cvs -q add
\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
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$path
-\end_layout
+cvs -q remove
+\family typewriter
+\begin_inset Quotes eld
\end_inset
- stands for the path to the document.
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
-\begin_layout Subsubsection
+\end_inset
+
-\family sans
-Show History
+\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
+
+ stands for the path to the document.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
\end_layout
\begin_layout Standard
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
-One need to organize the files structure so that all external files are
- in the same directory or subdirectories of the document.
-
-\end_layout
-
+<file-name>
+\begin_inset Quotes erd
\end_inset
-.
- This become especially useful once you cooperate with people which neither
- know about subversion management nor they have ambition to commit additional
- material to the repository.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Update local directory from repository
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+<new-file-name>
+\begin_inset Quotes erd
\end_inset
- command updates the whole directory and in case of merge conflicts local
- version of the files are left, so no unintended data loss occurs.
- If local changes are detected user is warned before update starts.
-\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-SVN
-\begin_inset space ~
-\end_inset
+\end_layout
-commands:
-\begin_inset space ~
+\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.
+
+\end_layout
+
+\end_inset
+
+.
+ This become especially useful once you cooperate with people which neither
+ know about subversion management nor they have ambition to commit additional
+ material to the repository.
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
+\end_inset
+
+ command updates the whole directory and in case of merge conflicts local
+ version of the files are left, so no unintended data loss occurs.
+ If local changes are detected user is warned before update starts.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
\end_inset
\begin_inset Tabular
<lyxtabular version="3" rows="6" columns="2">
<features rotate="0" tabularvalignment="middle">
-<column alignment="center" valignment="top" width="0">
-<column alignment="center" valignment="top" width="0">
+<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
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_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
+GIT commands in LyX
\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.
+A minimal subset of GIT commands is now supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against GIT 1.7.
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Windows users please note that you need to ensure that git is on the path.
+ This can be set from within LyX at
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths\SpecialChar \menuseparator
+PATH prefix
+\family default
+.
\end_layout
-\begin_layout Standard
-As an example you can see how two TortoiseSVN commands could be integrated
- directly:
+\end_inset
+
+
\end_layout
-\begin_layout Description
-Commit:
+\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:commit /path:$$p"
+pull
\end_layout
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+push
\end_layout
-\begin_layout Description
-Revert:
+\end_inset
+
+ GIT commands.
+ LyX does not interact in any way with remote GIT repositories.
+ It works exclusively with the local repository in a very similar way as
+ with a central CVS or SVN repository.
+ If you use remote GIT repositories you need to do the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+pull
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+push
+\end_layout
+
+\end_inset
+
+ operations with your favourite GIT client.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Register
+\end_layout
+
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+\end_layout
+
+\begin_layout Standard
+This command registers in GIT your document ONLY in case you have already
+ the documents directory under GIT control (in particular
+\family typewriter
+.git/index
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+\end_layout
+
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
+
+\begin_layout Standard
+GIT command that is run:
+\family typewriter
+git add
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Read
+\family typewriter
+man git
+\family default
+ to understand the switches.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
+\end_layout
+
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
+
+\begin_layout Standard
+GIT command:
+\family typewriter
+git commit -q -m"<description>" <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Revert To Repository Version
+\end_layout
+
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+
+\begin_layout Standard
+GIT command:
+\family typewriter
+git checkout -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Rename
+\end_layout
+
+\begin_layout Standard
+This will rename the current document including the version history.
+ It requires a clean document without any changes since the last checkin.
+ You are asked for a file name and a description of the rename operation.
+ After that the document is renamed, both locally and in the repository.
+ If the parent directories of the new and old file names differ, all relative
+ paths of included files are adjusted (like in
+\family sans
+File\SpecialChar \menuseparator
+Save As
+\family default
+\SpecialChar \ldots{}
+).
+ Finally, the document is reloaded using the new name.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+GIT
+\begin_inset space ~
+\end_inset
+
+commands:
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git mv
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+<new-file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+git commit
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the GIT document.
+ The output of
+\family typewriter
+git log
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ is shown in a browser.
+\end_layout
+
+\begin_layout Subsubsection
+Version Info
+\end_layout
+
+\begin_layout Standard
+LyX supports GIT hash number of the last commit to the file, author name,
+ date and time of last commit.
+ All those are extracted from
+\family typewriter
+git log -n 1 --pretty=format:%H%n%an%n%ai
+\family default
+.
+ Tree version information is obtained via
+\family typewriter
+git describe --abbrev --dirty --long
+\family default
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
+
+\end_inset
+
+ for other details.
+\end_layout
+
+\begin_layout Subsection
+Further tuning
+\end_layout
+
+\begin_layout Standard
+With the recent addition of the vc-command function LyX power users are
+ allowed to create their own commands for revision control.
+\end_layout
+
+\begin_layout Standard
+As an example you can see how two TortoiseSVN commands could be integrated
+ directly:
+\end_layout
+
+\begin_layout Description
+Commit:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Revert:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
\end_layout
\end_inset
in dialog, numbers always point to the last number in RCS revision number,
i.e.
'35' in '1.2.35'.
+ We don't currently support GIT addressing of revisions, one can just compare
+ edited document with its revision X steps backs, where X is addressed as
+ HEAD~X.
\end_layout
\begin_layout Section
\end_layout
\begin_layout Subsection
-LyX and Literate Programming
+LyX and Literate Programming with Noweb
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Paragraph
-Selecting the document class
+Using the noweb module
\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
+ document, after you have chosen its document class, use the Document->Settings
+ menu to add the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-Article (Noweb)
-\end_layout
+noweb
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-Book (Noweb)
-\end_layout
-
-\begin_layout Itemize
-Report (Noweb)
-\end_layout
-
-\begin_layout Standard
-You must select one of them to create your literate documents from.
-
-\end_layout
+ module.
+ If Noweb is correctly installed, when you click on the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Note that literate documents are not limited to these three classes.
- New classes can be generated from other styles like letter or in combination
- with other class variations like Article (AMS).
- If you have special needs that cannot be covered by one of the existing
- classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
- will arrange to insert a new entry, or teach you how to do it.
-\begin_inset Foot
-status collapsed
+Modules
+\begin_inset Quotes erd
+\end_inset
-\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.
-\end_layout
+ link, you will see the
+\begin_inset Quotes eld
+\end_inset
+noweb
+\begin_inset Quotes erd
\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.
+ module in the available list and you can add it to your document.
\end_layout
\begin_layout Paragraph
\begin_layout Standard
LyX enables you to write code with a layout named
-\noun on
-Scrap
-\noun default
-.
-\begin_inset Foot
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-The equivalent Noweb term is
-\begin_inset Quotes eld
-\end_inset
-
Chunk
-\begin_inset Quotes erd
-\end_inset
-
-.
- For historical reasons, I got used to the term
-\begin_inset Quotes eld
-\end_inset
-
-scrap
-\begin_inset Quotes erd
-\end_inset
-
- introduced by other literate tool named Nuweb, which I used for many years
- before rendering myself to Noweb.
\end_layout
\end_inset
- Noweb delimits scraps like this:
+.
+ Noweb delimits chunks like this:
\end_layout
\begin_layout LyX-Code
-<<My scrap>>=
+<<My code>>=
\end_layout
\begin_layout LyX-Code
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
-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.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout LyX-Code
-<<My scrap>>=
-\begin_inset Newline newline
-\end_inset
-
- code
-\begin_inset Newline newline
-\end_inset
-
- more code
-\begin_inset Newline newline
-\end_inset
-
- even more code
-\begin_inset Newline newline
-\end_inset
-
- @
-\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
+ This is also handled by
+\begin_inset Flex Noun
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
-
- to fix that.
+Chunk
\end_layout
\end_inset
-
+, that works like a normal paragraph but has a free spacing capability.
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
+ construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
rence:
\end_layout
\begin_layout LyX-Code
-<<My scrap>>=
-\begin_inset Newline newline
-\end_inset
+<<My chunk>>=
+\end_layout
- def some_function(args):
-\begin_inset Newline newline
-\end_inset
+\begin_layout LyX-Code
+def some_function(args):
+\end_layout
- "This is the doc string for this function."
-\begin_inset Newline newline
-\end_inset
+\begin_layout LyX-Code
+ "This is the doc string for this function."
+\end_layout
- print "My args: ", args
+\begin_layout LyX-Code
+ print "My args: ", args
\end_layout
\begin_layout LyX-Code
\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.
+ Given that you formatted the code using the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Chunk
+\end_layout
+
+\end_inset
+
+ layout that, by itself, takes care of the business.
\end_layout
\begin_layout Enumerate
\begin_inset Quotes erd
\end_inset
- setting, should be set to
+ setting, should be set to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\family typewriter
build-script $$i
\family default
-
+ $$r
\begin_inset Quotes erd
\end_inset
.
- This basically means that LyX will call
+\begin_inset Newline newline
+\end_inset
+
+This basically means that LyX will call
\begin_inset Quotes eld
\end_inset
\end_inset
(a program or script) with the name of the Noweb file (normally a file
- in the LyX temp directory).
+ in the LyX temp directory) and the directory path of the original LyX file.
\end_layout
that you can place in a directory on your path:
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage pagebreak
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\family sans
#!/bin/sh
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+
+\family sans
#
\end_layout
-\begin_layout LyX-Code
-notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
+\begin_layout Standard
+
+\family sans
+notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- which is to be set to
+ which is to be set to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\family typewriter
-parselog=listerrors
+parselog=$$s/scripts/listerrors
\family default
\begin_inset Quotes erd
\end_inset
.
- This will run any errors that are generated by the
-\begin_inset Quotes eld
-\end_inset
-
-build-script
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
- process through the
+This will run any errors that are generated by the
\begin_inset Quotes eld
\end_inset
-listerrors
+build-script
\begin_inset Quotes erd
\end_inset
- program.
-\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
+ process through the
\begin_inset Quotes eld
\end_inset
\family default
conversion may produce several files, and so most of these would then be
deleted when LyX was closed.
- The present solution is to use a `copier',
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-See section
-\emph on
-Copiers
-\emph default
- of the
-\emph on
-Customization
-\emph default
- manual for information on these.
-\end_layout
-
-\end_inset
-
- in this case, the
-\family typewriter
-ext_copy.py
-\family default
- script in its default mode, so that the entire contents of the temporary
- directory is copied.
- More will get copied than is needed, to be sure, but nothing will be lost.
- If, however, you know what extensions the generated files will have, this
- can be improved by using the
-\family typewriter
--e
-\family default
- option to
-\family typewriter
-ext_copy
-\family default
-.
- This option takes a comma-separated list of extensions to copy.
- So, for example, if the conversion will generate only files with the extensions
-
-\family typewriter
-.c
-\family default
- and
-\family typewriter
-.h
-\family default
-, then the correct definition would be:
-\end_layout
-
-\begin_layout LyX-Code
-python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
-\end_layout
-
-\begin_layout Standard
-The result will be that only files with these two extensions will be copied
- out.
+ This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
+ the build-script chunk can place the generated files in that location.
\end_layout
\begin_layout Paragraph
\begin_inset Quotes erd
\end_inset
- scrap.
+ chunk.
Generally, the instructions for building your program should be embedded
- in a scrap of its own.
+ in a chunk of its own.
The noweb-specific
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- above uses the notangle command to look for this scrap (called
+ above uses the notangle command to look for this chunk (called
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-Typically, such a scrap would look something like this:
+Typically, such a chunk would look something like this:
\end_layout
\begin_layout LyX-Code
<<build-script>>=
-\begin_inset Newline newline
-\end_inset
+\end_layout
+\begin_layout LyX-Code
#!/bin/sh
\begin_inset Newline newline
\end_inset
-
-\begin_inset Newline newline
-\end_inset
-
if [ -z "${NOWEB_SOURCE}" ]
\begin_inset Newline newline
\end_inset
then
-\begin_inset Newline newline
-\end_inset
+\end_layout
- NOWEB_SOURCE=myfile.nw
+\begin_layout LyX-Code
+NOWEB_SOURCE=myfile.nw
\begin_inset Newline newline
\end_inset
\end_inset
[...
- code to extract files ...]
+ code to extract files ...
+ use NOWEB_OUTPUT_DIR here ...]
\begin_inset Newline newline
\end_inset
\begin_inset Quotes eld
\end_inset
-Conversion
+File Handling
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-literate
+NoWeb
\begin_inset Quotes erd
\end_inset
\begin_inset space ~
\end_inset
-format Set up via the Formats tab, this is where the Noweb-specific pieces
- are set up.
+format Set up via the File Formats tab, this is where the Noweb-specific
+ pieces are set up.
The
\family sans
GUI Name
\family typewriter
build-script $$i
\family default
-
+ $$r
\begin_inset Quotes erd
\end_inset
-, with Flags set to
+, with Flags set to
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\family typewriter
-originaldir,parselog=listerrors
+parselog=$$s/scripts/listerrors
\family default
\begin_inset Quotes erd
\end_layout
\begin_layout Standard
-I take advantage of the new created LyX server function and this ddd feature,
+I take advantage of the newly created LyX server function and this ddd feature,
and set
\begin_inset Quotes eld
\end_inset
to:
\end_layout
-\begin_layout LyX-Code
+\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 you forward this information to LyX through the LyX server and then
+ 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
\family default
, and
\family sans
-Scrap
+Chunk
\family default
.
The last one is a short cut to the
In my toolbar I like to combine the six short cuts above with two more:
One for
\family sans
-View
+Document
\family default
\SpecialChar \menuseparator
\family default
and the other for
\family sans
+Document\SpecialChar \menuseparator
View\SpecialChar \menuseparator
DVI
\family default
\end_layout
\begin_layout LyX-Code
- Icon "layout Scrap"
+ Icon "layout Chunk"
\end_layout
\begin_layout LyX-Code
\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
+ 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
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 Chapter
-Special features
+\begin_layout Subsection
+LyX and knitr/Sweave
\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
+Support for
+\family sans
+knitr
+\family default
+ and
+\family sans
+Sweave
+\family default
+ is documented in the
\emph on
-Embedded
-\begin_inset space ~
+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
\series bold
multicol
\series default
-
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-LaTeX-packages ! multicol
-\end_layout
-
-\end_inset
-
installed.
\end_layout
\begin_inset space ~
\end_inset
-columns in your text, use the style
+columns in your text, insert a multicolumn inset via the menu
\family sans
-Begin Multiple Columns
-\family default
- where the columns should start.
- The content of the style is the number of the columns, so in this case
- use a
-\begin_inset Quotes eld
+Insert\SpecialChar \menuseparator
+Custom
+\begin_inset space ~
\end_inset
-2
-\begin_inset Quotes erd
+Insets\SpecialChar \menuseparator
+Multiple
+\begin_inset space ~
\end_inset
-.
- At the point where the columns should end use the style
-\family sans
-End Multiple Columns
+Columns
\family default
- and keep it empty.
+ 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 Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
\noindent
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
+\noindent
\series bold
\size small
\begin_inset Newline newline
\end_inset
-by
-\noun on
-Sir Arthur Conan Doyle
+by Sir Arthur Conan Doyle
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
It was in the spring of the year 1894 that all London was interested, and
only withdrawn upon the third of last month.
\end_layout
-\begin_layout End Multiple Columns
+\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 Begin Multiple Columns
+\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
-\begin_layout Standard
+\end_inset
-\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.
as they were known to the public at the conclusion of the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
You can also have columns inside columns:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\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 427 Park Lane.
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
+\begin_layout Plain Layout
+\begin_inset Flex Multiple Columns
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\size footnotesize
The youth moved in the best society–had, so far as was known, no enemies
on the night of March 30, 1894.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size footnotesize
Ronald Adair was fond of cards–playing continually, but never for such stakes
So much for his recent history as it came out at the inquest.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\series bold
multicol
\series default
-
-\begin_inset Index idx
-status collapsed
-
-\begin_layout Plain Layout
-LaTeX-packages ! multicol
-\end_layout
-
-\end_inset
-
,
\begin_inset CommandInset citation
LatexCommand cite
\end_layout
\begin_layout Standard
-To add a preface text for multiple columns, add the command
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-}[
-\end_layout
-
-\begin_layout Standard
-as TeX Code behind the number of columns in the
+To add a preface text for multiple columns, set the cursor into the multicolumn
+ inset and use the menu
\family sans
- Begin Multiple Columns
+Insert\SpecialChar \menuseparator
+Preface
\family default
- style.
- Behind the command follows the preface text.
- At the end of the style use the command
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-]{
-\end_layout
+.
+ Write your preface text into that inset.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-as TeX Code.
- An example with some preface text:
+This is an example with some preface text:
\end_layout
\begin_layout Standard
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
\begin_layout Plain Layout
-
-}[
-\end_layout
-
-\end_inset
-
-And the story continues and continues and continues and continues\SpecialChar \ldots{}
-
-\begin_inset ERT
-status collapsed
+\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
-\end_layout
-
-\begin_layout Standard
-
\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.
no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout End Multiple Columns
+\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.
+ as TeX Code.
For example the command
\end_layout
In this example the preface is a subsubsection:
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
\begin_layout Plain Layout
+\begin_inset Argument 2
+status open
-}[
-\end_layout
-
-\end_inset
-
-
+\begin_layout Plain Layout
\begin_inset ERT
status collapsed
\end_inset
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-]{
\end_layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\size small
A minute examination of the circumstances served only to make the case more
complex.
No one had heard a shot.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\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
+If there is less vertical space than 6
\begin_inset space ~
\end_inset
-text lines, a page break will be inserted before the multiple columns.
+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 value.
- It is determined by inserting the command
-\end_layout
-
-\begin_layout Standard
+ 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
-\series bold
-][number
-\backslash
-baselineskip
-\end_layout
+Before
+\begin_inset space ~
+\end_inset
-\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
+Page
\begin_inset space ~
\end_inset
-text lines:
-\end_layout
+Break
+\family default
+.
+ Insert into that inset the amount of space like e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Plain Layout
-}[
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+5cm
+\begin_inset Quotes erd
\end_inset
+.
+\begin_inset Newline newline
+\end_inset
-\begin_inset ERT
-status collapsed
+In this example the space is set to 7
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
+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
-subsubsection{
+baselineskip
+\series default
+ needs to be inserted as TeX code):
\end_layout
-\end_inset
-
-This is the sectioning command
-\begin_inset Newline newline
-\end_inset
+\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
-as a preface and
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+\begin_inset Argument 3
+status open
-with multiple text lines
+\begin_layout Plain Layout
+7
\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-}
-\end_layout
-
-\end_inset
-
-
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-][7
\backslash
baselineskip
\end_layout
\end_inset
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-]{
\end_layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-
\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.
no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\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
me, and I knocked down several books which he was carrying.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\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 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
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
My observations of No.
precious volumes, a dozen of them at least, wedged under his right arm.
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\end_inset
pt (this is the default), the rule is suppressed.
- In the following example the line is 2
+ In the following example the rule is 2
\begin_inset space \thinspace{}
\end_inset
\end_layout
-\begin_layout Begin Multiple Columns
-2
-\end_layout
-
\begin_layout Standard
+\begin_inset Flex Multiple Columns
+status open
+
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
said he, in a strange, croaking voice.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
I acknowledged that I was.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\size small
\begin_inset Quotes eld
\end_layout
-\begin_layout End Multiple Columns
+\end_inset
+
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+\begin_inset VSpace defskip
+\end_inset
-\backslash
-setlength{
-\backslash
-columnseprule}{0pt}
\end_layout
+\begin_layout Standard
+The rule can be colored by redefining the command
+\series bold
+
+\backslash
+columnseprulecolor
+\series default
+.
+ This is done by inserting the command
+\begin_inset Newline newline
\end_inset
-\begin_inset Note Note
-status collapsed
+\series bold
-\begin_layout Plain Layout
-go back to the default
-\end_layout
+\backslash
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+color{red}}
+\series default
+\begin_inset Newline newline
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Newpage newpage
+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
-\end_layout
-
-\begin_layout Section
-Non-standard Paragraph Shapes
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+\series bold
\backslash
-begin{sloppypar}
-\end_layout
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\series default
+\begin_inset Newline newline
\end_inset
+Here is the example with a cyan rule and 1
+\begin_inset space \thinspace{}
+\end_inset
+cm column separation:
\end_layout
\begin_layout Standard
\begin_inset ERT
-status collapsed
+status open
\begin_layout Plain Layout
\backslash
-newdimen
+setlength{
\backslash
-varunit
+columnsep}{1cm}
\end_layout
\begin_layout Plain Layout
\backslash
-setlength{
+renewcommand{
\backslash
-varunit}{4.5in}
+columnseprulecolor}{
+\backslash
+color{cyan}}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-\noindent
-\begin_inset ERT
-status collapsed
+\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
+
+
+\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 Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+
+\backslash
+setlength{
+\backslash
+columnseprule}{0pt}
+\end_layout
\begin_layout Plain Layout
\backslash
-parshape 19 0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
+renewcommand{
+\backslash
+columnseprulecolor}{
+\backslash
+normalcolor}
+\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 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
+
+\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
+
+\begin_layout Plain Layout
+Name
+\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
+Description
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Annotation
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+CDlabel
+\end_layout
+
+\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
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Cannot be scaled, take care there is not too much text
+\end_layout
+
+\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
+
+\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
+
+\begin_layout Plain Layout
+Diamond
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Rhomboid (symbolizing a
+\begin_inset Quotes eld
+\end_inset
+
+diamond
+\begin_inset Quotes erd
+\end_inset
+
+)
+\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
+
+\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
+
+\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
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Hexagon
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Hexagon
+\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
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Nut
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Nut for bolt (hexagon with circular hole)
+\end_layout
+
+\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" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Square
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Square
+\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
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+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
+
+\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
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Candle
+\end_layout
+
+\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
+
+\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" leftline="true" usebox="none">
+\begin_inset Text
+
+\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
+
+\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
+
+\begin_layout Plain Layout
+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
+
+\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
+
+\begin_layout Plain Layout
+Triangle up/down/
+\begin_inset Newline newline
+\end_inset
+
+left/right
+\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
+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
+
+\begin_layout Plain Layout
+-
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+To use a shape for your paragraph, simply select it in LyX's pull-down box
+ for environments in the toolbar.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\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 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
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Plain Layout
+
+\series bold
+Note
+\series default
+: shapepar paragraphs cannot run over a page break.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+shapepar
+\series default
+ takes care that the shape will always be preserved, no matter how much
+ text is in the paragraph.
+ Therefore the paragraph size changes with the amount of contained text.
+ This can lead to paragraph sizes exceeding the page margins.
+ To demonstrate the size scaling, here is the same example paragraph but
+ with twice as much text:
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\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.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+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
+
+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
+
+Arithmetic overflow
+\begin_inset Quotes erd
+\end_inset
+
+.
+ 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 VSpace bigskip
+\end_inset
+
+
+\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
+
+
+\family default
+) to the corresponding text parts.
\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
+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
+
-0.35
-\backslash
-varunit 0.293
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Heart
+\noindent
-0.30
-\backslash
-varunit 0.300
-\backslash
-varunit
+\lang latin
+Lo\SpecialChar \-
+rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-0.25
-\backslash
-varunit 0.317
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\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
-0.20
-\backslash
-varunit 0.342
-\backslash
-varunit
+\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 Plain Layout
+\end_inset
+
-0.15
-\backslash
-varunit 0.373
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Subsection
+Custom shapes
+\end_layout
-0.10
-\backslash
-varunit 0.410
-\backslash
-varunit
+\begin_layout Standard
+You can define any shape you want.
+ Doing this manually is a lot of work because every coordinate must be specified.
+ But there is a way to let the computer calculate the coordinates:
\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
+Install the program
+\begin_inset CommandInset href
+LatexCommand href
+name "Jpgfdraw"
+target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
-0.05
-\backslash
-varunit 0.453
-\backslash
-varunit
+\end_inset
+
+.
\end_layout
+\begin_layout Enumerate
+In
+\family sans
+Jpgfdraw
+\family default
+ go to the menu
+\family sans
+Te
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.00
-\backslash
-varunit 0.500
-\backslash
-varunit
+{}
\end_layout
+\end_inset
+
+X/LaT
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.05
-\backslash
-varunit 0.453
-\backslash
-varunit
+{}
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.10
-\backslash
-varunit 0.410
-\backslash
-varunit
+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
+
+pt.
\end_layout
+\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.15
-\backslash
-varunit 0.373
-\backslash
-varunit
+{}
\end_layout
+\end_inset
+
+X/LaT
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.20
-\backslash
-varunit 0.342
-\backslash
-varunit
+{}
\end_layout
+\end_inset
+
+eX\SpecialChar \menuseparator
+Shapepar
+\family default
+ to export the shape to coordinates.
+ In the appearing dialog use either the outline of your shape for the coordinate
+s or the path itself.
+\begin_inset Foot
+status collapsed
+
\begin_layout Plain Layout
+For more information see
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
+
+\end_inset
+
-0.25
-\backslash
-varunit 0.317
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\end_inset
+
-0.30
-\backslash
-varunit 0.300
-\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.35
-\backslash
-varunit 0.293
-\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.40
-\backslash
-varunit 0.300
-\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.45
-\backslash
-varunit 0.332
-\backslash
-varunit
\end_layout
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
\begin_layout Plain Layout
+\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
\end_inset
-There are times when the tyranny of rectangular paragraphs must be overthrown.
- In such situations, a call to the delightful plain TeX command
-\family typewriter
-\backslash
-parshape
-\family default
- is called for.
- As you can see, completely arbitrary shapes can be laid out with a suitable
- set of 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.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-The syntax is
-\family typewriter
+Here is an example:
+\end_layout
-\backslash
-parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
- #nindent #nlength
-\family default
-, where
-\family typewriter
-numlines
-\family default
- is the number of lines of text which define the paragraph.
- If there turn out to be fewer lines, the shape is truncated; if there are
- more, the excess lines have the same dimensions as the last line of the
- definition.
- The
-\family typewriter
-#nindent
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset CommandInset include
+LatexCommand input
+filename "SpecialParagraphShape.tex"
+
+\end_inset
+
+
+\lang latin
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+ At vero eos et accusam et justo duo dolores et ea rebum.
+ Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
+ sit amet.
+ Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
+ eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+ voluptua.
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+A tip:
+\series default
+ to draw complexer shapes in
+\family sans
+Jpgfdraw
\family default
- and
-\family typewriter
-#nlength
+ you can draw the shape in a program of your choice and import the resulting
+ image to
+\family sans
+Jpgfdraw
\family default
- entries specify the indentation of the line from the left margin, and the
- length of the line as measured from that point.
- The shape applies only to the current paragraph; everything is reset to
- normal for the next paragraph.
+.
+ Then you only need to draw a line or spline along the outline of the image.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
+\begin_inset VSpace bigskip
+\end_inset
-\begin_layout Plain Layout
+\end_layout
-\backslash
-end{sloppypar}
+\begin_layout Standard
+The module
+\family sans
+Custom paragraph shapes
+\family default
+ also provides the two commands
+\family sans
+shapepar
+\family default
+ and
+\family sans
+Shapepar
+\family default
+ which can be used to define custom shapes coordinate by coordinate.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+These commands are internally used for all shapes described here.
\end_layout
\end_inset
+ 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