#LyX 1.5.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 269
+\lyxformat 274
\begin_document
\begin_header
\textclass scrbook
\tracking_changes false
\output_changes false
\author "usti"
+\author "Bo Peng"
+\author "muso"
\author "Uwe Stöhr"
\end_header
\begin_inset LatexCommand index
-name "Floats ! Figure Floats"
+name "Floats ! Figures"
\end_inset
\begin_inset Text
\begin_layout Standard
-def
-\lang ngerman
-
-\lang english
-ghi
+def ghi
\end_layout
\end_inset
\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_inset LatexCommand index
-name "Floats ! Listings"
+name "Floats ! Float Lists"
\end_inset
\backslash
-numberwithin{footnote}{part}
+renewcommand{
+\backslash
+thefootnote}{
+\backslash
+arabic{footnote}}
\end_layout
\end_inset
\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:
\begin_layout Section
Child Documents
+\begin_inset LatexCommand label
+name "sec:Child-Documents"
+
+\end_inset
+
+
\begin_inset LatexCommand index
name "External Stuff ! Child Documents"
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_layout
+\begin_layout Chapter
+Program Code Listings
+\begin_inset LatexCommand label
+name "cha:Program-Code-Listings"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Listings"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Program Code"
+
+\end_inset
+
+
+\begin_inset LatexCommand index
+name "Floats ! Listings"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+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
+.
+ The LaTeX-package
+\series bold
+listings
+\series default
+
+\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
+When right-clicking on a listings inset a dialog pops up where you can set
+ the listings format.
+\end_layout
+
+\begin_layout Standard
+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
+
+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_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