-#LyX 2.0 created this file. For more info see http://www.lyx.org/
-\lyxformat 413
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 459
\begin_document
\begin_header
\textclass scrbook
\cleardoublepage
\pagenumbering{arabic}}
-% used for multi-column text
-\usepackage{multicol}
-
% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
\end_preamble
theorems-ams
theorems-ams-extended
multicol
+shapepar
\end_modules
\maintain_unincluded_children false
\begin_local_layout
\font_roman default
\font_sans default
\font_typewriter default
+\font_math auto
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
-
\graphics default
\default_output_format default
\output_sync 0
\pdf_backref false
\pdf_pdfusetitle false
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
-\papersize default
+\papersize a4paper
\use_geometry false
-\use_amsmath 1
-\use_esint 0
-\use_mhchem 1
-\use_mathdots 1
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package 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
+\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\justification true
\use_refstyle 0
+\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
User's Guide\SpecialChar \@.
\emph default
- The reason for separating this document out is simple: the
+ The reason for separating the two documents is simple: the
\emph on
User's Guide
\emph default
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Format
+View
\end_layout
\end_inset
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Update\SpecialChar \menuseparator
-Format
+Update
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-If you've run LaTeX using
+If you have run LaTeX using
\begin_inset Flex MenuItem
status collapsed
\end_inset
, LyX then runs a DVI viewer to display the DVI-file.
- If you've used
+ If you have used
\begin_inset Flex MenuItem
status collapsed
TeX Code
\end_layout
+\end_inset
+
+ or the keyboard shortcut
+\begin_inset Info
+type "shortcut"
+arg "ert-insert"
\end_inset
.
\begin_inset Newline newline
\end_inset
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You
\begin_inset Newline newline
\end_inset
box containing this text is directly after this paragraph.
Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\begin_inset ERT
-status collapsed
+status open
\begin_layout Plain Layout
\begin_layout Plain Layout
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\end_layout
\end_inset
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Itemize
-Beware reinventing the wheel.
+Beware of reinventing the wheel.
\end_layout
\begin_layout Standard
\end_inset
- for details, and see chapter
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
+ for details.
\end_layout
\begin_layout Standard
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
+ In addition to providing special commands, the inclusion of a package can
+ change the document.
For example, the package
\begin_inset Flex Code
status collapsed
\begin_inset Newline newline
\end_inset
-There are several LaTeX counters and variables which
+There are several LaTeX counters and variables that
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- (There are variables which you can set and reset inside the document, too.)
- Margins are a good example of something which must be set in the preamble.
+ (There are variables that you can set and reset inside the document, too.)
+ Margins are a good example of something that must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\begin_layout Standard
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
- Also, there are more examples and an assortment of LaTeX
-\begin_inset Quotes eld
-\end_inset
-
-dirty tricks
-\begin_inset Quotes erd
-\end_inset
-
- given in Chapter
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
-
\end_layout
\begin_layout Section
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
It then uses the logfile from the LaTeX run to do a post-mortem.
- After analyzing the logfile,LyX displays a dialog listing the errors.
+ After analyzing the logfile, LyX displays a dialog listing the errors.
Clicking on any one of them will take you to the position in your LyX file
where the error occurred.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
- LaTeX Error: File
+LaTeX Error: File
\begin_inset Quotes els
\end_inset
\end_inset
-, than the established
+, then the established
\begin_inset Flex Code
status collapsed
.
You are free to use the same or different styles for each section.
- Additionally, you can chose if the bibliography section should contain
+ Additionally, you can choose if the bibliography section should contain
\begin_inset Quotes eld
\end_inset
\end_inset
- removes the bibliography title, you have manually re-add that, too (as
+ removes the bibliography title, you have to manually re-add that, too (as
a chapter* or section*, for instance).
\end_layout
\end_inset
(those commands have to be inserted as TeX code).
- The bibliography will contain all references which have been cited in the
+ The bibliography will contain all references that have been cited in the
current
\begin_inset Flex Code
status collapsed
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
+ that files that are
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- are typeset beginning on a new page, while files which are
+ are typeset beginning on a new page, while files that are
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
+g, while the included files are converted to LaTeX files that do not have
all the preamble information.
\end_layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
First, open all the files in question: let's call them A and B in a two
file example, where B is included in A.
Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
+ Open the cross-reference dialog whilst in document B, and you can select
the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-As the bibliography list is in a comment, LaTeX won't use use it and the
- references will look like this: [?], instead of like this: [1].
+As the bibliography list is in a comment, LaTeX won't use it and the references
+ will look like this: [?], instead of like this: [1].
One solution is to use the LaTeX-package
\begin_inset Flex Code
status collapsed
\begin_layout Standard
You will now see your name in the upper left.
If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer, simply include a command
+ the page number appears in the central footer) simply include a command
with a blank argument, e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Standard
The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+ The following table shows the mappings from button name to LaTeX package.
\end_layout
\begin_layout Standard
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
-<features tabularvalignment="middle">
+<features rotate="0" tabularvalignment="middle">
<column alignment="center" valignment="top" width="0pt">
<column alignment="center" valignment="top" width="0pt">
<row>
\begin_inset CommandInset href
LatexCommand href
name "accessed online"
-target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
+target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
\end_inset
\end_layout
\begin_layout Standard
-Another useful tool is command-line based client you will find in
+Another useful tool is the command-line based clientfound in
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-In most cases LyX will do the work for you by enabling
+In most cases LyX will do the work for you by enabling the option
\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Output\SpecialChar \menuseparator
Synchronize with Output
\end_layout
+\end_inset
+
+ in the menu
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
+\end_layout
+
\end_inset
.
\end_layout
\begin_layout Standard
-Please note that including the
+Note that the method
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=1
+\end_layout
+
+\end_inset
+
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+synctex=-1
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Please aöso note that including the
\begin_inset Flex Code
status collapsed
\end_inset
.
+
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-The
+Note that the option
\begin_inset Flex Code
status collapsed
\end_inset
- select Ly
-\begin_inset ERT
+ choose
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
+custom
+\end_layout
-{}
+\end_inset
+
+ preset and enter command
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+/Applications/LyX.app/Contents/MacOS/lyxeditor
\end_layout
\end_inset
-X.
+.
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+SumatraPDF -inverse-search "lyxeditor -g %f %l"
\end_layout
\end_inset
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-SumatraPDF.sh
-\end_layout
-
-\end_inset
-
- is the following script (to be placed in your command PATH,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-/usr/local/bin
-\end_layout
-
-\end_inset
-
- being the best choice):
-\end_layout
-
-\begin_layout LyX-Code
-#!/bin/bash
-\begin_inset Newline newline
-\end_inset
-
-cd $(dirname $1)
-\begin_inset Newline newline
-\end_inset
-
-SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
-\end_layout
-
-\begin_layout Standard
-This wrapper script is needed because SumatraPDF is a native Windows application
- and does not understand the posix paths used by the Cygwin version of LyX.
- If SumatraPDF.exe is not in your command PATH, use its full posix path in
- the script above.
+.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path.
The
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
- to reverse search.
+ of reverse search.
It allows you to let the viewer jump to a given position from within LyX.
If forward search is set up (as described in what follows), you can put
the cursor anywhere in your LyX document, and hit
can select from the drop down list.
If none of these configurations suits you, you have to find out and enter
a suitable configuration yourself.
- The definition syntax uses the following placeholders:
+ The definition syntax uses the following placeholders:
\end_layout
\begin_layout Itemize
\end_inset
-: name of the (temporary) exported .tex file
+: name of the (temporary) exported .tex file (without path)
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$f
+\end_layout
+
+\end_inset
+
+: name of the (temporary) exported .tex file (including path)
\end_layout
\begin_layout Itemize
\begin_layout Standard
Note that only some of the viewers provide full forward search functionality,
- among them yap, xdvi, okular and Sumatra PDF
+ among them yap, xdvi, okular and Sumatra PDF.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
-ip
+For Sumatra CMCDDE is needed --- downloadable from
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.istri.fr/zip/CMCDDE.zip"
+
+\end_inset
+
+
\end_layout
\end_inset
-.
While many of the widespread PDF viewers (most notably Adobe Reader) do
not support forward search at all, some other viewers -- e.
\begin_inset space \thinspace{}
\end_inset
.
- These latter functionality is provided by an external call of synctex (see
+ This latter functionality is provided by an external call of synctex (see
the predefined example configurations).
\end_layout
\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
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\emph on
\begin_inset space \space{}
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
+, lots will probably never be supported, due to the limitations of LyX's
+ framework.
Of course you can still use all features with the help of some native LaTeX
commands (TeX code
\begin_inset Foot
\end_inset
).
- In this section, we can only list those features which are natively supported
+ In this section, we can only list those features that are natively supported
by LyX.
For detailed descriptions (and for the rest of features) we recommend you
have a look at the detailed manual of the Memoir class
\begin_inset Quotes erd
\end_inset
-, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-without pagina).
+).
If you want an empty title page, type
\family typewriter
\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset Argument
+\begin_inset Argument status
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\family typewriter
chktex
\family default
- it from CTAN,
+ from CTAN,
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset CommandInset href
LatexCommand href
target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
\begin_inset Newline newline
\end_inset
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
+If you have bad luck, the text will break right between the referenced text
+ and reference number, and that's a pity.
See section
\begin_inset CommandInset ref
LatexCommand ref
\family sans
ChkTeX
\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
+, and this gap can make some warnings seem arcane or just plain silly.
\end_layout
\begin_layout Standard
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
+ to the internal document structure, some of the warnings will not appear
+ correctly.
There are two things you can do about this:
\end_layout
ChkTeX
\family default
invocation command line in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Outputs
-\family default
-,
-\family sans
-Misc
-\family default
-), or the global
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+LaTeX\SpecialChar \menuseparator
+CheckTeX command
+\end_layout
+
+\end_inset
+
+, or the global
\family sans
ChkTeX
\family default
).
See below to learn what warnings can be enabled and disabled on the command
line.
-
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- it.
- This angered me a bit, so I thought that I should at least make support
- for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has been done.
- LyX now supports some of the most basic RCS/CVS/SVN commands.
+LyX supports some of the most basic RCS/CVS/SVN commands.
If you need something a bit more sophisticated you will have to do that
manually in a terminal.
\end_layout
\begin_layout Standard
-Also note that CVS support is not as good as subversion support so we advice
+Also note that CVS support is not as good as subversion support so we advise
using SVN instead.
- Good place to start with Subversion is SVN Book
+ A good place to start learning Subversion is SVN Book
\begin_inset Foot
status open
\end_inset
.
- In case of RCS you should read
+ In the case of RCS you should read
\begin_inset Quotes eld
\end_inset
The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
package—no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
- you can check them in Messages pane if unsure.
+ you can check them in the Messages pane if unsure.
+ Regular users of version control will appreciate VC toolbar, which can
+ be enabled via
+\family sans
+View\SpecialChar \menuseparator
+Toolbars\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+.
\end_layout
\begin_layout Standard
Control
\family default
submenu.
- LyX was tested against RCS 5.7.
+ LyX was tested against RCS 5.7/5.8
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Note that old DOS / MS Windows builds (5.7) need to setup environment variables
+ in order to work properly with LyX.
+ In particular time zone (TZ) should be set and more importantly RCSINIT
+ in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
+ expects archive to be found in file.lyx,v within the original document directory.
+ See also README shipped with Windows RCS binaries.
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Subsubsection
\end_inset
- in case you have already the documents directory under CVS control (in
- particular
+ in the case you have already the documents directory under CVS control
+ (in particular
\family typewriter
CVS/Entries
\family default
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="6" columns="2">
-<features tabularvalignment="middle">
+<features rotate="0" tabularvalignment="middle">
<column alignment="center" valignment="top" width="0">
<column alignment="center" valignment="top" width="0">
<row>
new project
\family default
in Windows Explorer, right click it, and select
-\family typewriter
-TortoiseSVN > Repo-browser
+\family sans
+TortoiseSVN\SpecialChar \menuseparator
+Repo-browser
\family default
.
If necessary, adjust the URL for the repository, then click OK.
\begin_layout Enumerate
Right click the level of the repository under which you want to place the
new project folder (typically the top level) and click
-\family typewriter
-Create folder\SpecialChar \ldots{}
-
+\family sans
+Create folder
\family default
Supply a name for the project folder and click OK.
Add a message for the log file if desired, then click OK again.
\begin_layout Enumerate
Create or open your document in LyX and click
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-V
-\bar default
-ersion
+File\SpecialChar \menuseparator
+Version
\begin_inset space ~
\end_inset
Control\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-egister.
+Register.
\family default
Add a log message and click OK to commit the document to version control.
\begin_layout Standard
From this point onward, you should have full functionality in the
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-V
-\bar default
-ersion
+File\SpecialChar \menuseparator
+Version
\begin_inset space ~
\end_inset
\end_layout
\begin_layout Standard
-Compared with Linux setting up svn client to communicate over ssh under
+Compared with Linux setting up an svn client to communicate over ssh under
Windows is a rather troublesome task.
We will at least offer some hints how to setup the client side but prior
knowledge about ssh and the Windows command line is needed, also be prepared
\end_layout
\begin_layout Enumerate
-Get a svn client for windows, as described in the previous sections.
+Get an svn client for windows, as described in the previous sections.
When it is a fresh install run some svn command (e.g.
\begin_inset Flex Code
\end_layout
\begin_layout Enumerate
-Choose a ssh client for Windows.
+Choose an ssh client for Windows.
There are several possibilities, we will use the one from Putty tools
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
\begin_inset Flex URL
\end_inset
-/
+ /
\begin_inset Flex Code
status collapsed
\end_deeper
\begin_layout Enumerate
-Checkout the SVN archive, e.g.
-
+Checkout the SVN archive, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
dumps.
While this is useful for plain text files, it is much less useful in the
- case of LyX files, which have more complicated structure.
+ case of LyX files, which have more a complicated structure.
Hence we provide binding to the Document comparison feature.
- They are two ways of calling this feature - either by direct call of
+ There are two ways of calling this feature - either by direct call of
\begin_inset Flex Code
status collapsed
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_layout
\begin_layout Subsection
-LyX and Literate Programming
+LyX and Literate Programming with Noweb
\end_layout
\begin_layout Standard
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\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
-
-\begin_layout Itemize
-Book (Noweb)
-\end_layout
-
-\begin_layout Itemize
-Report (Noweb)
-\end_layout
+noweb
+\begin_inset Quotes erd
+\end_inset
-\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
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
LyX should be prevented from making any special interpretation of what has
been written.
- This is handled by a special layout named Scrap, that works like a normal
- paragraph but has a free spacing capability.
-\end_layout
-
-\begin_layout Standard
-The down side of the Scrap paragraph layout is that consecutive paragraphs
- of code will be spaced with one empty line in the source code and also
- in the printed documentation.
- The work around is to enter each line of code within a single Scrap, with
- a newline (ctrl-return).
- The example above will look like this:
-\begin_inset Foot
-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
\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
-\emph on
-EmbeddedObjects
-\emph default
- manual.
+Support for
+\family sans
+knitr
+\family default
+ and
+\family sans
+Sweave
+\family default
+ is documented in the
+\emph on
+knitr.lyx
+\emph default
+ example file and in the Sweave manual (menu
+\family sans
+Help\SpecialChar \menuseparator
+Specific Manuals
+\family default
+).
+\end_layout
+
+\begin_layout Chapter
+Special features
+\end_layout
+
+\begin_layout Standard
+You can do everything with LyX that you can do with LaTeX.
+ However, LyX cannot support every LaTeX feature directly.
+ But you can always use TeX Code.
+ This chapter shows you some more special things you might want to use.
+ For other special things you can do with figures, tables, floats, boxes
+ and notes, have a look at the
+\emph on
+Embedded
+\begin_inset space ~
+\end_inset
+
+Objects
+\emph default
+ manual.
\end_layout
\begin_layout Section
\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
\end_layout
\begin_layout Standard
-If you want to have 2 columns in your text, use the style
+If you want to have 2
+\begin_inset space ~
+\end_inset
+
+columns in your text, use the style
\family sans
Begin Multiple Columns
\family default
\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, add the optional parameter
+\family sans
+Preface
+\family default
+ behind the number of columns in the
\family sans
Begin Multiple Columns
\family default
style.
- behind the command write the text.
- At the end of the style use the command
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-]{
-\end_layout
-
-\begin_layout Standard
-as TeX Code.
+ Write in there your preface.
An example with some preface text:
\end_layout
\begin_layout Begin Multiple Columns
2
-\begin_inset ERT
-status collapsed
+\begin_inset Argument post:1
+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_layout Plain Layout
-
-]{
\end_layout
\end_inset
\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
\begin_layout Begin Multiple Columns
2
-\begin_inset ERT
-status collapsed
+\begin_inset Argument post:1
+status open
\begin_layout Plain Layout
-
-}[
-\end_layout
-
-\end_inset
-
-
\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
-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
+ change this space.
+ This is done by inserting the optional parameter
+\family sans
+Space before page break
+\family default
+ behind the preface.
+ There insert the amount of space like e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
+g.
+\begin_inset space \space{}
+\end_inset
-\series bold
-][number
-\backslash
-baselineskip
-\end_layout
-\begin_layout Standard
-as TeX Code behind the preface definition but before the final
-\series bold
-]{
-\series default
- command.
-
-\emph on
-number
-\emph default
- is hereby the number of text lines.
+\begin_inset Quotes eld
+\end_inset
+
+5cm
+\begin_inset Quotes erd
+\end_inset
+
+.
In this example the space is set to 7
\begin_inset space ~
\end_inset
-text lines:
-\end_layout
+text lines by using
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Begin Multiple Columns
-2
-\begin_inset ERT
-status collapsed
+7
+\backslash
+baselineskip
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+ (where the command
+\series bold
-}[
+\backslash
+baselineskip
+\series default
+ needs to be inserted as TeX code):
\end_layout
-\end_inset
-
+\begin_layout Begin Multiple Columns
+2
+\begin_inset Argument post:1
+status open
+\begin_layout Plain Layout
\begin_inset ERT
status collapsed
\end_inset
+\end_layout
+
+\end_inset
+
+
+\begin_inset Argument post:2
+status open
+
+\begin_layout Plain Layout
+7
\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
\backslash
setlength
\series default
- will be used for all following multiple columns until to change them again.
+ will be used for all following multiple columns until you change them again.
\end_layout
\end_inset
\end_inset
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\end_inset
pt (this is the default), the rule is suppressed.
- In the following example, the line separating the columns is 2
+ In the following example the line is 2
\begin_inset space \thinspace{}
\end_inset
-pt wide.
+pt wide:
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{sloppypar}
+\noindent
+LaTeX as well as any other text processor uses by default rectangular paragraphs.
+ For special cases like for example posters, invitation cards or poems you
+ can modify the paragraph shape to one of your choice.
+ This can be done by using the LaTeX-package
+\series bold
+shapepar
+\series default
+ which is loaded by using in the document settings the module
+\family sans
+Custom paragraph shapes
+\family default
+.
\end_layout
-\end_inset
+\begin_layout Subsection
+Predefined shapes
+\end_layout
+\begin_layout Standard
+\series bold
+shapepar
+\series default
+ provides the following shapes:
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status collapsed
+\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
-
-
-\backslash
-newdimen
-\backslash
-varunit
+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
-\backslash
-setlength{
-\backslash
-varunit}{4.5in}
+\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
-\begin_layout Standard
-\noindent
-\begin_inset ERT
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
+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
-\backslash
-parshape 19 0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
+\begin_layout Plain Layout
+Cannot be scaled, take care there is not too much text
\end_layout
-\begin_layout Plain Layout
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" usebox="none">
+\begin_inset Text
-0.40
-\backslash
-varunit 0.300
-\backslash
-varunit
+\begin_layout Plain Layout
+Circle
\end_layout
-\begin_layout Plain Layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-0.35
-\backslash
-varunit 0.293
-\backslash
-varunit
+\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
-0.30
-\backslash
-varunit 0.300
-\backslash
-varunit
+\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.25
-\backslash
-varunit 0.317
-\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.20
-\backslash
-varunit 0.342
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Heart
+\noindent
-0.15
-\backslash
-varunit 0.373
-\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.10
-\backslash
-varunit 0.410
-\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.05
-\backslash
-varunit 0.453
-\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.00
-\backslash
-varunit 0.500
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\begin_layout Subsection
+Custom shapes
+\end_layout
-0.05
-\backslash
-varunit 0.453
-\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.10
-\backslash
-varunit 0.410
-\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.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
-\begin_layout Plain Layout
+\end_inset
-0.25
-\backslash
-varunit 0.317
-\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.30
-\backslash
-varunit 0.300
-\backslash
-varunit
+{}
\end_layout
+\end_inset
+
+X/LaT
+\begin_inset ERT
+status collapsed
+
\begin_layout Plain Layout
-0.35
-\backslash
-varunit 0.293
-\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.40
-\backslash
-varunit 0.300
-\backslash
-varunit
\end_layout
-\begin_layout Plain Layout
+\end_inset
-0.45
-\backslash
-varunit 0.332
-\backslash
-varunit
+
+\end_layout
+
+\begin_layout Standard
+The coordinates are written into a TeX-file.
+ To use it for your LyX document
+\end_layout
+
+\begin_layout Enumerate
+Place the cursor before the first character of your paragraph (or into a
+ new empty one).
+\end_layout
+
+\begin_layout Enumerate
+Open in LyX the menu
+\family sans
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+Document
+\family default
+, select the file and use
+\family sans
+Input
+\family default
+ as
+\family sans
+Include Type.
\end_layout
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+
+\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