-#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 452
\begin_document
\begin_header
\textclass scrbook
\pdfbookmark[1]{\contentsname}{}
\myTOC
\mainmatter }
-
-% redefine the \LyX macro for PDF bookmarks
-\def\LyX{\texorpdfstring{%
- L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
- {LyX}}
-
-% used for multi-column text
-\usepackage{multicol}
\end_preamble
\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\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_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
\papersize default
\use_geometry false
-\use_amsmath 0
-\use_esint 0
-\use_mhchem 0
-\use_mathdots 1
+\use_package amsmath 0
+\use_package amssymb 0
+\use_package esint 0
+\use_package mathdots 1
+\use_package mathtools 0
+\use_package mhchem 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
\branch OutDated
\selected 0
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes false
+\tracking_changes true
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
+\author -712698321 "Jürgen Spitzmüller"
+\author -195340706 "Georg Baum"
+\author 5863208 "ab"
+\author 155139281 "Jrgen Spitzmller"
+\author 1082167584 "Kayvan Sylvan" kayvan@sylvan.com
+\author 1414654397 "Richard Heck"
+\author 2090807402 "usti"
\end_header
\begin_body
\end_inset
this file contains a list of all the languages currently supported by LyX.
+\change_inserted -195340706 1334775793
+
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -195340706 1334775793
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -195340706 1334775793
+layouttranslations
+\end_layout
+
+\end_inset
+
+ this file contains translations for internationalized paragraph styles
+ (see sec.
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+).
+\change_unchanged
+
\end_layout
\begin_layout Section
in the appearing context menu.
\end_layout
+\begin_layout Standard
+
+\change_inserted -195340706 1329851811
+The
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+MIME
+\end_layout
+
+\end_inset
+
+ type of a format is optional, but if it is specified, it must be unique
+ across all formats.
+ It is used to detect files of this format from the file contents.
+ For some important file formats there is no MIME type officially registered
+ with the
+\begin_inset CommandInset href
+LatexCommand href
+name "IANA"
+target "http://www.iana.org/assignments/media-types/"
+
+\end_inset
+
+.
+ Therefore LyX uses the extended list of MIME types as specified by
+\begin_inset CommandInset href
+LatexCommand href
+name "freedesktop.org"
+target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Standard
The
\begin_inset Flex MenuItem
\end_inset
The output file
+\change_inserted 1082167584 1348453985
+
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted 1082167584 1348453986
+$$b The base name (without filename extension) in the LyX temporary directory
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted 1082167584 1348453986
+$$p The full directory path of the LyX temporary directory
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted 1082167584 1348453986
+$$r The full pathname to the original LyX file being processed
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted 1082167584 1348453986
+$$f The filename (without any directory path) of the LyX file.
\end_layout
\begin_layout Labeling
\end_inset
The `LaTeX name'
+\change_inserted 1082167584 1348453720
+
\end_layout
\begin_layout Standard
\end_inset
file for the conversion.
+\change_inserted 1414654397 1337693117
+
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted 1414654397 1337693188
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1414654397 1337693129
+nice
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ Needs a
+\begin_inset Quotes eld
+\end_inset
+
+nice
+\begin_inset Quotes erd
+\end_inset
+
+ file from the backend, which in practice means a LaTeX file like the one
+ we would export, without
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 1414654397 1337693184
+input@path
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
\end_inset
-\begin_inset Argument
+\begin_inset Argument 1
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout LyX-Code
-#DescriptionEnd
+#DescriptionEnd
\begin_inset Newline newline
\end_inset
\begin_layout Subsection
The document class declaration
+\change_inserted -712698321 1349766602
+ and classification
+\change_unchanged
+
\end_layout
\begin_layout Standard
\end_inset
- files should begin with a line like:
+ files should begin with
+\change_deleted -712698321 1349766533
+a
+\change_unchanged
+line
+\change_inserted -712698321 1349766536
+s
+\change_unchanged
+ like:
\end_layout
\begin_layout LyX-Code
\size small
#
\backslash
-DeclareLaTeXClass{article}
+DeclareLaTeXClass{
+\change_deleted -712698321 1349766193
+article
+\change_inserted -712698321 1349766201
+Article (Standard Class)
+\change_unchanged
+}
+\change_inserted -712698321 1349766538
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1349766581
+
+\size small
+#
+\backslash
+DeclareCategory{Articles}
+\change_unchanged
+
\end_layout
\begin_layout Standard
-The second line is used when you (re)configure LyX.
+The second
+\change_inserted -712698321 1349766695
+and third
+\change_unchanged
+line
+\change_inserted -712698321 1349766626
+s
+\change_unchanged
+
+\change_deleted -712698321 1349766628
+is
+\change_inserted -712698321 1349766628
+are
+\change_unchanged
+ used when you (re)configure LyX.
The layout file is read by the LaTeX script
\begin_inset Flex Code
status collapsed
\end_inset
is ignored.
- The first line is just a LaTeX comment, and the second one contains the
- declaration of the text class.
+ The first line is just a LaTeX comment,
+\change_deleted -712698321 1349766656
+and
+\change_unchanged
+the second one contains the
+\change_inserted -712698321 1349766650
+mandatory
+\change_unchanged
+declaration of the text class
+\change_inserted -712698321 1349766689
+, and the third line contains the optional classification of the class
+\change_unchanged
+.
If these lines appear in a file named
\begin_inset Flex Code
status collapsed
\begin_inset Quotes eld
\end_inset
+
+\change_deleted -712698321 1349766253
article
+\change_inserted -712698321 1349766260
+Article (Standard Class)
+\change_unchanged
+
\begin_inset Quotes erd
\end_inset
\end_inset
dialog.
+
+\change_inserted -712698321 1349767097
+ The category (
+\begin_inset Quotes eld
+\end_inset
+
+Articles
+\begin_inset Quotes erd
+\end_inset
+
+ in the example) is also used in the
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1349766801
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ dialog: the text classes are grouped by these categories (which are usually
+ genres, so typical categories are
+\begin_inset Quotes eld
+\end_inset
+
+Articles
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Books
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Reports
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Letters
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Presentations
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Curricula Vitae
+\begin_inset Quotes erd
+\end_inset
+
+ etc.).
+ If no category has been declared, the class will be put in the
+\begin_inset Quotes eld
+\end_inset
+
+Uncategorized
+\begin_inset Quotes erd
+\end_inset
+
+ group.
+\change_unchanged
+
\end_layout
\begin_layout Standard
\size small
#
\backslash
-DeclareLaTeXClass[article]{article (with my own headings)}
+DeclareLaTeXClass[article]{
+\change_deleted -712698321 1349766303
+a
+\change_inserted -712698321 1349766303
+A
+\change_unchanged
+rticle (with
+\change_deleted -712698321 1349766338
+m
+\change_inserted -712698321 1349766338
+M
+\change_unchanged
+y
+\change_deleted -712698321 1349766340
+o
+\change_inserted -712698321 1349766340
+O
+\change_unchanged
+wn
+\change_deleted -712698321 1349766343
+h
+\change_inserted -712698321 1349766343
+H
+\change_unchanged
+eadings)}
+\change_inserted -712698321 1349767223
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1349767223
+
+\size small
+#
+\backslash
+DeclareCategory{Articles}
+\change_unchanged
+
\end_layout
\begin_layout Standard
\begin_inset Quotes eld
\end_inset
-article (with my own headings)
+
+\change_deleted -712698321 1349766329
+a
+\change_inserted -712698321 1349766329
+A
+\change_unchanged
+rticle (with
+\change_deleted -712698321 1349766347
+m
+\change_inserted -712698321 1349766347
+M
+\change_unchanged
+y
+\change_deleted -712698321 1349766350
+o
+\change_inserted -712698321 1349766350
+O
+\change_unchanged
+wn
+\change_deleted -712698321 1349766352
+h
+\change_inserted -712698321 1349766352
+H
+\change_unchanged
+eadings)
\begin_inset Quotes erd
\end_inset
\size small
#
\backslash
-DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
+DeclareLaTeXClass[article,foo.sty]{
+\change_deleted -712698321 1349766366
+a
+\change_inserted -712698321 1349766366
+A
+\change_unchanged
+rticle (with
+\change_deleted -712698321 1349766369
+m
+\change_inserted -712698321 1349766369
+M
+\change_unchanged
+y
+\change_deleted -712698321 1349766371
+o
+\change_inserted -712698321 1349766371
+O
+\change_unchanged
+wn
+\change_deleted -712698321 1349766374
+h
+\change_inserted -712698321 1349766374
+H
+\change_unchanged
+eadings)}
+\change_inserted -712698321 1349767240
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1349767240
+
+\size small
+#
+\backslash
+DeclareCategory{Articles}
+\change_unchanged
+
\end_layout
\begin_layout Standard
\size small
#
\backslash
-DeclareDocBookClass[article]{SGML (DocBook article)}
+DeclareDocBookClass[article]{SGML (DocBook
+\change_deleted -712698321 1349766387
+a
+\change_inserted -712698321 1349766387
+A
+\change_unchanged
+rticle)}
+\change_inserted -712698321 1349767247
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1349767302
+
+\size small
+#
+\backslash
+DeclareCategory{Articles (DocBook)}
+\change_unchanged
+
\end_layout
\begin_layout Standard
#
\backslash
DeclareLaTeXClass[class,package.sty]{layout description}
+\change_inserted -712698321 1349767329
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1349767339
+
+\size small
+#
+\backslash
+DeclareCategory{category}
+\change_unchanged
+
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+AddToHTMLStyles
\end_layout
\end_inset
- Adds information to the document preamble.
- Must end with
+ Adds CSS styling information.
+ This will either be output in a
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndPreamble
+<style>
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ block or, if the user has so chosen, to a separate CSS file.Must end with
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndStyles
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToPreamble
+\end_layout
+
+\end_inset
+
+ Adds information to the document preamble.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyles
+\end_layout
+
+\end_inset
+
+ Sets CSS styling information.
+ This will either be output in a
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ block or, if the user has so chosen, to a separate CSS file.
+ Note that this will completely override any prior
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyles
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLStyles
+\end_layout
+
+\end_inset
+
+ declarations.
+ (Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLStyles
+\end_layout
+
+\end_inset
+
+ if you just want to add material.) Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndStyles
+\end_layout
+
+\end_inset
+
+
\begin_inset Quotes erd
\end_inset
(Some LaTeX styles prohibit certain alignments, since those wouldn't make
sense.
For example a right-aligned or centered enumeration isn't possible.)
+\change_inserted -712698321 1353679769
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1353680268
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+
+\change_inserted -712698321 1353679781
+Argument
\end_layout
\end_inset
- Note that this will completely override any prior
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
-\end_layout
-\end_inset
+\change_inserted -712698321 1353679772
+int
+\end_layout
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
\end_inset
-
+] Defines argument number <int> of a command\SpecialChar \slash{}
+environment associated with
+ the current style.
+ This is useful for things like section headings, and only makes sense with
+ LaTeX.
+ Every (optional or required) argument of a command or environment -- except
+ for the required argument that is associated with the content of the paragraph
+ itself -- has a separate definition, where the number specifies the order
+ of the arguments.
+ The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+
+\change_inserted -712698321 1353680069
+EndArgument
\end_layout
\end_inset
+.
+ So a command with two optional arguments has:
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_deeper
+\begin_layout Quote
-.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:I18n"
+\change_inserted -712698321 1353680127
-\end_inset
+\family typewriter
+Argument 1
+\end_layout
- for details on its use.
+\begin_layout Quote
+
+\change_inserted -712698321 1353680195
+
+\family typewriter
+...
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Quote
-\begin_layout Plain Layout
-BottomSep
+\change_inserted -712698321 1353680135
+
+\family typewriter
+EndArgument
\end_layout
-\end_inset
+\begin_layout Quote
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1353680140
-\begin_layout Plain Layout
-float=0
+\family typewriter
+Argument 2
\end_layout
-\end_inset
+\begin_layout Quote
-]
-\begin_inset Foot
-status collapsed
+\change_inserted -712698321 1353680197
-\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+\family typewriter
+...
\end_layout
-\end_inset
+\begin_layout Quote
- The vertical space with which the last of a chain of paragraphs with this
- style is separated from the following paragraph.
- If the next paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+\change_inserted -712698321 1353680147
+
+\family typewriter
+EndArgument
\end_layout
-\begin_layout Description
+\begin_layout Standard
+
+\change_inserted -712698321 1353680528
+Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Category
+
+\change_inserted -712698321 1353680412
+Argument
\end_layout
\end_inset
-
+ definition, the following specifications are possible:
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1355076779
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+
+\change_inserted -712698321 1353680543
+LabelString
+\change_unchanged
+
\end_layout
\end_inset
- The category for this style.
- This is used to group related styles in the style combobox on the toolbar.
- Any string can be used, but you may want to use existing categories with
- your own styles.
-\end_layout
-
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandDepth
+
+\change_inserted -712698321 1353680567
+[string]
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
-\end_layout
-
-\begin_layout Description
+ The string that will appear both in the menu (to insert this argument)
+ and on the argument inset button (unless you also specify a separate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+
+\change_inserted -712698321 1355076779
+MenuString
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:CopyStyle"
+).
+ For the menu, you can define an accelerator by appending the respective
+ character to the string, divided by
+\begin_inset Quotes eld
+\end_inset
+|
+\begin_inset Quotes erd
\end_inset
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+
+\change_inserted -712698321 1353691482
+\begin_inset Quotes eld
+\end_inset
+
+Short Title|S
+\begin_inset Quotes erd
+\end_inset
+
+
+\change_unchanged
+
\end_layout
\end_inset
- Copies all the features of an existing style into the current one.
-
+).
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1355076754
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+
+\change_inserted -712698321 1355076658
+MenuString
\end_layout
\end_inset
- The name of a style whose preamble should be output
-\emph on
-before
-\emph default
- this one.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another.
-\begin_inset Foot
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that, besides that functionality, there is no way to ensure any ordering
- of preambles.
- The ordering that you see in a given version of LyX may change without
- warning in later versions.
+
+\change_inserted -712698321 1355076654
+[string]
\end_layout
\end_inset
+ A separate string for the menu.
+ You can define an accelerator by appending the respective character to
+ the string, divided by
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-EndLabeltype
-\end_layout
+|
+\begin_inset Quotes erd
+\end_inset
+ (e.
+\begin_inset space \thinspace{}
\end_inset
- [
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-No_Label
-\emph default
-, Box, Filled_Box, Static
-\end_layout
+\change_inserted -712698321 1355076654
+\begin_inset Quotes eld
+\end_inset
+Short Title|S
+\begin_inset Quotes erd
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-LatexType
\end_layout
\end_inset
- is
+).
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\change_inserted -712698321 1355076736
+LabelString
+\change_unchanged
+
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Item_Environment
+ will be used instead for the menu.
\end_layout
-\end_inset
+\begin_layout Itemize
- or
+\change_inserted -712698321 1353680665
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+
+\change_inserted -712698321 1353680616
+Tooltip
\end_layout
\end_inset
-).
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-No_Label
+
+\change_inserted -712698321 1353680623
+[string]
\end_layout
\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
+\end_layout
-nothing
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
+\change_inserted -712698321 1353680874
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+
+\change_inserted -712698321 1353680732
+Mandatory
\end_layout
\end_inset
- (resp.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\begin_inset space ~
-\end_inset
-Filled_Box
+\change_inserted -712698321 1353680738
+[int=0]
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
-\end_inset
-
-black) square suitable for end of proof markers,
+ Declare if this is a mandatory
+\change_inserted 2090807402 1353765594
+(1)
+\change_inserted -712698321 1353680874
+or an optional
+\change_inserted 2090807402 1353765599
+(0)
+\change_inserted -712698321 1353680874
+argument.
+ Mandatory arguments will be output empty if not given, while optional arguments
+ will not be output at all.
+ By default, mandatory arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
-\end_layout
-\end_inset
+\change_inserted -712698321 1353680808
+{...}
+\change_unchanged
- is an explicit text string.
\end_layout
-\begin_layout Description
+\end_inset
+
+, while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+
+\change_inserted -712698321 1353680833
+[...]
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-string=""
\end_layout
-\end_inset
+\begin_layout Itemize
-] The string used for a label with a
+\change_inserted -712698321 1353917199
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+
+\change_inserted -712698321 1353680879
+Requires
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-EndLabelType
+
+\change_inserted -712698321 1353680874
+[int=0]
\end_layout
\end_inset
-.
-
-\end_layout
+ defines another argument (by its number) which this argument requires to
+ be output if it is itself output.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Description
+g., in LaTeX commands, optional arguments often require previous optional
+ arguments to be output (at least empty), as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
-\end_layout
-
-\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
-\end_inset
+\change_inserted -712698321 1353688183
+\backslash
+command[][arg]{text}
+\change_unchanged
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\end_layout
\end_inset
.
- Note that defining this font automatically defines the
+ This can be achieved by the statement
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\change_inserted -712698321 1353681031
+Requires 1
+\change_unchanged
+
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ within
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\change_inserted -712698321 1353681045
+Argument 2
+\change_unchanged
+
\end_layout
\end_inset
.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1354263104
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
-\end_layout
-\end_inset
+\change_inserted -712698321 1353681072
+LeftDelim
+\change_unchanged
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
+\end_layout
\end_inset
-[
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\change_inserted -712698321 1353681067
+[string]
\end_layout
\end_inset
-,
+ defines a custom left delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-] Usually LyX doesn't allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example, when typing
- program code or plain LaTeX code.
- For this reason,
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1353681127
+{
+\change_unchanged
-\begin_layout Plain Layout
-FreeSpacing
\end_layout
\end_inset
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
-\end_layout
-
-\begin_layout Description
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
-\end_layout
-\end_inset
+\change_inserted -712698321 1353681133
+[
+\change_unchanged
- These tags are used with XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Paragraph-Style-XHTML"
+\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InnerTag
+
+\change_inserted -712698321 1354263104
+<br/>
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
+.
+\change_unchanged
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1354263106
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InPreamble
+
+\change_inserted -712698321 1353681149
+RightDelim
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-[1, 0]
+
+\change_inserted -712698321 1353681146
+[string]
\end_layout
\end_inset
- If 1, marks the style as to be included in the document preamble rather
- than in the document body.
- This is useful for document classes that want such information as the title
- and author to appear in the preamble.
- Note that this works only for styles for which the
+ defines a custom right delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+
+\change_inserted -712698321 1353681158
+}
\end_layout
\end_inset
- is
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+
+\change_inserted -712698321 1353681161
+]
\end_layout
\end_inset
- or
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+
+\change_inserted -712698321 1354263106
+<br/>
\end_layout
\end_inset
.
+\change_unchanged
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle
+
+\change_inserted -712698321 1353917320
+Font
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
+ The font used for the argument content.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-[1, 0]
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
- If 1, marks the style as being part of a title block (see also the
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\change_inserted -712698321 1353917320
+LabelFont
\end_layout
\end_inset
- and
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1353917320
+Decoration
\end_layout
\end_inset
- global entries).
-\end_layout
-
-\begin_layout Description
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemSep
+
+\change_inserted -712698321 1353917320
+Classic
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+
+\change_inserted -712698321 1353917320
+Minimalistic
\end_layout
\end_inset
-] This provides extra space between paragraphs that have the same style.
- If you put other styles into an environment, each is separated with the
- environment's
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parsep
+
+\change_inserted -712698321 1353917320
+Conglomerate
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+, describing the rendering style used for the inset's frame and buttons.
+ Default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+
+\change_inserted -712698321 1353917320
+Classic
\end_layout
\end_inset
.
- Note that this is a
-\emph on
- multiplier.
+\change_inserted 155139281 1354198988
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+
+\change_inserted 155139281 1354199102
+Arguments for list
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemTag
-\end_layout
-\end_inset
+\change_inserted 155139281 1354199013
+
+\backslash
+item
+\change_unchanged
- [[FIXME]] (Used only with XML-type formats.)
\end_layout
-\begin_layout Description
+\end_inset
+
+s (as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
-\end_layout
-\end_inset
+\change_inserted 155139281 1354199102
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
+\backslash
+item[foo]
+\change_unchanged
+
+\end_layout
\end_inset
-[
+) have the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\change_inserted 155139281 1354199044
+item:
+\change_unchanged
+
\end_layout
\end_inset
-,
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\change_inserted 155139281 1354199064
+Argument item:1
+\change_unchanged
+
\end_layout
\end_inset
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a style can be used
- as some kind of break, which does not contain actual text.
+)
+\change_unchanged
+
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+BabelPreamble
\end_layout
\end_inset
- [float=0] The vertical space between the label and the text body.
- Only used for labels that are above the text body (
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+BabelPreamble
\end_layout
\end_inset
-,
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+EndBabelPreamble
\end_layout
\end_inset
-).
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+ for details on its use.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelCounter
+BottomSep
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+float=0
\end_layout
\end_inset
]
-\begin_inset Newline newline
-\end_inset
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that a `float' here is a real number, such as: 1.5.
+\end_layout
-The name of the counter for automatic numbering.
-
-\begin_inset Newline newline
\end_inset
-This
-\emph on
-must
-\emph default
- be given if
+ The vertical space with which the last of a chain of paragraphs with this
+ style is separated from the following paragraph.
+ If the next paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+Category
\end_layout
\end_inset
- is
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+[string]
\end_layout
\end_inset
-.
- In that case, the counter will be stepped each time the style appears.
+ The category for this style.
+ This is used to group related styles in the style combobox on the toolbar.
+ Any string can be used, but you may want to use existing categories with
+ your own styles.
-\begin_inset Newline newline
-\end_inset
+\end_layout
-This
-\emph on
-may
-\emph default
- also be given if
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+CommandDepth
\end_layout
\end_inset
- is
+ Depth of XML command.
+ Used only with XML-type formats.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+CopyStyle
\end_layout
\end_inset
-, though this case is a bit complicated.
- Suppose you declare
-\begin_inset Quotes eld
-\end_inset
-
-
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter myenum
+[string]
\end_layout
\end_inset
+ Copies all the features of an existing style into the current one.
+
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-.
- Then the actual counters used are
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumi
+DependsOn
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+ The name of a style whose preamble should be output
+\emph on
+before
+\emph default
+ this one.
+ This allows to ensure some ordering of the preamble snippets when macros
+ definitions depend on one another.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-myenumii
+Note that, besides that functionality, there is no way to ensure any ordering
+ of preambles.
+ The ordering that you see in a given version of LyX may change without
+ warning in later versions.
\end_layout
\end_inset
-,
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiii
+EndLabeltype
\end_layout
\end_inset
-, and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiv
+
+\emph on
+No_Label
+\emph default
+, Box, Filled_Box, Static
\end_layout
\end_inset
-, much as in LaTeX.
- These counters must all be declared separately.
-\begin_inset Newline newline
-\end_inset
+] The type of label that stands at the end of the paragraph (or sequence
+ of paragraphs if
+\begin_inset Flex Code
+status collapsed
-See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\begin_layout Plain Layout
+LatexType
+\end_layout
\end_inset
- for details on counters.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Environment
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
-
+,
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+Item_Environment
+\end_layout
\end_inset
-.
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+List_Environment
\end_layout
-\begin_layout Description
+\end_inset
+
+).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelIndent
+No_Label
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
+ means
+\begin_inset Quotes eld
+\end_inset
+
+nothing
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Box
\end_layout
-\begin_layout Description
+\end_inset
+
+ (resp.
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Labelsep
+\begin_inset space ~
+\end_inset
+
+Filled_Box
\end_layout
\end_inset
- [
+) is a white (resp.
+\begin_inset space ~
+\end_inset
+
+black) square suitable for end of proof markers,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Static
\end_layout
\end_inset
-] The horizontal space between the label and the text body.
- Only used for labels that are not above the text body.
+ is an explicit text string.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+EndLabelString
\end_layout
\end_inset
\end_inset
- labeltype.
- When
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+EndLabelType
\end_layout
-\end_inset
-
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
\end_inset
.
-\begin_inset Foot
-status collapsed
+
+\end_layout
-\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-@
+Font
+\end_layout
+
+\end_inset
+
+ The font used for both the text body
\emph on
-style-name
+and
\emph default
-@
-\end_layout
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
- will be replaced by the expanded
+.
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+LabelFont
\end_layout
\end_inset
- of style
+ to the same value.
+ So you should define this one first if you also want to define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
+LabelFont
\end_layout
\end_inset
.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
-
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+FreeSpacing
\end_layout
\end_inset
- [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:FreeSpacing"
+
+\end_inset
+
+[
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+0
\end_layout
\end_inset
-] This is used inside the appendix instead of
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
-.
- Note that every
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+FreeSpacing
\end_layout
\end_inset
- statement resets
+ can be enabled.
+ Note that LyX will create protected blanks for the additional blanks when
+ in another mode than LaTeX-mode.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+HTML*
\end_layout
\end_inset
- too.
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Style-XHTML"
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelTag
+InnerTag
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+ [[FIXME]] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelType
+InPreamble
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
- Enumerate, Itemize, Bibliography
+[1, 0]
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+ If 1, marks the style as to be included in the document preamble rather
+ than in the document body.
+ This is useful for document classes that want such information as the title
+ and author to appear in the preamble.
+ Note that this works only for styles for which the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LatexType
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
- Use protected spaces (like
-\begin_inset space ~
-\end_inset
-
-that one) if you want more than one word as the label.
-
-\end_layout
-
-\begin_layout Itemize
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+Command
\end_layout
\end_inset
- means the label is simply whatever
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Paragraph
\end_layout
\end_inset
- declares it to be.
- Note that this really is `static'.
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+InTitle
\end_layout
\end_inset
- and
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+[1, 0]
\end_layout
\end_inset
- are special cases of
+ If 1, marks the style as being part of a title block (see also the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+TitleLatexType
\end_layout
\end_inset
-.
- The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this style.
- This might be used with the
-\begin_inset Flex MenuItem
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Abstract
+TitleLatexName
\end_layout
\end_inset
- style, for example.
+ global entries).
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+ItemSep
\end_layout
\end_inset
- is a special case for the caption-labels
-\begin_inset Quotes eld
-\end_inset
-
-Figure
-\begin_inset Quotes erd
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+float=0
+\end_layout
-Table
-\begin_inset Quotes erd
\end_inset
-.
-
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
+ environment's
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+Parsep
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float: It is
- hardcoded to be `FloatType N', where N is the value of the counter associated
- with the float.
-\end_layout
-
-\begin_layout Itemize
-The
+.
+ But the whole items of the environment are additionally separated with
+ this
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+Itemsep
\end_layout
\end_inset
- label type defines automatically numbered labels.
- The
+.
+ Note that this is a
+\emph on
+ multiplier.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+ItemTag
\end_layout
\end_inset
- will be expanded to resolve any counter references it contains: For example,
- it might be
-\begin_inset Quotes eld
-\end_inset
-
+ [[FIXME]] (Used only with XML-type formats.)
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Section
-\backslash
-thechapter.
-\backslash
-thesection
+KeepEmpty
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\emph on
+0
+\end_layout
\end_inset
- for more information on counters.
-\end_layout
-
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+1
\end_layout
\end_inset
- produces the usual sort of enumeration labels.
- At present, it is hardcoded to use Arabic numerals, lowercase letters,
- small Roman numerals, and uppercase letters for the four possible depths.
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a style can be used
+ as some kind of break, which does not contain actual text.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemize
+LabelBottomsep
\end_layout
\end_inset
- produces various bullets at the different levels.
- It is also hardcoded.
-\end_layout
-
-\begin_layout Itemize
+ [float=0] The vertical space between the label and the text body.
+ Only used for labels that are above the text body (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+Top_Environment
\end_layout
\end_inset
- is used internally by LyX and should be used only with
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType BibEnvironment
+Centered_Top_Environment
\end_layout
\end_inset
-.
+).
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+LabelCounter
\end_layout
\end_inset
- Note that this will completely override any prior
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+string=""
\end_layout
\end_inset
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
+]
+\begin_inset Newline newline
\end_inset
+The name of the counter for automatic numbering.
+
+\begin_inset Newline newline
+\end_inset
+This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+LabelType
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:I18n"
-
-\end_inset
-
- for details on its use.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Counter
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
+.
+ In that case, the counter will be stepped each time the style appears.
+
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+This
+\emph on
+may
+\emph default
+ also be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+LabelType
\end_layout
\end_inset
- An optional parameter for the corresponding
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Enumerate
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within LyX.
-\end_layout
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelCounter myenum
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:LatexType"
+\begin_inset Quotes erd
\end_inset
-[
+.
+ Then the actual counters used are
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
+myenumi
\end_layout
\end_inset
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment, Bib_Environment
+myenumii
\end_layout
\end_inset
-] How the style should be translated into LaTeX.
-\begin_inset Foot
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+myenumiii
+\end_layout
+
+\end_inset
+
+, and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+myenumiv
\end_layout
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
-\end_layout
-
+, much as in LaTeX.
+ These counters must all be declared separately.
+\begin_inset Newline newline
\end_inset
+See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+ for details on counters.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+LabelFont
\end_layout
\end_inset
- means nothing special.
-
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+LabelIndent
\end_layout
\end_inset
- means
+ Text that indicates how far a label should be indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
-\end_layout
+Labelsep
+\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+string=""
\end_layout
\end_inset
- means
+] The horizontal space between the label and the text body.
+ Only used for labels that are not above the text body.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+LabelString
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+string=""
\end_layout
\end_inset
- is the same as
+] The string used for a label with a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Static
\end_layout
\end_inset
-, except that an
+ labeltype.
+ When
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+LabelCounter
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-List_Environment
-\end_layout
+ is set, this string can be contain the special formatting commands described
+ in Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
- is the same as
-\begin_inset Flex Code
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Item_Environment
-\end_layout
-
-\end_inset
-
-, except that
+For the sake of backwards compatibility, the string
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+@
+\emph on
+style-name
+\emph default
+@
\end_layout
\end_inset
- is passed as an argument to the environment.
-
+ will be replaced by the expanded
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+LabelString
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex MenuItem
+ of style
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\bar under
-Edit
-\bar default
-\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\begin_inset space ~
-\end_inset
-
-settings
+\emph on
+style-name
\end_layout
\end_inset
- dialog.
-
-\end_layout
-
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
-\end_layout
-
-\begin_layout LyX-Code
+.
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
-\end_layout
+\end_inset
-\begin_layout Standard
-or:
+.
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
-
-\backslash
-end{latexname}.
-\end_layout
-\begin_layout Standard
-depending upon the LaTeX type.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+LabelStringAppendix
\end_layout
\end_inset
\end_inset
-] If you put styles into environments, the leftmargins are not simply added,
- but added with a factor
-\begin_inset Formula $\frac{4}{depth+4}$
-\end_inset
-
-.
- Note that this parameter is also used when the margin is defined as
+] This is used inside the appendix instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LabelString
\end_layout
\end_inset
- or
+.
+ Note that every
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+LabelString
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
-
-\begin_inset Newline newline
-\end_inset
-
-The argument is passed as a string.
- For example
-\begin_inset Quotes eld
-\end_inset
-
-
+ statement resets
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+LabelStringAppendix
\end_layout
\end_inset
+ too.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelTag
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
\end_inset
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+LabelType
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
+ Enumerate, Itemize, Bibliography
+\end_layout
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
\end_inset
+]
+\end_layout
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--
+Manual
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces (like
+\begin_inset space ~
\end_inset
-.
- This way was chosen so that the look is the same with each used screen
- font.
+that one) if you want more than one word as the label.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Margin
+Static
\end_layout
\end_inset
- [
+ means the label is simply whatever
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+LabelString
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
+ declares it to be.
+ Note that this really is `static'.
+\end_layout
-The kind of margin that the style has on the left side.
-
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+Top_Environment
\end_layout
\end_inset
- just means a fixed margin.
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+Centered_Top_Environment
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex MenuItem
+ are special cases of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+Static
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-
-\begin_inset Flex Code
+.
+ The label will be printed above the paragraph, but only at the top of an
+ environment or the top of a chain of paragraphs with this style.
+ This might be used with the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Dynamic
+Abstract
\end_layout
\end_inset
- means that the margin depends on the size of the label.
- This is used for automatic enumerated headlines.
- It is obvious that the headline
-\begin_inset Quotes eld
-\end_inset
+ style, for example.
+\end_layout
-5.4.3.2.1 Very long headline
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
- must have a wider left margin (as wide as
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Sensitive
+\end_layout
-5.4.3.2.1
-\begin_inset Quotes erd
\end_inset
- plus the space) than
+ is a special case for the caption-labels
\begin_inset Quotes eld
\end_inset
-3.2 Very long headline
+Figure
\begin_inset Quotes erd
\end_inset
-, even if standard
+ and
\begin_inset Quotes eld
\end_inset
-word processors
+Table
\begin_inset Quotes erd
\end_inset
- are not able to do this.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-First_Dynamic
-\end_layout
-
-\end_inset
-
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
+.
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+Sensitive
\end_layout
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Counter
\end_layout
\end_inset
- [
+ label type defines automatically numbered labels.
+ The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LabelString
\end_layout
\end_inset
-,
+ will be expanded to resolve any counter references it contains: For example,
+ it might be
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Section
+\backslash
+thechapter.
+\backslash
+thesection
\end_layout
\end_inset
-] Whether fragile commands in this style should be
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
+\begin_inset Quotes erd
+\end_inset
-\backslash
-protect
-\end_layout
+.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether this command should itself be protected.)
+ for more information on counters.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Newline
+Enumerate
\end_layout
\end_inset
- [
+ produces the usual sort of enumeration labels.
+ At present, it is hardcoded to use Arabic numerals, lowercase letters,
+ small Roman numerals, and uppercase letters for the four possible depths.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Itemize
\end_layout
\end_inset
-,
+ produces various bullets at the different levels.
+ It is also hardcoded.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Bibliography
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
+ is used internally by LyX and should be used only with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-
+LatexType BibEnvironment
\end_layout
\end_inset
-) or not.
- The translation can be switched off to allow more comfortable LaTeX editing
- inside LyX.
+.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LangPreamble
\end_layout
\end_inset
- [
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LangPreamble
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
-
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-] If set to true, and if
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+EndLangPreamble
\end_layout
\end_inset
- (usually
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Standard
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\end_inset
-) paragraphs are being indented, then the indentation of such a paragraph
- following one of this type will be suppressed.
- (So this will not affect the display of non-default paragraphs.)
+ for details on its use.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+LatexName
\end_layout
\end_inset
- Name of a style that has replaced this style.
- This is used to rename a style, while keeping backward compatibility.
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+LatexParam
\end_layout
\end_inset
- [
+ An optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int=0
+LatexName
\end_layout
\end_inset
-] The number of optional arguments that can be used with this style.
- This is useful for things like section headings, and only makes sense with
- LaTeX.
- Note that, on output, the optional arguments will all precede any required
- arguments (see below).
- So one can have constructs like:
-\end_layout
-
-\begin_deeper
-\begin_layout LyX-Code
-
-\backslash
-mycmd[opt1]{req1}{contents of paragraph}
-\end_layout
-
-\begin_layout Standard
-but one cannot have things like:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-mycmd[opt1]{req1}[opt2]{contents of paragraph}
-\end_layout
-
-\begin_layout Standard
-at least, not without ERT (with which you can have anything).
-
+ stuff.
+ This parameter cannot be changed from within LyX.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+LatexType
\end_layout
-\end_inset
-
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:ParbreakIsNewline"
-
\end_inset
[
\begin_layout Plain Layout
\emph on
-0
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+List_Environment, Bib_Environment
\end_layout
\end_inset
-] Indicates that paragraphs will not be separated by an empty line in LaTeX
- output, but only by a line break; together with
+] How the style should be translated into LaTeX.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru 1
+LatexType
\end_layout
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
\end_layout
-\begin_layout Description
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParIndent
+Paragraph
\end_layout
\end_inset
- [
+ means nothing special.
+
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Command
\end_layout
\end_inset
-] The indent of the very first line of a paragraph.
- The
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
- will be fixed for a certain style.
- The exception is the default style, since the indentation for these paragraphs
- can be prohibited with
+.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+Environment
+\end_layout
+
+\end_inset
+
+ means
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
.
- Also,
+
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Item_Environment
\end_layout
\end_inset
- style paragraphs inside environments use the
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+Environment
\end_layout
\end_inset
- of the environment, not their native one.
- For example,
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+
+\backslash
+item
\end_layout
\end_inset
- paragraphs inside an enumeration are not indented.
+ is generated for each paragraph of this environment.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parsep
+List_Environment
\end_layout
\end_inset
- [
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+Item_Environment
\end_layout
\end_inset
-] The vertical space between two paragraphs of this style.
-\end_layout
-
-\begin_layout Description
+, except that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
+LabelWidthString
\end_layout
\end_inset
- [
+ is passed as an argument to the environment.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+LabelWidthString
\end_layout
\end_inset
-] LyX allows the user to choose either
-\begin_inset Quotes eld
-\end_inset
+ can be defined in the
+\begin_inset Flex MenuItem
+status collapsed
-indent
-\begin_inset Quotes erd
+\begin_layout Plain Layout
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
- or
-\begin_inset Quotes eld
-\end_inset
+settings
+\end_layout
-skip
-\begin_inset Quotes erd
\end_inset
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
+ dialog.
+
+\end_layout
-indent
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
- is chosen, this value is completely ignored.
- When
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
-skip
-\begin_inset Quotes erd
-\end_inset
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
+\end_layout
- is chosen, the parindent of a LaTeXtype
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+or:
+\end_layout
-Paragraph
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
- style is ignored and all paragraphs are separated by this parskip argument.
- The vertical space is calculated with
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+
+\backslash
+end{latexname}.
+\end_layout
+
+\begin_layout Standard
+depending upon the LaTeX type.
+\end_layout
+
+\end_deeper
+\begin_layout Description
+
+\change_inserted -712698321 1354263086
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-value
-\begin_inset space ~
-\end_inset
-* DefaultHeight
+\change_inserted -712698321 1353866852
+LeftDelim
\end_layout
\end_inset
- where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+
+\change_inserted -712698321 1353866852
+string
\end_layout
\end_inset
- is the height of a row with the normal font.
- This way, the look stays the same with different screen fonts.
-\end_layout
-
-\begin_layout Description
+] A string that is put at the beginning of the style content.
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+
+\change_inserted -712698321 1354263086
+<br/>
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:PassThru"
+.
+\change_unchanged
-\end_inset
+\end_layout
-[
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LeftMargin
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+string=""
\end_layout
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
+] If you put styles into environments, the leftmargins are not simply added,
+ but added with a factor
+\begin_inset Formula $\frac{4}{depth+4}$
+\end_inset
+
+.
+ Note that this parameter is also used when the margin is defined as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Manual
\end_layout
-\begin_layout Description
+\end_inset
+
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+Dynamic
\end_layout
\end_inset
+.
+ Then it is added to the manual or dynamic margin.
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Preamble"
-
+\begin_inset Newline newline
\end_inset
-Information to be included in the LaTeX preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
+The argument is passed as a string.
+ For example
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndPreamble
+MM
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+MM
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the normal font.
+ You can get a negative width by prefixing the string with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+-
\end_layout
\end_inset
-] The prefix to use when creating labels referring to paragraphs of this
- type.
- This allows the use of formatted references.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RequiredArgs
+Margin
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=0
-\end_layout
-
-\end_inset
-] The number of required arguments that the LaTeX command or environment
- corresponding to this style expects.
- In the case of a command, these are required arguments
\emph on
-other than
+Static
\emph default
- that associated with the content of the paragraph itself.
- These do not actually have to be provided: LyX will output empty arguments
- if necessary.
- Note that optional arguments will be output before required arguments.
- See the discussion of the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-OptionalArgs
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
- tag above for more information.
-\end_layout
+]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+The kind of margin that the style has on the left side.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+Static
\end_layout
\end_inset
- [
+ just means a fixed margin.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Manual
\end_layout
\end_inset
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
-
-\end_inset
-
-Whether the style requires the feature
-\begin_inset Flex Code
+ means that the left margin depends on the string entered in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-string
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\end_layout
\end_inset
-.
- See the description of
+ dialog.
+ This is used to typeset nice lists without tabulators.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+Dynamic
\end_layout
\end_inset
- above (page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+ means that the margin depends on the size of the label.
+ This is used for automatic enumerated headlines.
+ It is obvious that the headline
+\begin_inset Quotes eld
+\end_inset
+
+5.4.3.2.1 Very long headline
+\begin_inset Quotes erd
+\end_inset
+ must have a wider left margin (as wide as
+\begin_inset Quotes eld
\end_inset
-) for information on `features'.
-
-\end_layout
+5.4.3.2.1
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+ plus the space) than
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-RightMargin
-\end_layout
+3.2 Very long headline
+\begin_inset Quotes erd
+\end_inset
+
+, even if standard
+\begin_inset Quotes eld
+\end_inset
+word processors
+\begin_inset Quotes erd
\end_inset
- [
+ are not able to do this.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+First_Dynamic
\end_layout
\end_inset
-] Similar to
+ is similar, but only the very first row of the paragraph is dynamic, while
+ the others are static; this is used, for example, for descriptions.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Right_Address_Box
\end_layout
\end_inset
-.
+ means the margin is chosen in a way that the longest row of this paragraph
+ fits to the right margin.
+ This is used to typeset an address on the right edge of the page.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spacing
+NeedProtect
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-single
-\emph default
-, onehalf, double, other
+0
\end_layout
\end_inset
-
-\emph on
-value
-\emph default
-] This defines what the default spacing should be in the style.
- The arguments
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-single
+1
\end_layout
\end_inset
-,
+] Whether fragile commands in this style should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
+
+\backslash
+protect
\end_layout
\end_inset
- and
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether this command should itself be protected.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-double
+Newline
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-other
+0
\end_layout
\end_inset
-, then you should also provide a numerical argument which will be the actual
- multiplier value.
- Note that, contrary to other parameters,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+
+\emph on
+1
\end_layout
\end_inset
- implies the generation of specific LaTeX code, using the package
-\family roman
-
+] Whether newlines are translated into LaTeX newlines (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-setspace.sty
+
+\backslash
+
+\backslash
+
\end_layout
\end_inset
-.
+) or not.
+ The translation can be switched off to allow more comfortable LaTeX editing
+ inside LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spellcheck
+NextNoIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0
+1
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-1
+0
\end_layout
\end_inset
-] Spellcheck paragraphs of this style.
- Default is true.
-\end_layout
-
-\begin_layout Description
+] If set to true, and if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TextFont
+DefaultStyle
\end_layout
\end_inset
- The font used for the text body .
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+ (usually
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TocLevel
+Standard
\end_layout
\end_inset
+) paragraphs are being indented, then the indentation of such a paragraph
+ following one of this type will be suppressed.
+ (So this will not affect the display of non-default paragraphs.)
+\end_layout
-\series medium
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-[int]
+ObsoletedBy
\end_layout
\end_inset
-
-\series default
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
+ Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
\end_layout
\begin_layout Description
+
+\change_deleted -712698321 1353679722
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TopSep
+OptionalArgs
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+int=0
\end_layout
\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this style is separated from the previous paragraph.
- If the previous paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+] The number of optional arguments that can be used with this style.
+ This is useful for things like section headings, and only makes sense with
+ LaTeX.
+ Note that, on output, the optional arguments will all precede any required
+ arguments (see below).
+ So one can have constructs like:
+\end_layout
+
+\begin_deeper
+\begin_layout LyX-Code
+
+\change_deleted -712698321 1353679722
+
+\backslash
+mycmd[opt1]{req1}{contents of paragraph}
+\end_layout
+
+\begin_layout Standard
+
+\change_deleted -712698321 1353679722
+but one cannot have things like:
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_deleted -712698321 1353679722
+
+\backslash
+mycmd[opt1]{req1}[opt2]{contents of paragraph}
+\end_layout
+
+\begin_layout Standard
+
+\change_deleted -712698321 1353679722
+at least, not without ERT (with which you can have anything).
+
+\change_unchanged
+
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ParbreakIsNewline
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Indicates that paragraphs will not be separated by an empty line in LaTeX
+ output, but only by a line break; together with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru 1
+\end_layout
+
+\end_inset
+
+, this allows to emulate a plain text editor (like the ERT inset).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ParIndent
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
+\end_layout
+
+\end_inset
+
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parindent
+\end_layout
+
+\end_inset
+
+ will be fixed for a certain style.
+ The exception is the default style, since the indentation for these paragraphs
+ can be prohibited with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NextNoIndent
+\end_layout
+
+\end_inset
+
+.
+ Also,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\end_inset
+
+ style paragraphs inside environments use the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parindent
+\end_layout
+
+\end_inset
+
+ of the environment, not their native one.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\end_inset
+
+ paragraphs inside an enumeration are not indented.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parsep
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
+
+\end_inset
+
+] The vertical space between two paragraphs of this style.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parskip
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
+
+\end_inset
+
+] LyX allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
+
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ or
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ to typeset a document.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen, this value is completely ignored.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen, the parindent of a LaTeXtype
+\begin_inset Quotes eld
+\end_inset
+
+Paragraph
+\begin_inset Quotes erd
+\end_inset
+
+ style is ignored and all paragraphs are separated by this parskip argument.
+ The vertical space is calculated with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+value
+\begin_inset space ~
+\end_inset
+
+* DefaultHeight
+\end_layout
+
+\end_inset
+
+ where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultHeight
+\end_layout
+
+\end_inset
+
+ is the height of a row with the normal font.
+ This way, the look stays the same with different screen fonts.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that LaTeX would require.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
+
+\end_inset
+
+ Information to be included in the LaTeX preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RefPrefix
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The prefix to use when creating labels referring to paragraphs of this
+ type.
+ This allows the use of formatted references.
+\end_layout
+
+\begin_layout Description
+
+\change_deleted -712698321 1353681258
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RequiredArgs
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=0
+\end_layout
+
+\end_inset
+
+] The number of required arguments that the LaTeX command or environment
+ corresponding to this style expects.
+ In the case of a command, these are required arguments
+\emph on
+other than
+\emph default
+ that associated with the content of the paragraph itself.
+ These do not actually have to be provided: LyX will output empty arguments
+ if necessary.
+ Note that optional arguments will be output before required arguments.
+ See the discussion of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+OptionalArgs
+\end_layout
+
+\end_inset
+
+ tag above for more information.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Requires
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Whether the style requires the feature
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+.
+ See the description of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Provides
+\end_layout
+
+\end_inset
+
+ above (page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+
+) for information on `features'.
+
+\change_inserted -712698321 1353693134
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1353693371
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353693146
+ResetArgs
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353693235
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353693235
+1
+\end_layout
+
+\end_inset
+
+] Resets the LaTeX arguments of this style (as defined via the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353693371
+Argument
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ tag).
+ This is useful if you have copied a style via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353693302
+CopyStyle
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, but you do not want to inherit its (required and optional) arguments.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1354263074
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353866876
+RightDelim
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353866873
+string
+\end_layout
+
+\end_inset
+
+] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263069
+<br/>
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RightMargin
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
+\end_layout
+
+\end_inset
+
+] Similar to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LeftMargin
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Spacing
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+single
+\emph default
+, onehalf, double, other
+\end_layout
+
+\end_inset
+
+
+\emph on
+value
+\emph default
+] This defines what the default spacing should be in the style.
+ The arguments
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+single
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onehalf
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+double
+\end_layout
+
+\end_inset
+
+ correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ If you specify the argument
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+other
+\end_layout
+
+\end_inset
+
+, then you should also provide a numerical argument which will be the actual
+ multiplier value.
+ Note that, contrary to other parameters,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Spacing
+\end_layout
+
+\end_inset
+
+ implies the generation of specific LaTeX code, using the package
+\family roman
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+setspace.sty
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Spellcheck
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Spellcheck paragraphs of this style.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TextFont
+\end_layout
+
+\end_inset
+
+ The font used for the text body .
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TocLevel
+\end_layout
+
+\end_inset
+
+
+\series medium
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\series medium
+[int]
+\end_layout
+
+\end_inset
+
+
+\series default
+ The level of the style in the table of contents.
+ This is used for automatic numbering of section headings.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TopSep
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
+
+\end_inset
+
+] The vertical space with which the very first of a chain of paragraphs
+ with this style is separated from the previous paragraph.
+ If the previous paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:I18n"
+
+\end_inset
+
+Internationalization of Paragraph Styles
+\end_layout
+
+\begin_layout Standard
+LyX has long supported internationalization of layout information, but,
+ until version 2.0, this applied only to the user interface and not to, say,
+ PDF output.
+ Thus, French authors were forced to resort to ugly hacks if they wanted
+ `
+\lang french
+Théorème
+\lang english
+ 1' instead of `Theorem 1'.
+ Thanks to Georg Baum, that is no longer the case.
+\end_layout
+
+\begin_layout Standard
+If a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Style
+\end_layout
+
+\end_inset
+
+ defines text that is to appear in the typeset document, it may use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ to support non-English and even multi-language documents correctly.
+ The following excerpt (from the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+theorems-ams.inc
+\end_layout
+
+\end_inset
+
+ file) shows how this works:
+\end_layout
+
+\begin_layout LyX-Code
+Preamble
+\end_layout
+
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
+
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
+
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
+
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
+
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
+
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+In principle, any legal LaTeX may appear in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ tags, but in practice they will typically look as they do here.
+ The key to correct translation of the typeset text is the definition of
+ the LaTeX command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+claimname
+\end_layout
+
+\end_inset
+
+ and its use in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newtheorem
+\end_layout
+
+\end_inset
+
+.
+
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
+\end_inset
+
+ tag provides for internationalization based upon the overall language of
+ the document.
+ The contents of the tag will be included in the preamble, just as with
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
+
+\end_inset
+
+ tag.
+ What makes it special is the use of the
+\begin_inset Quotes eld
+\end_inset
+
+function
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+_()
+\end_layout
+
+\end_inset
+
+, which will be replaced, when LyX produces LaTeX output, with the translation
+ of its argument into the document language.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ tag is more complex, since it is meant to provide support for multi-language
+ documents and so offers an interface to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+babel
+\end_layout
+
+\end_inset
+
+ package.
+ Its contents will be added to the preamble once for each language that
+ appears in the document.
+ In this case, the argument to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+_()
+\end_layout
+
+\end_inset
+
+ will be replaced with its translation into the language in question; the
+ expression
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$lang
+\end_layout
+
+\end_inset
+
+ is replaced by the language name (as used by the babel package).
+\end_layout
+
+\begin_layout Standard
+A German document that also included a French section would thus have the
+ following in the preamble:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captionsfrench{
+\backslash
+renewcommand{
+\backslash
+claimname}{Affirmation}}
+\backslash
+addto
+\backslash
+captionsngerman{
+\backslash
+renewcommand{
+\backslash
+claimname}{Behauptung}}
+\backslash
+providecommand{
+\backslash
+claimname}{Behauptung}
+\end_layout
+
+\begin_layout Standard
+LaTeX and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+babel
+\end_layout
+
+\end_inset
+
+ will then conspire to produce the correct text in the output.
+\end_layout
+
+\begin_layout Standard
+One important point to note here is that the translations are provided by
+ LyX itself, through the
+\change_inserted -195340706 1334775793
+file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -195340706 1334775793
+layouttranslations
+\end_layout
+
+\end_inset
+
+
+\change_deleted -195340706 1334775793
+same mechanism it uses for internationalization of the user interface
+\change_unchanged
+.
+ This means, in effect, that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ are really only of use in layout files that are provided with LyX, since
+ text entered in user-created layout files will not be seen by LyX's internation
+alization routines
+\change_inserted -195340706 1334775793
+ unless the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -195340706 1334775793
+layouttranslations
+\end_layout
+
+\end_inset
+
+ file is modified accordingly
+\change_unchanged
+.
+ That said, however, any layout created with the intention that it will
+ be included with LyX should use these tags where appropriate.
+
+\change_inserted -195340706 1334775793
+ Please note that the paragraph style translations provided by LyX will
+ never change with a minor update (e.g.
+ from version 2.1.x to 2.1.y).
+ It is however quite likely that a major update (e.g.
+ from 2.0.x to 2.1.y) will introduce new translations or corrections.
+\change_unchanged
+
\end_layout
\begin_layout Subsection
+Floats
\begin_inset CommandInset label
LatexCommand label
-name "sub:I18n"
+name "sub:Floats"
\end_inset
-Internationalization of Paragraph Styles
+
\end_layout
\begin_layout Standard
-LyX has long supported internationalization of layout information, but,
- until version 2.0, this applied only to the user interface and not to, say,
- PDF output.
- Thus, French authors were forced to resort to ugly hacks if they wanted
- `
-\lang french
-Théorème
-\lang english
- 1' instead of `Theorem 1'.
- Thanks to Georg Baum, that is no longer the case.
+Since version 1.3.0 of LyX, it is has been both possible and necessary to
+ define the floats (
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+figure
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+table
+\end_layout
+
+\end_inset
+
+, \SpecialChar \ldots{}
+) in the text class itself.
+ Standard floats are included in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdfloats.inc
+\end_layout
+
+\end_inset
+
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdfloats.inc
\end_layout
\begin_layout Standard
-If a
+to your layout file.
+ If you want to implement a text class that proposes some other float types
+ (like the AGU class bundled with LyX), the information below will hopefully
+ help you:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+Extension
\end_layout
\end_inset
- defines text that is to appear in the typeset document, it may use
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+string
\end_layout
\end_inset
- and
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The file name extension of an auxiliary file for the list of figures (or
+ whatever).
+ LaTeX writes the captions to this file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+GuiName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The string that will be used in the menus and also for the caption.
+ This is translated to the current language if babel is used.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTML*
+\end_layout
+
+\end_inset
+
+ These are used for XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+IsPredefined
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+
+\emph default
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Indicates whether the float is already defined in the document class or
+ if we instead need to load
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
+\end_layout
+
+\end_inset
+
+ and use what it provides to define it on-the-fly.
+ The default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+, which means: use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
+\end_layout
+
+\end_inset
+
+.
+ It should be set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ if the float is already defined by the LaTeX document class.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ListCommand
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' should be omitted.
+ This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+UsesFloatPkg
\end_layout
\end_inset
- to support non-English and even multi-language documents correctly.
- The following excerpt (from the
+ is false, since there is no standard way to generate this command.
+ It is ignored if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+UsesFloatPkg
\end_layout
\end_inset
- file) shows how this works:
+ is true, since in that case there is a standard way to define the command.
\end_layout
-\begin_layout LyX-Code
-Preamble
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_deeper
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
+\begin_layout Plain Layout
+ListName
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-LangPreamble
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-EndBabelPreamble
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within LyX; it is passed to LaTeX for use
+ as the title there; and it is used as the title in XHTML output.
+ It will be translated to the document language.
\end_layout
-\end_deeper
-\begin_layout Standard
-In principle, any legal LaTeX may appear in the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+NumberWithin
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+string
\end_layout
\end_inset
- tags, but in practice they will typically look as they do here.
- The key to correct translation of the typeset text is the definition of
- the LaTeX command
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+=
+\begin_inset Quotes erd
+\end_inset
-\backslash
-claimname
-\end_layout
+\begin_inset Quotes erd
\end_inset
- and its use in
+] This (optional) argument determines whether floats of this class will
+ be numbered within some sectional unit of the document.
+ For example, if within is equal to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newtheorem
+chapter
\end_layout
\end_inset
-.
+, the floats will be numbered within chapters.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Placement
\end_layout
\end_inset
- tag provides for internationalization based upon the overall language of
- the document.
- The contents of the tag will be included in the preamble, just as with
- the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+string
\end_layout
\end_inset
- tag.
- What makes it special is the use of the
-\begin_inset Quotes eld
+=
+\begin_inset Quotes erd
\end_inset
-function
+
\begin_inset Quotes erd
\end_inset
-
+] The default placement for the given class of floats.
+ The string should be as in standard LaTeX:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+t
\end_layout
\end_inset
-, which will be replaced, when LyX produces LaTeX output, with the translation
- of its argument into the document language.
-\end_layout
-
-\begin_layout Standard
-The
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+b
\end_layout
\end_inset
- tag is more complex, since it is meant to provide support for multi-language
- documents and so offers an interface to the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+p
\end_layout
\end_inset
- package.
- Its contents will be added to the preamble once for each language that
- appears in the document.
- In this case, the argument to
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+h
\end_layout
\end_inset
- will be replaced with its translation into the language in question; the
- expression
-\begin_inset Flex Code
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-$$lang
+Note that the order of these letters in the string is irrelevant, like in
+ LaTeX.
\end_layout
\end_inset
- is replaced by the language name (as used by the babel package).
-\end_layout
-
-\begin_layout Standard
-A German document that also included a French section would thus have the
- following in the preamble:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captionsfrench{
-\backslash
-renewcommand{
-\backslash
-claimname}{Affirmation}}
-\backslash
-addto
-\backslash
-captionsngerman{
-\backslash
-renewcommand{
-\backslash
-claimname}{Behauptung}}
-\backslash
-providecommand{
-\backslash
-claimname}{Behauptung}
-\end_layout
-
-\begin_layout Standard
-LaTeX and
+ On top of that there is a new type,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+H
\end_layout
\end_inset
- will then conspire to produce the correct text in the output.
-\end_layout
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-One important point to note here is that the translations are provided by
- LyX itself, through the same mechanism it uses for internationalization
- of the user interface.
- This means, in effect, that
+here
+\begin_inset Quotes erd
+\end_inset
+
+ and nowhere else.
+ Note however that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+H
\end_layout
\end_inset
- and
+ specifier is special and, because of implementation details, cannot be
+ used in non-built in float types.
+ If you do not understand what this means, just use
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+tbp
\end_layout
\end_inset
- are really only of use in layout files that are provided with LyX, since
- text entered in user-created layout files will not be seen by LyX's internation
-alization routines.
- That said, however, any layout created with the intention that it will
- be included with LyX should use these tags where appropriate.
-\end_layout
-
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Floats"
+\begin_inset Quotes erd
\end_inset
-
+.
\end_layout
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is has been both possible and necessary to
- define the floats (
-\begin_inset Flex MenuItem
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+RefPrefix
\end_layout
\end_inset
-,
-\begin_inset Flex MenuItem
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-table
+string
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- Standard floats are included in the file
+] The prefix to use when creating labels referring to floats of this type.
+ This allows the use of formatted references.
+ Note that you can remove any
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdfloats.inc
+RefPrefix
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
+ set by a copied style by using the special value
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
+OFF
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-to your layout file.
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with LyX), the information below will hopefully
- help you:
+, which must be all caps.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Extension
+Style
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- LaTeX writes the captions to this file.
+] The style used when defining the float using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newfloat
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-GuiName
+Type
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-] The string that will be used in the menus and also for the caption.
- This is translated to the current language if babel is used.
+] The
+\begin_inset Quotes eld
+\end_inset
+
+type
+\begin_inset Quotes erd
+\end_inset
+
+ of the new class of floats, like program or algorithm.
+ After the appropriate
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newfloat
\end_layout
-\begin_layout Description
+\end_inset
+
+, commands such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+
+\backslash
+begin{program}
\end_layout
\end_inset
- These are used for XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{algorithm*}
+\end_layout
\end_inset
-.
+ will be available.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IsPredefined
+UsesFloatPkg
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex Code
status open
\end_inset
-
-\emph default
,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] Indicates whether the float is already defined in the document class or
- if we instead need to load
+] Tells us whether this float is defined using the facilities provided by
+
\begin_inset Flex Code
status collapsed
\end_inset
- and use what it provides to define it on-the-fly.
- The default is
+, either by the class file or a package, or on-the-fly by LyX itself.
+\end_layout
+
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+
+\emph on
+type
\end_layout
\end_inset
-, which means: use
+ automatically defines the corresponding counter with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+
+\emph on
+type
\end_layout
\end_inset
.
- It should be set to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
\end_layout
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Flex-insets-and"
+
\end_inset
- if the float is already defined by the LaTeX document class.
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+LyX has supported character styles since version 1.4.0; as of version 1.6.0,
+ these are called Flex insets.
+
+\end_layout
+
+\begin_layout Standard
+Flex insets come in three different kinds:
+\end_layout
+
+\begin_layout Itemize
+character style (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListCommand
+CharStyle
\end_layout
\end_inset
- [
+): These define semantic markup corresponding to such LaTeX commands as
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\backslash
+noun
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+
+\backslash
+code
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The command used to generate a list of floats of this type; the leading
- `
-\backslash
-' should be omitted.
- This
-\emph on
-must
-\emph default
- be given if
+.
+\end_layout
+
+\begin_layout Itemize
+user custom (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+Custom
\end_layout
\end_inset
- is false, since there is no standard way to generate this command.
- It is ignored if
+): These can be used to define custom collapsible insets, similar to TeX
+ code, footnote, and the like.
+ An obvious example is an endnote inset, which is defined in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+endnote
\end_layout
\end_inset
- is true, since in that case there is a standard way to define the command.
+ module.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+XML elements (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
+Element
\end_layout
\end_inset
- [
+): For use with DocBook classes.
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+InsetLayout
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] A title for a list of floats of this kind (list of figures, tables, or
- whatever).
- It is used for the screen label within LyX; it is passed to LaTeX for use
- as the title there; and it is used as the title in XHTML output.
- It will be translated to the document language.
+ tag, which shall be explained in a moment.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NumberWithin
+InsetLayout
\end_layout
\end_inset
- [
+ tag also serves another function: It can be used to customize the general
+ layout of many different types of insets.
+ Currently,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+InsetLayout
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
+ boxes, tables, algorithms, URLs, and optional arguments, as well as to
+ define Flex insets.
+\end_layout
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if within is equal to
+ definition must begin with a line of the form:
+\end_layout
+
+\begin_layout LyX-Code
+InsetLayout <Type>
+\end_layout
+
+\begin_layout Standard
+Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+<Type>
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
+ indicates the inset whose layout is being defined, and here there are
+\change_inserted 5863208 1334489266
+three
+\change_deleted 5863208 1334489267
+two
+\change_unchanged
+ cases.
\end_layout
-\begin_layout Description
+\begin_layout Enumerate
+The layout for a pre-existing inset is being modified.
+ In this case, can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Placement
+<Type>
\end_layout
\end_inset
- [
+ any one of the following:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Algorithm
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The default placement for the given class of floats.
- The string should be as in standard LaTeX:
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-t
+Branch
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-b
+Box
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-p
+Box:shaded
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-h
+ERT
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+Figure
\end_layout
\end_inset
- On top of that there is a new type,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+Foot
\end_layout
\end_inset
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
-\end_inset
-
-here
-\begin_inset Quotes erd
-\end_inset
-
- and nowhere else.
- Note however that the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+Index
\end_layout
\end_inset
- specifier is special and, because of implementation details, cannot be
- used in non-built in float types.
- If you do not understand what this means, just use
-\begin_inset Quotes eld
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tbp
+Info
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+Info:menu
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Info:shortcut
\end_layout
\end_inset
-] The prefix to use when creating labels referring to floats of this type.
- This allows the use of formatted references.
- Note that you can remove any
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+Info:shortcuts
\end_layout
\end_inset
- set by a copied style by using the special value
-\begin_inset Quotes eld
-\end_inset
-
-OFF
-\begin_inset Quotes erd
-\end_inset
-
-, which must be all caps.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+Listings
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Marginal
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The style used when defining the float using
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+Note:Comment
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Type
+Note:Note
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Note:Greyedout
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The
-\begin_inset Quotes eld
-\end_inset
-
-type
-\begin_inset Quotes erd
-\end_inset
-
- of the new class of floats, like program or algorithm.
- After the appropriate
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-newfloat
+\change_deleted -712698321 1353866704
+Opt
+\change_unchanged
+Arg
+\change_inserted -712698321 1353866707
+ument
+\change_unchanged
+
\end_layout
\end_inset
-, commands such as
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+Table
\end_layout
\end_inset
- or
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{algorithm*}
+URL
\end_layout
\end_inset
- will be available.
+.
\end_layout
-\begin_layout Description
+\begin_layout Enumerate
+The layout for a Flex inset is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+<Type>
\end_layout
\end_inset
- [
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
-status open
+status collapsed
\begin_layout Plain Layout
-0
+Flex:<name>
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+name
\end_layout
\end_inset
-] Tells us whether this float is defined using the facilities provided by
-
+ may be be any valid identifier not used by a pre-existing Flex inset.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ Note that the definition of a flex inset
+\emph on
+must
+\emph default
+also include a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+LyXType
\end_layout
\end_inset
-, either by the class file or a package, or on-the-fly by LyX itself.
+ entry, declaring which type of inset it defines.
+\change_inserted 5863208 1334489312
+
\end_layout
-\begin_layout Standard
-Note that defining a float with type
+\begin_layout Enumerate
+
+\change_inserted 5863208 1334492248
+The layout for user specific branch is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-type
+\change_inserted 5863208 1334489384
+<Type>
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-type
+\change_inserted 5863208 1334489392
+Branch:<name>
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Flex-insets-and"
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 5863208 1334489384
+name
+\end_layout
\end_inset
+ may be be any valid identifier of branch defined in user's document.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ The main purpose of this feature is to allow LaTeX wrapping around specific
+ branches as user needs.
+\change_unchanged
\end_layout
\begin_layout Standard
-LyX has supported character styles since version 1.4.0; as of version 1.6.0,
- these are called Flex insets.
-
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
\end_layout
-\begin_layout Standard
-Flex insets come in three different kinds:
+\end_inset
+
+ definition can contain the following entries:
\end_layout
-\begin_layout Itemize
-character style (
+\begin_layout Description
+
+\change_inserted -712698321 1353681390
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+
+\change_inserted -712698321 1353681344
+Argument
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-noun
+\change_inserted -712698321 1353681344
+int
\end_layout
\end_inset
- and
+] Defines argument number <int> of a command\SpecialChar \slash{}
+environment associated with
+ the current layout.
+ The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-code
+\change_inserted -712698321 1353681344
+EndArgument
\end_layout
\end_inset
.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\end_inset
+
+ for details.
\end_layout
-\begin_layout Itemize
-user custom (
+\begin_layout Description
+
+\change_inserted -195340706 1333913893
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Custom
+BabelPreamble
\end_layout
\end_inset
-): These can be used to define custom collapsible insets, similar to TeX
- code, footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
-\begin_inset Flex Code
-status collapsed
+ Preamble for changing languages.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-endnote
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\end_inset
- module.
+.
\end_layout
-\begin_layout Itemize
-XML elements (
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Element
+BgColor
\end_layout
\end_inset
-): For use with DocBook classes.
-\end_layout
-
-\begin_layout Standard
-Flex insets are defined using the
+ The color for the inset's background.
+ The valid colors are defined in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+src/ColorCode.h
\end_layout
\end_inset
- tag, which shall be explained in a moment.
+.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+ContentAsLabel
\end_layout
\end_inset
- tag also serves another function: It can be used to customize the general
- layout of many different types of insets.
- Currently,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+
+\emph on
+0
\end_layout
\end_inset
- can be used to customize the layout parameters for footnotes, marginal
- notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
- boxes, tables, algorithms, URLs, and optional arguments, as well as to
- define Flex insets.
-\end_layout
-
-\begin_layout Standard
-The
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+1
\end_layout
\end_inset
- definition must begin with a line of the form:
+] Whether to use the content of the inset as the label, when the inset is
+ closed.
+ Default is false.
\end_layout
-\begin_layout LyX-Code
-InsetLayout <Type>
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CopyStyle
\end_layout
-\begin_layout Standard
-Here
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+[string]
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are two
- cases.
+ Copies all the features of an existing style into the current one.
+
\end_layout
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+CustomPars
\end_layout
\end_inset
- any one of the following:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+1
\end_layout
\end_inset
-,
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+Decoration
\end_layout
\end_inset
-,
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+Classic
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-ERT
+Minimalistic
\end_layout
\end_inset
-,
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Figure
+Conglomerate
\end_layout
\end_inset
-,
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Foot
+Classic
\end_layout
\end_inset
-,
+, ERT insets generally
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Index
+Minimalistic
\end_layout
\end_inset
-,
+, and character styles
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info
+Conglomerate
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:menu
+Display
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+0
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+
+\emph on
+1
\end_layout
\end_inset
-,
+] Only useful if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Listings
+LatexType
\end_layout
\end_inset
-,
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Marginal
+Environment
\end_layout
\end_inset
-,
+.
+ Indicates whether the environment will stand on its own in LaTeX output
+ or will appear inline with the surrounding text.
+ If set to false, it is supposed that the LaTeX environment ignores white
+ space (including one newline character) after the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Comment
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-,
+ tags.
+ Default is true.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Greyedout
+End
\end_layout
\end_inset
-,
+ Required at the end of the InsetLayout declarations.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OptArg
+Font
\end_layout
\end_inset
-,
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Table
+LabelFont
\end_layout
\end_inset
-, or
+ to the same value, so define this first and define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+LabelFont
\end_layout
\end_inset
-.
+ later if you want them to be different.
+\change_inserted 155139281 1354130923
+
\end_layout
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+\begin_layout Description
+
+\change_inserted 155139281 1354130923
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
-\end_layout
-\end_inset
+\change_inserted 155139281 1354130923
+ForceLocalFontSwitch
+\end_layout
- must be of the form
-\begin_inset Quotes eld
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Flex:<name>
-\end_layout
-\end_inset
+\change_inserted 155139281 1354130923
+\emph on
+0
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, where
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-name
+
+\change_inserted 155139281 1354130923
+1
\end_layout
\end_inset
- may be be any valid identifier not used by a pre-existing Flex inset.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- Note that the definition of a flex inset
-\emph on
-must
-\emph default
-also include a
+] When using babel, always use a local font switch (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
-\end_layout
-\end_inset
+\change_inserted 155139281 1354130923
- entry, declaring which type of inset it defines.
+\backslash
+foreignlanguage
\end_layout
-\begin_layout Standard
-The
+\end_inset
+
+), never a global one (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+
+\change_inserted 155139281 1354130923
+
+\backslash
+selectlanguage
\end_layout
\end_inset
- definition can contain the following entries:
+).
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-BgColor
+ForceLTR
\end_layout
\end_inset
- The color for the inset's background.
- The valid colors are defined in
-\begin_inset Flex Code
-status collapsed
+ Force the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-src/ColorCode.h
-\end_layout
+latex
+\begin_inset Quotes erd
+\end_inset
+ language, leading to Left-to-Right (latin) output, e.
+\begin_inset space \thinspace{}
\end_inset
-.
+g.
+\begin_inset space \space{}
+\end_inset
+
+in TeX code or URL.
+ A kludge.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ContentAsLabel
+ForcePlain
\end_layout
\end_inset
\end_inset
-] Whether to use the content of the inset as the label, when the inset is
- closed.
- Default is false.
-\end_layout
-
-\begin_layout Description
+] Indicates whether the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+PlainLayout
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
-
-\end_inset
-
-).
+ should be used or, instead, the user can change the paragraph style used
+ in the inset.
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-CustomPars
+FreeSpacing
\end_layout
\end_inset
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
-\end_layout
-
-\begin_layout Description
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+FreeSpacing
\end_layout
\end_inset
- can be
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Classic
+ can be enabled.
+ Note that LyX will create protected blanks for the additional blanks when
+ in another mode than LaTeX-mode.
+ Default is false.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+HTML*
\end_layout
\end_inset
-, or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Conglomerate
-\end_layout
+ These tags control XHTML output.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+InToc
\end_layout
\end_inset
-, ERT insets generally
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+
+\emph on
+0
\end_layout
\end_inset
-, and character styles
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+1
\end_layout
\end_inset
-.
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Display
+KeepEmpty
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph on
0
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
1
\end_layout
\end_inset
-] Only useful if
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a style can be used
+ as some kind of break, which does not contain actual text.
+ Default is false.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelFont
\end_layout
\end_inset
- is
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that this definition can never appear before
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Font
\end_layout
\end_inset
-.
- Indicates whether the environment will stand on its own in LaTeX output
- or will appear inline with the surrounding text.
- If set to false, it is supposed that the LaTeX environment ignores white
- space (including one newline character) after the
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}
+LabelString
\end_layout
\end_inset
- and
+ What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+TeX code
\end_layout
\end_inset
- tags.
- Default is true.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+Branch
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
+) modify this label on the fly.
\end_layout
\begin_layout Description
+
+\change_inserted -195340706 1333913893
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+LangPreamble
\end_layout
\end_inset
-
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
+
+ Language dependent preamble.
See section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Font-description"
+reference "sub:I18n"
\end_inset
.
- Note that defining this font automatically defines the
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+LatexName
\end_layout
\end_inset
- to the same value, so define this first and define
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+LatexParam
\end_layout
\end_inset
- later if you want them to be different.
-\end_layout
-
-\begin_layout Description
+ The optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+LatexName
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
-\end_inset
-
-latex
-\begin_inset Quotes erd
-\end_inset
+ stuff, including possible bracket pairs like
+\begin_inset Flex Code
+status collapsed
- language, leading to Left-to-Right (latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+[]
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-in TeX code or URL.
- A kludge.
+.
+ This parameter cannot be changed from within LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ForcePlain
+LatexType
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_deleted -712698321 1353867544
+
\emph on
-0
+Paragraph
+\emph default
+,
+\change_unchanged
+Command, Environment,
+\change_inserted -712698321 1353867573
+None
+\change_deleted -712698321 1353867557
+Item_Environment,
+\change_unchanged
+
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-] Indicates whether the
-\begin_inset Flex Code
-status collapsed
+\change_deleted -712698321 1353867564
+List_Environment
+\change_unchanged
+,
+\change_deleted -712698321 1353867569
+Bib_Environment
+\change_unchanged
-\begin_layout Plain Layout
-PlainLayout
\end_layout
\end_inset
- should be used or, instead, the user can change the paragraph style used
- in the inset.
- Default is false.
-\end_layout
+] How the style should be translated into LaTeX.
+\begin_inset Foot
+status collapsed
-\begin_layout Description
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+LatexType
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
+\end_layout
\end_inset
-).
- Default is false.
+
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
-\end_layout
-\end_inset
+\change_deleted -712698321 1353867582
+Paragraph
+\change_inserted -712698321 1353867583
+None
+\change_unchanged
- These tags control XHTML output.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
+\end_layout
\end_inset
-.
+ means nothing special.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InToc
+Command
\end_layout
\end_inset
- [
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+\backslash
+
\emph on
-0
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Environment
\end_layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
- One would not, for example, want the content of a footnote in a section
- header to be included in the TOC displayed in the outline, but one would
- normally want the content of a character style displayed.
- Default is false: not to include.
-\end_layout
-
-\begin_layout Description
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
-\end_layout
-\end_inset
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
\end_inset
-).
- Default is false.
+.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_deleted -712698321 1353867600
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Item_Environment
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
-
+ is the same as
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+Environment
+\end_layout
\end_inset
-.
- Note that this definition can never appear before
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\backslash
+item
\end_layout
\end_inset
-, lest it be ineffective.
+ is generated for each paragraph of this environment.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_deleted -712698321 1353867600
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+List_Environment
\end_layout
\end_inset
- What will be displayed on the button or elsewhere as the inset label.
- Some inset types (
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TeX code
+Item_Environment
\end_layout
\end_inset
- and
+, except that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+LabelWidthString
\end_layout
\end_inset
-) modify this label on the fly.
+ is passed as an argument to the environment.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelWidthString
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
+\end_inset
+
+ can be defined in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-LatexName
+
+\bar under
+Edit
+\bar default
+\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+aragraph
+\begin_inset space ~
+\end_inset
+
+settings
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
+ dialog.
+
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
+\end_layout
+
+\begin_layout Standard
+or:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+
+\backslash
+end{latexname}.
+\end_layout
+
+\begin_layout Standard
+depending upon the LaTeX type.
\end_layout
+\end_deeper
\begin_layout Description
+
+\change_inserted -712698321 1354263128
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
-\end_layout
-\end_inset
-
- The optional parameter for the corresponding
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1353866742
+LeftDelim
+\change_unchanged
-\begin_layout Plain Layout
-LatexName
\end_layout
\end_inset
- stuff, including possible bracket pairs like
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+
+\change_inserted -712698321 1353866752
+string
\end_layout
\end_inset
-.
- This parameter cannot be changed from within LyX.
-\end_layout
-
-\begin_layout Description
+] A string that is put at the beginning of the layout content.
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+
+\change_inserted -712698321 1354263128
+<br/>
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
-
-\end_inset
+.
+\change_unchanged
-).
\end_layout
\begin_layout Description
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:ParbreakIsNewline"
+] Indicates that paragraphs will not be separated by an empty line in LaTeX
+ output, but only by a line break; together with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru 1
+\end_layout
\end_inset
-).
+, this allows to emulate a plain text editor (like the ERT inset).
Default is false.
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:PassThru"
-
-\end_inset
-
-).
- Default is false.
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that LaTeX would require.
\end_layout
\begin_layout Description
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Preamble"
+ Information to be included in the LaTeX preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
\end_inset
-).
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
\end_inset
-] As with paragraph styles (see page
+] Whether the style requires the feature
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+.
+ See the description of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Provides
+\end_layout
+
+\end_inset
+
+ above (page
\begin_inset CommandInset ref
LatexCommand pageref
-reference "des:Requires"
+reference "des:FreeSpacing"
\end_inset
-).
+) for information on `features'.
+\change_inserted -712698321 1354439699
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1354439705
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+ResetArgs
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+1
+\end_layout
+
+\end_inset
+
+] Resets the LaTeX arguments of this layout (as defined via the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+Argument
+\end_layout
+
+\end_inset
+
+ tag).
+ This is useful if you have copied a style via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354439699
+CopyStyle
+\end_layout
+
+\end_inset
+
+, but you do not want to inherit its (required and optional) arguments.
+
+\change_deleted -712698321 1354439698
+
+\change_unchanged
+
\end_layout
\begin_layout Description
] Whether this inset should use the font of its surrounding environment
or uses its own.
Default is true: uses its own.
+\change_inserted -712698321 1353866806
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1354263134
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353866810
+RightDelim
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353866806
+string
+\end_layout
+
+\end_inset
+
+] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263134
+<br/>
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
\end_inset
-]
+]
\end_layout
\begin_layout Description
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+strikeout
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
underbar
\end_layout
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+uuline
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+uwave
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
no_emph
\end_layout
\end_inset
- and
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_strikeout
+\end_layout
+
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uuline
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uwave
+\end_layout
+
+\end_inset
+
.
Each of these turns on or off the corresponding attribute.
For example,
\end_inset
for the details.
-
\end_layout
\begin_layout Chapter
multiple export formats.
For instance, in the case of a plain text file, it is not exactly an award-winn
ing idea to include the figure as raw PostScript.
- Instead, you'd either prefer to just include a reference to the figure
+ Instead, you would either prefer to just include a reference to the figure
or try to invoke some graphics to ASCII converter to make the final result
look similar to the real graphics.
The external material management allows you to do this, because it is parametri
projects / features.git / blobdiff