#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 263
+\lyxformat 274
\begin_document
\begin_header
\textclass scrbook
\setboolean{marginnote}{true}}
{\setboolean{marginnote}{false}}
\end_preamble
-\options tablecaptionabove,fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage
+\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
\language english
\inputencoding auto
\font_roman default
\tracking_changes false
\output_changes false
\author "usti"
+\author "Bo Peng"
+\author "muso"
\author "Uwe Stöhr"
-\author ""
\end_header
\begin_body
\begin_layout Title
-LyX's detailed Figure, Table, Floats, Notes, and Boxes manual
+LyX's detailed Figure, Table, Floats, Notes, Boxes and External Material
+ manual
\end_layout
\begin_layout Author
\begin_inset LatexCommand index
-name "Figure"
+name "Figures"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Graphics|see{Figures}"
\end_inset
\begin_layout Section
Graphics Dialog
\begin_inset LatexCommand index
-name "Figure ! Graphics Dialog"
+name "Figures ! Graphics Dialog"
\end_inset
a rotation origin.
The image will also be rotated inside LyX.
\newline
-Images can be opened in a program
- of your choice when pressing the
+Images can be scaled by using
+ a percentage value or by setting the width and height explicitly.
+ If you set only the width or only the height, the other size will be determined
+ automatically.
+ If you set both, then the image will be transformed to the given size,
+ possibly distorting it.
+ To prevent the image from distortion, use the option
+\family sans
+Maintain aspect ratio
+\family default
+.
+ The image will then be scaled so that its width and height don't exceed
+ the specified dimensions.
+\newline
+Images can be opened in a program of your choice
+ when pressing the
\family sans
Edit
\family default
\begin_inset LatexCommand index
-name "Floats ! Figure Floats"
+name "Floats ! Figures"
\end_inset
\begin_inset LatexCommand index
-name "Figure ! Floats"
+name "Figures ! Floats"
\end_inset
\begin_inset LatexCommand index
-name "Figure ! Image Formats"
+name "Figures ! Image Formats"
\end_inset
Table\InsetSpace ~
Settings
\family default
- Here you can set the horizontal alignment for the current row and the width
- of the current column.
+ Here you can set the horizontal alignment and the width of the current
+ column.
When you have set a width you can also adjust the vertical alignment of
- the current column.
+ the current row.
A given width will allow the cell to have line breaks and multiple paragraphs
of text, see section\InsetSpace ~
sets the current cell or selection as a multicolumn
\end_layout
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Standard
+
+\series bold
+Note:
+\series default
+ For the output the vertical alignment of the first cell in a row is used
+ for all following cells in the row.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
\begin_layout Section
Edit Table Menu
\begin_inset LatexCommand index
\emph default
.
In this context, first means first in this order:
-\family sans
-Footer, Last\InsetSpace ~
-footer,
-\family default
-
\family sans
Header,
\family default
\family sans
First\InsetSpace ~
-header.
+header, Footer, Last\InsetSpace ~
+footer.
\family default
See the following longtable to see how it works:
\end_layout
\begin_layout Enumerate
-Mark the first row an disable its upper line.
+Mark the first row and disable its upper line.
\end_layout
\begin_layout Enumerate
\end_inset
+\end_layout
+
+\begin_layout Standard
\begin_inset ERT
status collapsed
\end_layout
\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Standard
+
+\series bold
+Note:
+\series default
+ When the LaTeX-package
+\series bold
+caption
+\series default
+
+\begin_inset LatexCommand index
+name "LaTeX-packages ! caption"
+
+\end_inset
+
+ is used, as in this document, the full page width is used for the caption
+ when you use the default value of 4\InsetSpace \thinspace{}
+in for
+\series bold
+
+\backslash
+LTcapwidth
+\series default
+.
+ To get in this case exactly a 4\InsetSpace \thinspace{}
+in wide caption, you can either use a value
+ slightly different from 4.0\InsetSpace \thinspace{}
+in, e.g.
+ 3.99\InsetSpace \thinspace{}
+in, or the LaTeX-command
+\series bold
+
+\backslash
+captionsetup{width=value}
+\series default
+ that is provided by the
+\series bold
+caption
+\series default
+-package.
+\end_layout
+
+\end_inset
+
\end_layout
placement H
wide false
sideways false
-status collapsed
+status open
\begin_layout Standard
\begin_inset Caption
<lyxtabular version="3" rows="3" columns="3">
<features>
<column alignment="center" valignment="middle" leftline="true" width="2.5cm">
-<column alignment="center" valignment="middle" leftline="true" width="0.5cm">
-<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0.5cm">
+<column alignment="center" valignment="middle" leftline="true" width="0">
+<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
In the appearing table dialog we set a cell width of 2.5\InsetSpace \thinspace{}
cm and choose centered
for the vertical and horizontal alignment.
+ The vertical alignment is used for all cells of the row.
As our text is smaller than than 2.5\InsetSpace \thinspace{}
cm, only one line will appear.
To get two lines, we add a line break with the command
to several lines.
\end_layout
-\begin_layout Standard
-To center the text inside the two other cells of the first row vertically,
- right-click in the second cell, adjust a fixed width of 0.5\InsetSpace \thinspace{}
-cm and choose
- centered alignments.
- Then do the same for the third cell of the row.
-\end_layout
-
\begin_layout Standard
If you have a long word in a cell with a fixed width, it cannot be hyphenated
by LaTeX if it is the first entry.
\begin_layout Standard
\begin_inset Float table
+placement h
wide false
sideways false
status open
<lyxtabular version="3" rows="3" columns="3">
<features>
<column alignment="center" valignment="middle" leftline="true" width="2.5cm">
-<column alignment="center" valignment="middle" leftline="true" width="0.5cm">
-<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0.5cm">
+<column alignment="center" valignment="middle" leftline="true" width="0">
+<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
<lyxtabular version="3" rows="3" columns="3">
<features>
<column alignment="center" valignment="middle" leftline="true" width="2.5cm">
-<column alignment="center" valignment="middle" leftline="true" width="0.5cm">
-<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0.5cm">
+<column alignment="center" valignment="middle" leftline="true" width="0">
+<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_inset Text
\begin_layout Standard
-def
-\lang ngerman
-
-\lang english
-ghi
+def ghi
\end_layout
\end_inset
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="3">
<features>
-<column alignment="center" valignment="middle" leftline="true" width="0" special="|>{\centering}m{1.25cm-6.2pt}">
+<column alignment="center" valignment="middle" leftline="true" width="0" special=">{\centering}m{1.25cm-6.2pt}">
<column alignment="center" valignment="middle" leftline="true" width="0">
<column alignment="center" valignment="top" leftline="true" rightline="true" width="0">
<row topline="true">
-<cell multicolumn="1" alignment="center" valignment="middle" topline="true" leftline="true" usebox="none" special="|>{\centering}m{2.5cm}|">
+<cell multicolumn="1" alignment="center" valignment="middle" topline="true" leftline="true" usebox="none" special=">{\centering}m{2.5cm}">
\begin_inset Text
\begin_layout Standard
\end_inset
-, mark the first two cells in the first row a 3×3 table and right-click
+, mark the first two cells in the first row of a 3×3 table and right-click
on them.
Now choose for this cell
\emph on
\emph on
n
\emph default
- columns are spanned columns can be calculated, so that each column has
- a total width of
+ columns are spanned can be calculated, so that each column has a total
+ width of
\begin_inset Formula $W_{\mathrm{tot\, multicolumn}}/n$
\end_inset
\begin_layout Standard
\series bold
-|>{
+>{
\backslash
centering}m{1.25cm-6.2pt}
\end_layout
\begin_layout Standard
-The bar
-\begin_inset Quotes eld
-\end_inset
-
-
-\series bold
-|
-\series default
-
-\begin_inset Quotes erd
-\end_inset
-
- at the beginning draws the border line and the command
+The command
\series bold
>{ }
\series default
\begin_layout Standard
\series bold
-|>{
+>{
\backslash
-centering}m{2.5cm}|
+centering}m{2.5cm}
\end_layout
\begin_layout Subsection
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="3">
<features>
-<column alignment="center" valignment="top" leftline="true" width="0" special=">{\columncolor{darkgreen}\centering}c">
+<column alignment="center" valignment="top" width="0" special=">{\columncolor{darkgreen}\centering}c">
<column alignment="center" valignment="top" width="0">
<column alignment="center" valignment="top" width="0">
<row>
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="3">
<features>
-<column alignment="center" valignment="top" leftline="true" width="0" special="Wc">
<column alignment="center" valignment="top" width="0" special="Wc">
-<column alignment="center" valignment="top" leftline="true" rightline="true" width="0" special="WcW">
+<column alignment="center" valignment="top" width="0" special="Wc">
+<column alignment="center" valignment="top" width="0" special="WcW">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="3">
<features>
-<column alignment="center" valignment="top" leftline="true" width="0" special="Wc">
<column alignment="center" valignment="top" width="0" special="Wc">
-<column alignment="center" valignment="top" leftline="true" rightline="true" width="0" special="WcW">
+<column alignment="center" valignment="top" width="0" special="Wc">
+<column alignment="center" valignment="top" width="0" special="WcW">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
LyX will insert as default 0.5\InsetSpace \thinspace{}
em space.
For normal tables the inserted space will unfortunately destroy the vertical
- table lines as in the following table:
+ table lines as in the following table:
+\begin_inset VSpace defskip
+\end_inset
+
+
+\newline
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+hspace*{0pt}
+\end_layout
+
+\end_inset
+
+
+\hfill
+
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="1">
<features>
\end_inset
+\hfill
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+hspace*{0pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset VSpace defskip
+\end_inset
+
+
\newline
So inserting space to the top of row for normal tables is only useful when
you don't have vertical lines.
\begin_layout Description
Between\InsetSpace ~
-rows only has an effect when you have selected the whole table row
- before.
- The space is added between the current and the following row.
+rows adds space between the current and the following row.
If the table is a formal table LyX will insert as default 0.5\InsetSpace \thinspace{}
em space.
For normal tables the inserted space will unfortunately destroy the vertical
- table lines as in the following table:
+ table lines as in the following table:
+\begin_inset VSpace defskip
+\end_inset
+
+
+\newline
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+hspace*{0pt}
+\end_layout
+
+\end_inset
+
+
+\hfill
+
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="1">
<features>
\end_inset
+\hfill
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+hspace*{0pt}
+\end_layout
+
+\end_inset
+
+
+\begin_inset VSpace defskip
+\end_inset
+
+
\newline
So inserting space between rows for normal tables is only useful when you
don't have vertical lines.
@{}l
\end_layout
-\begin_layout Standard
-If you need a vertical line right beside the second column, use this LaTeX-argum
-ent instead:
-\series bold
-@{}l|
-\end_layout
-
\begin_layout Standard
Table\InsetSpace ~
<lyxtabular version="3" rows="4" columns="6">
<features>
<column alignment="right" valignment="top" width="0">
-<column alignment="left" valignment="top" rightline="true" width="0" special="@{}l|">
-<column alignment="right" valignment="top" width="0">
-<column alignment="left" valignment="top" rightline="true" width="0" special="@{}l|">
+<column alignment="left" valignment="top" rightline="true" width="0" special="@{}l">
<column alignment="right" valignment="top" width="0">
<column alignment="left" valignment="top" rightline="true" width="0" special="@{}l">
+<column alignment="right" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0" special="@{}l">
<row bottomline="true">
<cell multicolumn="1" alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
\begin_inset Text
\end_inset
Alignments when LaTeX-package dcolumn is used.
- For the second and third alignment some tricks were used.
+ For all column alignments tricks have to be used to get the output.
\end_layout
\end_inset
\begin_inset Tabular
<lyxtabular version="3" rows="4" columns="3">
<features>
-<column alignment="center" valignment="top" rightline="true" width="0" special="D{×}{\times}{-1}|">
-<column alignment="center" valignment="top" width="0" special="D{×}{\times}{4.9}|">
-<column alignment="center" valignment="top" rightline="true" width="0" special="D{~}{\,}{9.7}">
+<column alignment="center" valignment="top" rightline="true" width="0" special="D{x}{\times}{-1}">
+<column alignment="center" valignment="top" rightline="true" width="0" special="D{x}{\times}{4.9}">
+<column alignment="center" valignment="top" width="0" special="D{~}{\,}{9.7}">
<row bottomline="true">
<cell multicolumn="1" alignment="center" valignment="top" bottomline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_inset Text
\begin_layout Standard
-12×24\InsetSpace \thinspace{}
+12x24\InsetSpace \thinspace{}
bottles
\end_layout
\begin_inset Text
\begin_layout Standard
-12×24\InsetSpace \thinspace{}
+12x24\InsetSpace \thinspace{}
\begin_inset Formula $\mbox{bottles}$
\end_inset
\begin_inset Text
\begin_layout Standard
-12×24~
+12
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+times
+\end_layout
+
+\end_inset
+
+24~
\begin_inset Formula $\mbox{bottles}$
\end_inset
\begin_inset Text
\begin_layout Standard
-1024×768\InsetSpace \thinspace{}
+1024x768\InsetSpace \thinspace{}
Pixels
\end_layout
\begin_inset Text
\begin_layout Standard
-1024×768\InsetSpace \thinspace{}
+1024x768\InsetSpace \thinspace{}
\begin_inset Formula $\mbox{Pixels}$
\end_inset
\begin_inset Text
\begin_layout Standard
-1024×768~
+1024
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+times
+\end_layout
+
+\end_inset
+
+768~
\begin_inset Formula $\mbox{Pixels}$
\end_inset
\begin_inset Text
\begin_layout Standard
-32×6\InsetSpace \thinspace{}
+32x6\InsetSpace \thinspace{}
cm
\end_layout
\begin_inset Text
\begin_layout Standard
-32×6\InsetSpace \thinspace{}
+32x6\InsetSpace \thinspace{}
\begin_inset Formula $\mbox{cm}$
\end_inset
\begin_inset Text
\begin_layout Standard
-32×6~
+32
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+times
+\end_layout
+
+\end_inset
+
+6~
\begin_inset Formula $\mbox{cm}$
\end_inset
\begin_layout Standard
\series bold
-|M{width}
+M{width}
\end_layout
\begin_layout Standard
\begin_layout Standard
\series bold
-|S{width of multicolumn cell}{number of spanned columns}
+S{width of multicolumn cell}{number of spanned columns}
\end_layout
\begin_layout Standard
\begin_layout Standard
\series bold
-|M{2.5cm}
+M{2.5cm}
\end_layout
\begin_layout Standard
\begin_layout Standard
\series bold
-|K{red}|
+K{red}
\end_layout
\begin_layout Standard
\begin_layout Standard
\series bold
-|S{2.5cm}{2}
+S{2.5cm}{2}
\end_layout
\begin_layout Standard
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="4">
<features>
-<column alignment="center" valignment="middle" leftline="true" width="2.5cm" special="|M{2.5cm}">
-<column alignment="center" valignment="middle" leftline="true" width="0" special="|S{2.5cm}{2}">
+<column alignment="center" valignment="middle" leftline="true" width="2.5cm" special="M{2.5cm}">
+<column alignment="center" valignment="middle" leftline="true" width="0" special="S{2.5cm}{2}">
<column alignment="center" valignment="middle" leftline="true" width="0">
-<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0" special="|K{red}|">
+<column alignment="center" valignment="middle" leftline="true" rightline="true" width="0" special="K{red}">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\end_inset
</cell>
-<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none" special="M{2.5cm}|">
+<cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none" special="M{2.5cm}">
\begin_inset Text
\begin_layout Standard
\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="3">
<features>
-<column alignment="center" valignment="top" leftline="true" width="0" special="Vc">
-<column alignment="center" valignment="top" leftline="true" width="0" special="Vc">
-<column alignment="center" valignment="top" leftline="true" width="0" special="VcV">
+<column alignment="center" valignment="top" width="0" special="Vc">
+<column alignment="center" valignment="top" width="0" special="Vc">
+<column alignment="center" valignment="top" width="0" special="VcV">
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
To insert a float, use the menu
\family sans
Insert\SpecialChar \menuseparator
-Floats
+Float
\family default
.
- This inserts a box with a label in the
-\family sans
-Caption
-\family default
- environment
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-The
+ This inserts the
\family sans
Caption
\family default
- environment is described in LyX's
-\emph on
-Userguide
-\emph default
-.
-\end_layout
-
-\end_inset
-
- into your document.
- Every label ends with the character
-\begin_inset Quotes eld
-\end_inset
-
-#
-\begin_inset Quotes erd
-\end_inset
-
- as placeholder for the float number in the output.
+ inset, a box with a label.
The label will automatically be translated to the document language in
the output.
Behind the label you can insert the caption text.
\begin_layout Subsection
Algorithm Floats
\begin_inset LatexCommand index
-name "Floats ! Algorithm Floats"
+name "Floats ! Algorithms"
\end_inset
\family default
if the LaTeX-package
\series bold
-floatflt
+floatf\SpecialChar \textcompwordmark{}
+lt
\series default
\begin_inset LatexCommand index
\begin_layout Standard
The LaTeX-package
\series bold
-floatflt
+floatf\SpecialChar \textcompwordmark{}
+lt
\series default
also supports table wrap floats, but they are not yet supported by LyX.
If you need this, read the documentation of
\series bold
-floatflt
+floatf\SpecialChar \textcompwordmark{}
+lt
\series default
\begin_inset LatexCommand cite
\begin_layout Itemize
Wrap floats should not be placed in paragraphs that run over a page break.
That means that wrap floats should better be inserted to the exact place
- when the document is nearly ready and you are able to estimate where page
- breaks will appear.
+ when the document is nearly finished and you are able to estimate where
+ page breaks will appear.
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Section
-Referencing Floats
+Float Numbering
\begin_inset LatexCommand label
-name "sec:Referencing-Floats"
+name "sec:Float-Numbering"
\end_inset
\begin_inset LatexCommand index
-name "Floats ! References"
+name "Floats ! Numbering"
\end_inset
-\begin_inset LatexCommand index
-name "References"
+\end_layout
+\begin_layout Standard
+Floats are usually numbered either independent from the sections the floats
+ are in, or in the scheme
+\begin_inset Quotes eld
\end_inset
+chapter.number
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ or
+\begin_inset Quotes eld
+\end_inset
+
+section.number
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This depends on the used document class.
+\end_layout
+
+\begin_layout Standard
+To change the section independent numbering, you can use this command in
+ the document preamble:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+thetable}{
+\backslash
+roman{table}}
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+thetable
+\series default
+ is the command that prints the table number, for figure floats, the command
+ would be
+\series bold
+
+\backslash
+thefigure
+\series default
+.
+ The command
+\series bold
+
+\backslash
+roman
+\series default
+ prints in the command above the table number as small roman number.
+\end_layout
+
+\begin_layout Standard
+To change the numbering scheme for example to
+\begin_inset Quotes eld
+\end_inset
+
+subsection.number
+\begin_inset Quotes erd
+\end_inset
+
+, use this command in the preamble:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+numberwithin{table}{subsection}
+\end_layout
+
+\begin_layout Standard
+To be able to use the command
+\series bold
+
+\backslash
+numberwithin
+\series default
+, set in the tab
+\family sans
+Math\InsetSpace ~
+Options
+\family default
+ in the document settings the option
+\family sans
+Use\InsetSpace ~
+AMS\InsetSpace ~
+math\InsetSpace ~
+package
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+Please also have a look at section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sub:Footnote-Numbering"
+
+\end_inset
+
+ for the details and important notes about the numbering commands.
+\end_layout
+
+\begin_layout Section
+Referencing Floats
+\begin_inset LatexCommand label
+name "sec:Referencing-Floats"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Floats ! References"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "References"
+
+\end_inset
+
+
+\end_layout
\begin_layout Standard
To reference a float, insert a label into its caption using the menu
\series bold
Note:
\series default
- The set reference position has no effect for references to subfigures.
+
+\series bold
+hypcap
+\series default
+ has no effect for references to subfigures.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-By default, each options has its own rules:
+By default, each option has its own rules:
\end_layout
\begin_layout Labeling
\end_inset
followed by the caption text.
- The number sign
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- is substituted in the printed output by the actual reference number.
+ is the actual reference number.
By default the label and the number are in the same font as the caption
- text and a colon follows the number to divide then label from the text.
+ text and a colon follows the number to divide the label from the text.
This caption format is not suitable for all document formats.
\end_layout
\begin_inset LatexCommand index
-name "Floats ! Listings"
+name "Floats ! Float Lists"
\end_inset
Note
\family default
.
- There are three types of notes:
+ There are five types of notes:
\end_layout
\begin_layout Description
Note
\family default
is inserted.
- You can switch between the three note types by right-clicking on the note-box.
+ You can switch between the five note types by right-clicking on the note-box.
\family roman
\series medium
\end_inset
.
-\newline
-
-\begin_inset Note Greyedout
-status open
-
-\begin_layout Standard
-
-\series bold
-Note:
-\series default
- LyX doesn't provide a prefix for labels in footnotes, so you have to insert
- e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-the prefix
-\family sans
-
-\begin_inset Quotes eld
-\end_inset
-
-foot:
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- manually when you want to use the reference style
-\family sans
-Formatted\InsetSpace ~
-reference
-\family default
-.
-\end_layout
-
-\end_inset
-
-
\end_layout
\begin_layout Standard
\end_inset
-\end_layout
-
-\begin_layout Standard
-If you want to have footnotes numbered in the scheme
-\begin_inset Quotes eld
-\end_inset
-
-chapter.footnote
-\begin_inset Quotes erd
-\end_inset
-
-, add the following command to your document preamble:
-\end_layout
-
-\begin_layout Standard
-
-\series bold
-
-\backslash
-numberwithin{footnote}{chapter}
-\end_layout
-
-\begin_layout Standard
-To be able to use the command
-\series bold
-
-\backslash
-numberwithin
-\series default
-, set in the tab
-\family sans
-Math\InsetSpace ~
-Options
-\family default
- in the document settings the option
-\family sans
-Use\InsetSpace ~
-AMS\InsetSpace ~
-math\InsetSpace ~
-package
-\family default
-.
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-numberwithin{footnote}{chapter}
-\end_layout
-
-\end_inset
-
-This is another example footnote:
-\series bold
-
-\begin_inset Foot
-status open
-
-\begin_layout Standard
-This is a footnote numbered in the scheme
-\begin_inset Quotes eld
-\end_inset
-
-chapter.footnote
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
-
-\series default
-
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-numberwithin{footnote}{part}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
-
\end_layout
\begin_layout Standard
in the command above.
\end_layout
-\begin_layout Subsection
-Footnote Placement
-\begin_inset LatexCommand index
-name "Footnotes ! Placement"
-
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-If you have several footnotes in one page, they appear without vertical
- space between them at the bottom of the page.
- To make them better readable you can e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-add 1.5\InsetSpace \thinspace{}
+If you want to have footnotes numbered in the scheme
+\begin_inset Quotes eld
+\end_inset
+
+chapter.footnote
+\begin_inset Quotes erd
+\end_inset
+
+, add the following command to your document preamble:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+numberwithin{footnote}{chapter}
+\end_layout
+
+\begin_layout Standard
+To be able to use the command
+\series bold
+
+\backslash
+numberwithin
+\series default
+, set in the tab
+\family sans
+Math\InsetSpace ~
+Options
+\family default
+ in the document settings the option
+\family sans
+Use\InsetSpace ~
+AMS\InsetSpace ~
+math\InsetSpace ~
+package
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+numberwithin{footnote}{chapter}
+\end_layout
+
+\end_inset
+
+This is another example footnote:
+\series bold
+
+\begin_inset Foot
+status open
+
+\begin_layout Standard
+This is a footnote numbered in the scheme
+\begin_inset Quotes eld
+\end_inset
+
+chapter.footnote
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
+\series default
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+renewcommand{
+\backslash
+thefootnote}{
+\backslash
+arabic{footnote}}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Standard
+
+\series bold
+Note:
+\series default
+
+\series bold
+
+\backslash
+numberwithin
+\series default
+ always prints out the footnote number as arabic number; previous redefinitions
+ to get non-arabic numbers are overwritten.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+So to get for example the scheme
+\begin_inset Quotes eld
+\end_inset
+
+chapter.
+\backslash
+Roman{footnote}
+\begin_inset Quotes erd
+\end_inset
+
+, use this command instead of
+\series bold
+
+\backslash
+numberwithin
+\series default
+:
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+
+\backslash
+renewcommand{
+\backslash
+thefootnote}{
+\backslash
+thechapter.
+\backslash
+Roman{footnote}}
+\end_layout
+
+\begin_layout Subsection
+Footnote Placement
+\begin_inset LatexCommand index
+name "Footnotes ! Placement"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+If you have several footnotes in one page, they appear without vertical
+ space between them at the bottom of the page.
+ To make them better readable you can e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+add 1.5\InsetSpace \thinspace{}
mm space with the following
preamble command:
\end_layout
\end_inset
+\end_layout
+
+\begin_layout Standard
+
\end_layout
\begin_layout Chapter
\begin_layout Description
Date This inserts the date in the form
\emph on
-Date-Month-Year
+Day-Month-Year
\emph default
.
This is a date inserted as external material:
\end_layout
\begin_layout Description
-Xfig This template supports images created with the program
+XFig This template supports images created with the program
\begin_inset ERT
status collapsed
\begin_layout Section
Child Documents
-\begin_inset LatexCommand index
-name "External Stuff ! Child Documents"
+\begin_inset LatexCommand label
+name "sec:Child-Documents"
\end_inset
\begin_inset LatexCommand index
-name "Files ! Child Documents"
+name "External Stuff ! Child Documents"
\end_inset
Documents
\family default
.
- A dialog pops up where you can choose between three include methods:
+ A dialog pops up where you can choose between four include methods:
\end_layout
\begin_layout Description
\family default
:
\begin_inset Include \input{DummyDocument2.lyx}
-preview true
+preview false
\end_inset
\end_layout
+\begin_layout Description
+Listings This type is described in chapter\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "cha:Program-Code-Listings"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Standard
\begin_inset Note Greyedout
status open
\end_inset
-\end_layout
-
-\begin_layout Standard
-
-\newpage
-
\end_layout
\begin_layout Chapter
-\start_of_appendix
-Units available in
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-texorpdfstring{
-\end_layout
+Program Code Listings
+\begin_inset LatexCommand label
+name "cha:Program-Code-Listings"
\end_inset
-LyX
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-}{LyX}
-\end_layout
+\begin_inset LatexCommand index
+name "Listings"
\end_inset
\begin_inset LatexCommand index
-name "Units"
+name "Program Code"
\end_inset
-\begin_inset LatexCommand label
-name "cha:Units-available-in"
+\begin_inset LatexCommand index
+name "Floats ! Listings"
\end_inset
-\begin_inset Note Note
-status collapsed
+\end_layout
\begin_layout Standard
-The command
-\backslash
-texorpdfstring is provided by the LaTeX-package hyperref to avoid that ligatures
- are displayed wrongly in PDF-bookmarks.
- For more information about this, have a look at
-\begin_inset LatexCommand cite
-key "hyperref"
-
-\end_inset
-
+To include and typeset program code you can use the
+\family sans
+Listings
+\family default
+ inset that can be inserted via the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Program Listing
+\family default
.
-\end_layout
+ The LaTeX-package
+\series bold
+listings
+\series default
-\end_inset
+\begin_inset LatexCommand index
+name "LaTeX-packages ! listings"
+\end_inset
+ provides a powerful and flexible way to insert program source code to your
+ document.
\end_layout
\begin_layout Standard
-To understand the units described in this documentation, Table\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "tab:Units"
-
-\end_inset
-
- explains all units available in LyX.
+When right-clicking on a listings inset a dialog pops up where you can set
+ the listings format.
\end_layout
\begin_layout Standard
-\begin_inset Float table
-placement h
-wide false
-sideways false
+By default, a listing starts a new paragraph in the output.
+ The placement option
+\family sans
+Inline\InsetSpace ~
+listing
+\family default
+ prints the listing inline like this:
+\begin_inset listings
+lstparams "language={C++}"
+inline true
status open
\begin_layout Standard
-\begin_inset Caption
-\begin_layout Standard
-\begin_inset LatexCommand label
-name "tab:Units"
+int a=5;
+\end_layout
+
+\end_inset
+
+
+\newline
+The option
+\family sans
+Float
+\family default
+ creates a listings float where you can specify the placement options
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+h
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+t
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+b
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+, and
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+p
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ corresponding to the float placement options described in section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sec:Float-Placement"
+
+\end_inset
+
+.
+ The placement options can be mixed and are inserted without any separation,
+ e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+htbp
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The option
+\begin_inset Quotes eld
+\end_inset
+
+h
+\begin_inset Quotes erd
+\end_inset
+
+ has sometimes no effect, but you don't need to use the
+\family sans
+Float
+\family default
+ option in this case as also non-float listings can have captions and be
+ referenced.
+\end_layout
+
+\begin_layout Standard
+You can add captions to listings with the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Caption
+\family default
+.
+ Listings can be referenced like floats: Listing\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "lst:Example-Listing"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset listings
+lstparams "language=Python"
+inline false
+status open
+
+\begin_layout Standard
+
+\begin_inset Caption
+
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "lst:Example-Listing"
+
+\end_inset
+
+Example Listing float
+\end_layout
+
+\end_inset
+
+# Example listing float
+\end_layout
+
+\begin_layout Standard
+
+def func(param):
+\end_layout
+
+\begin_layout Standard
+
+ 'this is a python function'
+\end_layout
+
+\begin_layout Standard
+
+ pass
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+When you have set a programming language in the listings dialog, the keywords
+ of this language will be recognized and specially typeset in the output.
+ In the example listings the Python keyword
+\begin_inset Quotes eld
+\end_inset
+
+def
+\begin_inset Quotes erd
+\end_inset
+
+ is recognized and printed bold in the output.
+\end_layout
+
+\begin_layout Standard
+In section
+\family sans
+Line\InsetSpace ~
+numbering
+\family default
+ of the listings dialog you can specify the line numbering style.
+ You can insert a number to specify which lines are numbered to the field
+
+\family sans
+Step
+\family default
+.
+ When you insert e.g.
+
+\begin_inset Quotes eld
+\end_inset
+
+3
+\begin_inset Quotes erd
+\end_inset
+
+, only every 3rd line will be numbered.
+\end_layout
+
+\begin_layout Standard
+You can furthermore specify a range of lines, only these will then appear
+ in the output.
+ The option
+\family sans
+Extended\InsetSpace ~
+chars
+\family default
+ should be used when you use national characters like the German umlauts
+ in the listing.
+\newline
+Here is an example listing with left line numbering, step
+
+\begin_inset Quotes eld
+\end_inset
+
+3
+\begin_inset Quotes erd
+\end_inset
+
+, language
+\begin_inset Quotes eld
+\end_inset
+
+Python
+\begin_inset Quotes erd
+\end_inset
+
+, options
+\begin_inset Quotes eld
+\end_inset
+
+Extended\InsetSpace ~
+chars
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+Space\InsetSpace ~
+as\InsetSpace ~
+Symbol
+\begin_inset Quotes erd
+\end_inset
+
+, range lines 3\InsetSpace \thinspace{}
+-\InsetSpace \thinspace{}
+8:
+\end_layout
+
+\begin_layout Standard
+\begin_inset listings
+lstparams "extendedchars=true,firstline=3,language=Python,lastline=8,numbers=left,showspaces=true,stepnumber=3"
+inline false
+status open
+
+\begin_layout Standard
+
+def func(param):
+\end_layout
+
+\begin_layout Standard
+
+ 'this is a python function'
+\end_layout
+
+\begin_layout Standard
+
+ pass
+\end_layout
+
+\begin_layout Standard
+
+def func(param):
+\end_layout
+
+\begin_layout Standard
+
+'This is a German word: Tschüß'
+\end_layout
+
+\begin_layout Standard
+
+pass
+\end_layout
+
+\begin_layout Standard
+
+def func(param):
+\end_layout
+
+\begin_layout Standard
+
+'this is a python function'
+\end_layout
+
+\begin_layout Standard
+
+pass
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
+
+\begin_layout Standard
+
+\series bold
+Note:
+\series default
+ The line numbering is shifted by a line by every previous listing.
+ That's the reason why the lines 2 and 5 are numbered in the above listing
+ and not the lines 3 and 6.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+It is also possible to print lines from a file as listing.
+ To do this, use the menu
+\family sans
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child Document
+\family default
+ and choose the type
+\family sans
+Listings
+\family default
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+The other child document types are described in section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sec:Child-Documents"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+ In the child document dialog you can specify the listing parameters in
+ a text box.
+ To show a list of all available parameters, type in a question mark
+\begin_inset Quotes eld
+\end_inset
+
+?
+\begin_inset Quotes erd
+\end_inset
+
+ in the text box.
+\end_layout
+
+\begin_layout Standard
+To reference child document listings, write a label text into the corresponding
+ field of the child document dialog.
+ The label can then be referenced using the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Cross-Reference
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+Listing\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "lst:file-listing"
+
+\end_inset
+
+ is an example for a listing of a file; there the lines 10\InsetSpace \thinspace{}
+-\InsetSpace \thinspace{}
+15 of this LyX
+ file are listed.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Include \lstinputlisting{EmbeddedObjects.lyx}[breaklines=true,caption={Lines 10 - 15 of this LyX file},firstline=10,label={lst:file-listing},language={[LaTeX]TeX},lastline=15]
+preview false
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Global listings settings can be set in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Text Layout
+\family default
+ dialog.
+ To get there a list of available options, type in a question mark
+\begin_inset Quotes eld
+\end_inset
+
+?
+\begin_inset Quotes erd
+\end_inset
+
+ in the
+\family sans
+Listings\InsetSpace ~
+settings
+\family default
+ field.
+\end_layout
+
+\begin_layout Standard
+For more information about the
+\series bold
+listings
+\series default
+ package, we refer to its documentation
+\begin_inset LatexCommand cite
+key "listings"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+
+\newpage
+
+\end_layout
+
+\begin_layout Chapter
+\start_of_appendix
+Units available in
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+texorpdfstring{
+\end_layout
+
+\end_inset
+
+LyX
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+}{LyX}
+\end_layout
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Units"
+
+\end_inset
+
+
+\begin_inset LatexCommand label
+name "cha:Units-available-in"
+
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Standard
+The command
+\backslash
+texorpdfstring is provided by the LaTeX-package hyperref to avoid that ligatures
+ are displayed wrongly in PDF-bookmarks.
+ For more information about this, have a look at
+\begin_inset LatexCommand cite
+key "hyperref"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+To understand the units described in this documentation, Table\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "tab:Units"
+
+\end_inset
+
+ explains all units available in LyX.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Float table
+placement h
+wide false
+sideways false
+status open
+
+\begin_layout Standard
+\begin_inset Caption
+
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "tab:Units"
\end_inset
\begin_inset LatexCommand index
-name "File Formats ! PostScript\\protect\\pagebreak"
+name "File Formats ! PostScript"
\end_inset
\end_inset
+\end_layout
+
+\begin_layout Bibliography
+\begin_inset LatexCommand bibitem
+key "listings"
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+
+\backslash
+href{ftp://tug.ctan.org/pub/tex-archive/macros/latex/contrib/listings/listings.pdf}
+{
+\end_layout
+
+\end_inset
+
+Documentation
+\begin_inset ERT
+status collapsed
+
+\begin_layout Standard
+
+}
+\end_layout
+
+\end_inset
+
+ of the LaTeX-package
+\series bold
+listings
+\series default
+
+\begin_inset LatexCommand index
+name "LaTeX-packages ! listings"
+
+\end_inset
+
+
\end_layout
\begin_layout Bibliography
\family sans
LyX 1.5
\family default
-.
+.0.
\end_layout
\begin_layout Standard
projects / lyx.git / blobdiff