-#LyX 2.0 created this file. For more info see http://www.lyx.org/
-\lyxformat 413
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 459
\begin_document
\begin_header
\textclass scrbook
\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 stackrel 0
+\use_package stmaryrd 0
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type numerical
+\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\justification true
\use_refstyle 0
\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
\end_inset
-] The format of the layout file.
+] The format number of the layout file.
\end_layout
\begin_layout Standard
-This tag was introduced with LyX 1.4.0.
- Layout files from LyX 1.3.x and earlier don't have an explicit file format
- and are considered to be of format 1.
- The format for the present version of LyX is format 21.
- But each version of LyX is capable of reading earlier versions' layout
- files, just as they are capable of reading files produced by earlier versions
- of LyX.
- There is, however, no provision for converting to earlier formats.
- So LyX 1.6.x will not read layout files in format 21 but only files in format
- 11 or earlier.
-\end_layout
+This tag was introduced with LyX
+\begin_inset space ~
+\end_inset
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:General-text-class"
+1.4.0.
+ Layout files from older LyX versions do not have an explicit file format
+ and are considered to have
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
+\begin_inset space ~
+\end_inset
+
+1
+\end_layout
+
+\end_inset
+
+.
+ The format for the present version of LyX is format 35.
+ But each version of LyX is capable of reading earlier versions' layout
+ files, just as they are capable of reading files produced by earlier versions
+ of LyX.
+ There is, however, no provision for converting to earlier formats.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:General-text-class"
\end_inset
\end_inset
- block when this document class is output to XHTML.
+ block when the document is output to XHTML.
Typically, this would be used to output CSS style information, but it can
be used for anything that can appear in
\begin_inset Flex Code
\end_inset
Adds information to the document preamble.
- Must end with
+ Must end with
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Quotes eld
\end_inset
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-string]
+<module>
\end_layout
\end_inset
- Specifies a module to be included by default with this document class.
- The module should be specified by filename without the
+] Specifies a module to be included by default with this document class.
+ The module is specified as filename without the
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-string
+<style>
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<module>
\end_layout
\end_inset
-] This tag indicates that the module in question—which should be specified
- by filename without the
+] This tag indicates that the module (which is specified by filename without
+ the
\begin_inset Flex Code
status collapsed
\end_inset
- extension—cannot be used with this document class.
+ extension) cannot be used with this document class.
This might be used in a journal-specific layout file to prevent, say, the
use of the
\begin_inset Flex Code
not
\emph default
be used in a module.
- Modules have their own way of excluding other modules (see
+ Modules have their own way of excluding other modules (see section
+\begin_inset space ~
+\end_inset
+
+
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:Layout-modules"
\end_inset
declarations.
- (Use
+ (Use
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-string
+<style>
\end_layout
\end_inset
-] The layout to use for the table of contents, bibliography, and so forth,
+] The style to use for the table of contents, bibliography, and so forth,
when the document is output to HTML.
- For articles, this should normally be Section; for books, Chapter.
+ For articles, this should normally be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Section
+\end_layout
+
+\end_inset
+
+; for books
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Chapter
+\end_layout
+
+\end_inset
+
+.
If it is not given, then LyX will attempt to figure out which layout to
use.
\end_layout
status collapsed
\begin_layout Plain Layout
-string
+<counter>
\end_layout
\end_inset
] Modifies the properties of the given counter.
- If the counter does not exist, the section is ignored.
+ If the counter does not exist, the statement is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<style>
\end_layout
\end_inset
] Modifies the properties of the given paragraph style.
- If the style does not exist, the section is ignored.
+ If the style does not exist, the statement is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
- As its name implies, this command allows you to include another layout
- definition file within yours to avoid duplicating commands.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<filename>
+\end_layout
+
+\end_inset
+
+] This allows you to include another layout definition file within yours
+ to avoid duplicating commands.
Common examples are the standard layout files, for example,
\begin_inset Flex Code
status collapsed
\end_inset
- This section (re-)defines the layout of an inset.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
+\end_layout
+
+\end_inset
+
+] This section (re-)defines the layout of an inset.
It can be applied to an existing inset or to a new, user-defined inset,
e.g., a new character style.
Must end with
\begin_inset Quotes eld
\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
MMMMM
+\end_layout
+
+\end_inset
+
+
\begin_inset Quotes erd
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<counter>
\end_layout
\end_inset
-] This command deletes an existing counter, usually one defined in an included
- file.
+] Deletes an existing counter, usually one defined in an included file.
\end_layout
\begin_layout Description
\end_inset
- This command deletes an existing float.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<float>
+\end_layout
+
+\end_inset
+
+] Deletes an existing float.
This is particularly useful when you want to suppress a float that has
been defined in an input file.
\end_layout
\end_inset
- This command deletes an existing style.
- This is particularly useful when you want to suppress a style that has
- be defined in an input file.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+] Deletes an existing style.
\end_layout
\begin_layout Description
\end_inset
- A string indicating the file format (as defined in the Preferences dialog)
- produced by this class.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<format>
+\end_layout
+
+\end_inset
+
+] The file format (as defined in the LyX preferences) produced by this document
+ class.
It is mainly useful when
\begin_inset Flex Code
status collapsed
\end_inset
- is `literate' and one wants to define a new type of literate document.
- This string is reset to `docbook', `latex', or `literate' when the correspondin
-g
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+literate
+\end_layout
+
+\end_inset
+
+ and one wants to define a new type of literate document.
+ The format is reset to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+docbook
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ or
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latex
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ when the corresponding
\begin_inset Flex Code
status collapsed
\end_inset
- A string indicating what sort of output documents using this class will
- produce.
- At present, the options are: `docbook', `latex', and `literate'.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+lat
+\emph default
+ex
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+docbook
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+literate
+\end_layout
+
+\end_inset
+
+] Specifies what sort of output documents using this class will produce.
\end_layout
\begin_layout Description
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
.
- A feature is in general the name of a package (
+ A feature is in general the name of a package (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\end_inset
-, \SpecialChar \ldots{}
-) or a macro (
+) or a macro (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\end_inset
-,\SpecialChar \ldots{}
-); the complete list of supported features is unfortunately not documented
- outside the LyX source code—but see
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LaTeXFeatures.cpp
-\end_layout
-
+).
+ See chapter
+\begin_inset space ~
\end_inset
- if you're interested.
-
-\begin_inset Flex MenuItem
-status collapsed
-\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX Configuration
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
\end_inset
- also gives an overview of the supported packages.
+ for the list of features.
\end_layout
\begin_layout Description
.
Multiple features must be separated by commas.
Note that you can only request supported features.
- (Again, see
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LaTeXFeatures.cpp
-\end_layout
-
+ (See chapter
+\begin_inset space ~
\end_inset
- for a list of these.)
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
+
+\end_inset
+
+ for the list of features.)
\end_layout
\begin_layout Description
\end_inset
- A string that indicates the width of the right margin on the screen, for
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] A string that indicates the width of the right margin on the screen, for
example,
\begin_inset Quotes eld
\end_inset
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
MMMMM
+\end_layout
+
+\end_inset
+
+
\begin_inset Quotes erd
\end_inset
\end_inset
- Sets which divisions get numbered.
- Corresponds to the
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=3
+\end_layout
+
+\end_inset
+
+] Sets which divisions get numbered.
+ Corresponds to the
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
- This sequence defines a paragraph style.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<name>
+\end_layout
+
+\end_inset
+
+] This sequence defines a paragraph style.
If the style does not yet exist, it is created; if it does exist, its parameter
s are modified.
Must end with
status collapsed
\begin_layout Plain Layout
-InTitle 1
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
\end_layout
\end_inset
\end_inset
- corresponds to the case where the block of paragraphs which have
+ corresponds to the case where all layouts which have
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-InTitle 1
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
\end_layout
\end_inset
\end_inset
- Sets which divisions are included in the table of contents.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=3
+\end_layout
+
+\end_inset
+
+] Sets which divisions are included in the table of contents.
Corresponds to the
\begin_inset Flex Code
status collapsed
\end_inset
-] The list of available page styles, separated by
+] The list of available page sty\SpecialChar \-
+les, separated by
\begin_inset Quotes eld
\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_deeper
+\begin_layout Quote
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -712698321 1353680127
-.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:I18n"
+\family typewriter
+Argument 1
+\end_layout
-\end_inset
+\begin_layout Quote
- for details on its use.
+\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_inset Quotes erd
+\end_inset
-\begin_layout Description
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
-\end_layout
+\change_inserted -712698321 1355076654
+\begin_inset Quotes eld
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+Short Title|S
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-\emph on
-No_Label
-\emph default
-, Box, Filled_Box, Static
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+).
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+
+\change_inserted -712698321 1355076736
+LabelString
+\change_unchanged
+
\end_layout
\end_inset
- is
+ will be used instead for the menu.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353680665
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\change_inserted -712698321 1353680616
+Tooltip
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+
+\change_inserted -712698321 1353680623
+[string]
\end_layout
\end_inset
- or
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353680874
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+
+\change_inserted -712698321 1353680732
+Mandatory
\end_layout
\end_inset
-).
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-No_Label
-\end_layout
-
-\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -712698321 1353680738
+[int=0]
+\end_layout
-nothing
-\begin_inset Quotes erd
\end_inset
-,
+ 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
-Box
+
+\change_inserted -712698321 1353680808
+{...}
+\change_unchanged
+
\end_layout
\end_inset
- (resp.
+, while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\begin_inset space ~
-\end_inset
-Filled_Box
+\change_inserted -712698321 1353680833
+[...]
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
-\end_inset
-black) square suitable for end of proof markers,
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1353917199
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+
+\change_inserted -712698321 1353680879
+Requires
\end_layout
\end_inset
- is an explicit text string.
-\end_layout
-
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+
+\change_inserted -712698321 1353680874
+[int=0]
\end_layout
\end_inset
- [
+ 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
+
+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
-string=""
+
+\change_inserted -712698321 1353688183
+
+\backslash
+command[][arg]{text}
+\change_unchanged
+
\end_layout
\end_inset
-] The string used for a label with a
+.
+ This can be achieved by the statement
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+
+\change_inserted -712698321 1353681031
+Requires 1
+\change_unchanged
+
\end_layout
\end_inset
-
+ within
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+
+\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
-Font
+
+\change_inserted -712698321 1353681072
+LeftDelim
+\change_unchanged
+
\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 Flex Code
+status collapsed
+\begin_layout Plain Layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\change_inserted -712698321 1353681067
+[string]
+\end_layout
\end_inset
-.
- Note that defining this font automatically defines the
+ defines a custom left delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\change_inserted -712698321 1353681127
+{
+\change_unchanged
+
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
-\end_layout
-\end_inset
+\change_inserted -712698321 1353681133
+[
+\change_unchanged
-.
\end_layout
-\begin_layout Description
+\end_inset
+
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+
+\change_inserted -712698321 1354263104
+<br/>
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
+.
+\change_unchanged
-\end_inset
+\end_layout
-[
+\begin_layout Itemize
+
+\change_inserted -712698321 1355144479
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\change_inserted -712698321 1353681149
+RightDelim
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\change_inserted -712698321 1353681146
+[string]
\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,
+ defines a custom right delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+
+\change_inserted -712698321 1353681158
+}
\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
- These tags are used with XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Paragraph-Style-XHTML"
+\change_inserted -712698321 1353681161
+]
+\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 1354263106
+<br/>
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1355144578
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InPreamble
+
+\change_inserted -712698321 1355144487
+PresetArg
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-[1, 0]
+
+\change_inserted -712698321 1355144500
+[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
-\begin_inset Flex Code
-status collapsed
+ defines an argument that is inserted in any case (alone or in addition
+ to user-specified arguments).
+ Multiple arguments need to be separated by comma.
+\change_unchanged
-\begin_layout Plain Layout
-LatexType
\end_layout
-\end_inset
+\begin_layout Itemize
- is
+\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+
+\change_inserted -712698321 1353917320
+Font
\end_layout
\end_inset
- or
-\begin_inset Flex Code
-status collapsed
+ The font used for the argument content.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-Paragraph
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
.
\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
+LabelFont
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
+ The font used for the label.
+ 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 1355661048
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\change_inserted -712698321 1353917320
+Decoration
\end_layout
\end_inset
- and
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1353917320
+Classic
\end_layout
\end_inset
- global entries).
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemSep
+
+\change_inserted -712698321 1353917320
+Minimalistic
\end_layout
\end_inset
- [
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+
+\change_inserted -712698321 1353917320
+Conglomerate
\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
+, describing the rendering style used for the inset's frame and buttons.
+ Default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parsep
+
+\change_inserted -712698321 1353917320
+Classic
\end_layout
\end_inset
.
- But the whole items of the environment are additionally separated with
- this
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1355747298
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+
+\change_inserted -712698321 1355661057
+AutoInsert
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1355661049
+[int=0]
\end_layout
-\begin_layout Description
+\end_inset
+
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemTag
+
+\change_inserted -712698321 1355661077
+1
+\change_unchanged
+
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
+, this argument is automatically inserted when the respective style is selected.
+ Currently, only one argument per style\SpecialChar \slash{}
+layout can be automatically inserted.
+\change_inserted 155139281 1354198988
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+
+\change_inserted -712698321 1356689813
+By default, the text entered in the LyX workarea in the respective layout
+ is the last (mandatory) argument of a command if the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
-\end_layout
-\end_inset
+\change_inserted -712698321 1356689619
+LatexType
+\change_unchanged
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
+\end_layout
\end_inset
-[
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\change_inserted -712698321 1356689629
+Command
+\change_unchanged
+
\end_layout
\end_inset
-,
+.
+ However, arguments with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
-\end_layout
-\end_inset
+\change_inserted -712698321 1356689679
+post:
+\change_unchanged
-] 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 Description
+\end_inset
+
+ are output after this workarea argument.
+ Note that post-argument numbering restarts at 1, so the first argument
+ following the workarea argument is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+
+\change_inserted -712698321 1356689813
+post:1
+\change_unchanged
+
\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 (
+.
+ Post-arguments are ignored in any other
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+
+\change_inserted -712698321 1356689801
+LatexType
\end_layout
\end_inset
-,
+ than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+
+\change_inserted -712698321 1356689801
+Command
\end_layout
\end_inset
-).
+.
+\change_unchanged
+
\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
-LabelCounter
+
+\change_inserted 155139281 1354199013
+
+\backslash
+item
+\change_unchanged
+
\end_layout
\end_inset
- [
+s (as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
-\end_layout
-\end_inset
+\change_inserted 155139281 1354199102
-]
-\begin_inset Newline newline
-\end_inset
+\backslash
+item[foo]
+\change_unchanged
+
+\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
+) have the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+
+\change_inserted 155139281 1354199044
+item:
+\change_unchanged
+
\end_layout
\end_inset
- is
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+
+\change_inserted 155139281 1354199064
+Argument item:1
+\change_unchanged
+
\end_layout
\end_inset
-.
- In that case, the counter will be stepped each time the style appears.
-
-\begin_inset Newline newline
-\end_inset
+)
+\change_unchanged
-This
-\emph on
-may
-\emph default
- also be given if
+\end_layout
+
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+BabelPreamble
\end_layout
\end_inset
- is
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+BabelPreamble
\end_layout
\end_inset
-, though this case is a bit complicated.
- Suppose you declare
+ declaration for this style.
+ Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-LabelCounter myenum
+EndBabelPreamble
\end_layout
\end_inset
\end_inset
.
- Then the actual counters used are
-\begin_inset Flex Code
-status collapsed
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-myenumi
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\end_inset
-,
+ for details on its use.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumii
+BottomSep
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiii
+float=0
\end_layout
\end_inset
-, and
-\begin_inset Flex Code
+]
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-myenumiv
+Note that a `float' here is a real number, such as: 1.5.
\end_layout
\end_inset
-, 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.
+ 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
status collapsed
\begin_layout Plain Layout
-LabelFont
+Category
\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
+string
+\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
status collapsed
\begin_layout Plain Layout
-LabelIndent
+CommandDepth
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
+ Depth of XML command.
+ Used only with XML-type formats.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Labelsep
+CopyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+string
\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.
+] Copies all the features of an existing style into the current one.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+DependsOn
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+<name>
\end_layout
\end_inset
-] The string used for a label with a
-\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
-Static
+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
- labeltype.
- When
+
+\end_layout
+
+\begin_layout Description
\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
-
-\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-@
+
\emph on
-style-name
+No_Label
\emph default
-@
+, Box, Filled_Box, Static
\end_layout
\end_inset
- will be replaced by the expanded
+] 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
-LabelString
+LatexType
\end_layout
\end_inset
- of style
+ is
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
-\end_layout
+Environment
+\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
+,
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+Item_Environment
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Description
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+List_Environment
\end_layout
\end_inset
- [
+).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+No_Label
\end_layout
\end_inset
-] This is used inside the appendix instead of
+ means
+\begin_inset Quotes eld
+\end_inset
+
+nothing
+\begin_inset Quotes erd
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Box
\end_layout
\end_inset
-.
- Note that every
+ (resp.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Filled_Box
\end_layout
\end_inset
- statement resets
+) 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
-LabelStringAppendix
+Static
\end_layout
\end_inset
- too.
+ is an explicit text string.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelTag
+EndLabelString
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
\end_layout
-\begin_layout Description
+\end_inset
+
+] The string used for a label with a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+Static
\end_layout
\end_inset
- [
+
+\begin_inset Newline newline
+\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
+EndLabelType
\end_layout
\end_inset
-]
+.
+
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+Font
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
- Use protected spaces (like
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
\begin_inset space ~
\end_inset
-that one) if you want more than one word as the label.
-
-\end_layout
-\begin_layout Itemize
+\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
-Static
+LabelFont
\end_layout
\end_inset
- means the label is simply whatever
+ 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
-LabelString
+LabelFont
\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
+FreeSpacing
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+
+\emph on
+0
\end_layout
\end_inset
- are special cases of
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+1
\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
+] Usually LyX does not 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
-Abstract
+FreeSpacing
\end_layout
\end_inset
- style, for example.
+ 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 Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+HTML*
\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
-
- and
-\begin_inset Quotes eld
-\end_inset
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Style-XHTML"
-Table
-\begin_inset Quotes erd
\end_inset
.
-
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+InnerTag
\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.
+ [FIXME] (Used only with XML-type formats.)
\end_layout
-\begin_layout Itemize
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+InPreamble
\end_layout
\end_inset
- label type defines automatically numbered labels.
- The
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\emph on
+0
\end_layout
\end_inset
- will be expanded to resolve any counter references it contains: For example,
- it might be
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-Section
-\backslash
-thechapter.
-\backslash
-thesection
+1
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
-
- for more information on counters.
-\end_layout
-
-\begin_layout Itemize
+] If
\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.
-\end_layout
-
-\begin_layout Itemize
+, marks the style as to be included in the document preamble and not 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
-Itemize
+LatexType
\end_layout
\end_inset
- produces various bullets at the different levels.
- It is also hardcoded.
-\end_layout
-
-\begin_layout Itemize
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+Command
\end_layout
\end_inset
- is used internally by LyX and should be used only with
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType BibEnvironment
+Paragraph
\end_layout
\end_inset
.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+InTitle
\end_layout
\end_inset
- Note that this will completely override any prior
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+
+\emph on
+0
\end_layout
\end_inset
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+1
\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
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+1
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+, marks the style as being part of a title block (see also the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+TitleLatexType
\end_layout
\end_inset
- An optional parameter for the corresponding
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+TitleLatexName
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within LyX.
+ global entries).
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1355932296
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
-\end_layout
-\end_inset
-
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:LatexType"
+\change_inserted -712698321 1355932178
+ItemCommand
+\end_layout
\end_inset
-[
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
+\change_inserted -712698321 1355932181
+string="item"
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-List_Environment, Bib_Environment
-\end_layout
-
+] The LaTeX command sequence declaring an item in a list.
+ The command is to be defined without the preceding backslash (the default
+ is
+\begin_inset Quotes eld
\end_inset
-] How the style should be translated into LaTeX.
-\begin_inset Foot
-status collapsed
+item
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+, resulting in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
-\end_layout
-\end_inset
+\change_inserted -712698321 1355932279
+
+\backslash
+item
+\change_unchanged
- 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
-
+ in the LaTeX output).
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+ItemSep
\end_layout
\end_inset
- means nothing special.
-
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+float=0
\end_layout
\end_inset
- means
+] 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
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
+ParSep
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Itemize
+ But the whole items of the environment are additionally separated with
+ this
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+ItemSep
\end_layout
\end_inset
- means
+.
+ Note that this is a
+\emph on
+ multiplier.
+\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
-}
+ItemTag
\end_layout
\end_inset
-.
-
+ [FIXME] (Used only with XML-type formats.)
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+KeepEmpty
\end_layout
\end_inset
- is the same as
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\emph on
+0
\end_layout
\end_inset
-, except that an
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+1
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+] 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
-List_Environment
+LabelBottomsep
\end_layout
\end_inset
- is the same as
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+float=0
\end_layout
\end_inset
-, except that
+] 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
-LabelWidthString
+Top_Environment
\end_layout
\end_inset
- is passed as an argument to the environment.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelWidthString
-\end_layout
-
+ and
+\begin_inset Newline newline
\end_inset
- can be defined in the
-\begin_inset Flex MenuItem
+
+\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
+Centered_Top_Environment
\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
-
-\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+LabelCounter
\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}$
+] The name of the counter for automatic numbering.
+\begin_inset Newline newline
\end_inset
-.
- Note that this parameter is also used when the margin is defined as
+This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LabelType
\end_layout
\end_inset
- or
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+Counter
\end_layout
\end_inset
.
- Then it is added to the manual or dynamic margin.
-
+ In that case, the counter will be stepped each time the style appears.
\begin_inset Newline newline
\end_inset
-The argument is passed as a string.
- For example
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MM
-\end_layout
-
-\end_inset
-
+This
+\emph on
+may
+\emph default
+ also be given if
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+LabelType
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
\end_inset
-
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+Enumerate
\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
+, though this case is a bit complicated.
+ Suppose you declare
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
--
+LabelCounter myenum
\end_layout
\end_inset
\end_inset
.
- This way was chosen so that the look is the same with each used screen
- font.
-
-\end_layout
-
-\begin_layout Description
+ Then the actual counters used are
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Margin
+myenumi
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+myenumii
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
-
-The kind of margin that the style has on the left side.
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+myenumiii
\end_layout
\end_inset
- just means a fixed margin.
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+myenumiv
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
+, much as in LaTeX.
+ These counters must all be declared separately.
+\begin_inset Newline newline
\end_inset
-Settings
-\end_layout
+See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-
+ for details on counters.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+LabelFont
\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
-
-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
-
-5.4.3.2.1
-\begin_inset Quotes erd
+ The font used for the label.
+ See section
+\begin_inset space ~
\end_inset
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
-3.2 Very long headline
-\begin_inset Quotes erd
-\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
-, even if standard
-\begin_inset Quotes eld
\end_inset
-word processors
-\begin_inset Quotes erd
-\end_inset
+.
+\end_layout
- are not able to do this.
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+LabelIndent
\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
+string=""
\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.
+] Text that indicates how far a label should be indented.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Labelsep
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string=""
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
+] Text that indicates the amount of horizontal space between the label and
+ the text body.
+ Only used for labels that are not above the text body.
\end_layout
-\end_inset
-
-] Whether fragile commands in this style should be
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+LabelString
\end_layout
\end_inset
-'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
-Newline
+string=""
\end_layout
\end_inset
- [
+] The string used for a label with a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Static
\end_layout
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+LabelType
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
+.
+ When
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LabelCounter
+\end_layout
-\backslash
-
-\backslash
+\end_inset
-\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
-) 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
-NextNoIndent
+LabelStringAppendix
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+string=""
\end_layout
\end_inset
-,
+] This is used inside the appendix instead of
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LabelString
\end_layout
\end_inset
-] If set to true, and if
+.
+ Note that every
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+LabelString
\end_layout
\end_inset
- (usually
+ statement resets
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+LabelStringAppendix
\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.)
+ too.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+LabelTag
\end_layout
\end_inset
- Name of a style that has replaced this style.
- This is used to rename a style, while keeping backward compatibility.
+ [FIXME] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+LabelType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=0
+
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment,
+\begin_inset Newline newline
+\end_inset
+
+Centered_Top_Environment, Counter, Sensitive, Enumerate,
+\begin_inset Newline newline
+\end_inset
+
+Itemize, Bibliography
\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).
-
-\end_layout
-
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+Manual
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:ParbreakIsNewline"
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces if you want more than one word as the label.
+
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Static
\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
+ means the label is simply what is declared as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru 1
+LabelString
\end_layout
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
+.
+ Note that this really is `static'.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParIndent
+Top_Environment
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-string=""
-\end_layout
+\begin_inset space ~
+\end_inset
+and
+\begin_inset space ~
\end_inset
-] The indent of the very first line of a paragraph.
- The
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+Centered_Top_Environment
\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
+ are special cases of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+Static
\end_layout
\end_inset
.
- Also,
-\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
-Standard
+Abstract
\end_layout
\end_inset
- style paragraphs inside environments use the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Parindent
+ style, for example.
\end_layout
-\end_inset
-
- of the environment, not their native one.
- For example,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Sensitive
\end_layout
\end_inset
- paragraphs inside an enumeration are not indented.
-\end_layout
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+Figure
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Parsep
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
+Table
+\begin_inset Quotes erd
\end_inset
- [
+.
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+Sensitive
\end_layout
\end_inset
-] The vertical space between two paragraphs of this style.
+ 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
status collapsed
\begin_layout Plain Layout
-Parskip
+Counter
\end_layout
\end_inset
- [
+ defines automatically numbered labels.
+ The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+LabelString
\end_layout
\end_inset
-] LyX allows the user to choose either
+ will be expanded to contain any counters: So the result will for example
+ be
\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
+\begin_inset Flex Code
+status collapsed
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Section
+\backslash
+thechapter.
+\backslash
+thesection
+\end_layout
-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
+.
+ See Section
+\begin_inset space ~
\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_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-\begin_layout Plain Layout
-value
-\begin_inset space ~
\end_inset
-* DefaultHeight
+ for more information on counters.
\end_layout
-\end_inset
-
- where
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+Enumerate
\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.
+ 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 Description
status collapsed
\begin_layout Plain Layout
-PassThru
+Itemize
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:PassThru"
-
-\end_inset
+ produces various bullets at the different levels.
+ It is also hardcoded.
+\end_layout
-[
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Bibliography
\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
-1
+LatexType BibEnvironment
\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
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+LangPreamble
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Preamble"
+ Note that this will completely override any prior
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\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.
+ declaration for this style.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndPreamble
+EndLangPreamble
\end_layout
\end_inset
\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
-RefPrefix
+LatexName
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<name>
\end_layout
\end_inset
-] The prefix to use when creating labels referring to paragraphs of this
- type.
- This allows the use of formatted references.
+] The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RequiredArgs
+LatexParam
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=0
+<parameter>
\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
+] An optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+LatexName
\end_layout
\end_inset
- tag above for more information.
-\end_layout
-
-\begin_layout Description
+ stuff.
+ This parameter cannot be changed from within LyX
+\change_inserted -712698321 1355144804
+ (use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+
+\change_inserted -712698321 1355144804
+Argument
\end_layout
\end_inset
- [
+ for customizable parameters)
+\change_unchanged
+.
+
+\change_inserted -712698321 1355144804
+ This will be output as is after all LaTeX
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -712698321 1355144658
+Arguments
+\change_unchanged
+
\end_layout
\end_inset
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
\end_inset
-Whether the style requires the feature
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
+\begin_inset Newline newline
+\end_inset
+
+List_Environment, Bib_Environment
\end_layout
\end_inset
-.
- See the description of
+] 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
-Provides
+LatexType
\end_layout
\end_inset
- above (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
-) for information on `features'.
-
+
\end_layout
+\begin_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+Paragraph
\end_layout
\end_inset
- [
+ means nothing special.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Command
\end_layout
\end_inset
-] Similar to
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Spacing
+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
-single
+LatexName
\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
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-single
+Item_Environment
\end_layout
\end_inset
-,
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
+Environment
\end_layout
\end_inset
- and
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-double
+
+\backslash
+item
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
+ is generated for each paragraph of this environment.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-other
+List_Environment
\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,
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+Item_Environment
\end_layout
\end_inset
- implies the generation of specific LaTeX code, using the package
-\family roman
+, except that
+\begin_inset Newline newline
+\end_inset
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-setspace.sty
+LabelWidthString
\end_layout
\end_inset
-.
-\end_layout
+ is passed as an argument to the environment.
+\begin_inset Newline newline
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spellcheck
+LabelWidthString
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+ can be defined in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-0
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+settings
\end_layout
\end_inset
-,
+ dialog.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Bib_Environment
\end_layout
\end_inset
-] Spellcheck paragraphs of this style.
- Default is true.
-\end_layout
-
-\begin_layout Description
+ is like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TextFont
+Environment
\end_layout
\end_inset
- The font used for the text body .
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
+ but adds additionally the necessary mandatory argument to the begin statement
+ of the bibliography environment:
+\begin_inset Newline newline
\end_inset
-.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TocLevel
+
+\backslash
+begin{thebibliography}{99}
\end_layout
\end_inset
+ It is therefore only useful for bibliography environments.
+\end_layout
-\series medium
-
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
-\begin_layout Plain Layout
+\begin_layout LyX-Code
-\series medium
-[int]
+\backslash
+LatexName[LatexParam]{\SpecialChar \ldots{}
+}
\end_layout
-\end_inset
+\begin_layout Standard
+or:
+\end_layout
+\begin_layout LyX-Code
-\series default
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
+\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
-TopSep
+
+\change_inserted -712698321 1353866852
+LeftDelim
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+
+\change_inserted -712698321 1353866852
+string
\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
+] 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 Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:I18n"
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1354263086
+<br/>
+\end_layout
\end_inset
-Internationalization of Paragraph Styles
-\end_layout
+.
+\change_unchanged
-\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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+LeftMargin
\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
+] If you put styles into environments, the different
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+LeftMargin
\end_layout
\end_inset
- to support non-English and even multi-language documents correctly.
- The following excerpt (from the
+ are not simply added, but added with a factor
+\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
+\end_inset
+
+.
+ Note that this parameter is also used when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+Margin
\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
+ is defined as
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
+\begin_layout Plain Layout
+Manual
\end_layout
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
+ or
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
+\begin_layout Plain Layout
+Dynamic
\end_layout
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+.
+ Then it is added to the manual or dynamic margin.
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
-\end_layout
+For example
+\begin_inset Quotes eld
+\end_inset
-\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
+MM
\end_layout
\end_inset
- and
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-BabelPreamble
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\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
+MM
\end_layout
\end_inset
- and its use in
+
+\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
-
-\backslash
-newtheorem
+-
\end_layout
\end_inset
+
+\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 Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Margin
\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
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
- tag.
- What makes it special is the use of the
-\begin_inset Quotes eld
+]
+\begin_inset Newline newline
\end_inset
-function
-\begin_inset Quotes erd
-\end_inset
+The kind of margin that the style has on the left side.
+\end_layout
-
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+Static
\end_layout
\end_inset
-, which will be replaced, when LyX produces LaTeX output, with the translation
- of its argument into the document language.
+ just means a fixed margin.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Manual
\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
+ means that the left margin depends on the string entered in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-babel
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\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
+ dialog.
+ This is used to typeset nice lists without tabulators.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+Dynamic
\end_layout
\end_inset
- will be replaced with its translation into the language in question; the
- expression
-\begin_inset Flex Code
-status collapsed
+ 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
-\begin_layout Plain Layout
-$$lang
-\end_layout
+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
- is replaced by the language name (as used by the babel package).
-\end_layout
+5.4.3.2.1
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-A German document that also included a French section would thus have the
- following in the preamble:
-\end_layout
+ plus the space) than
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+3.2 Very long headline
+\begin_inset Quotes erd
+\end_inset
-\backslash
-addto
-\backslash
-captionsfrench{
-\backslash
-renewcommand{
-\backslash
-claimname}{Affirmation}}
-\backslash
-addto
-\backslash
-captionsngerman{
-\backslash
-renewcommand{
-\backslash
-claimname}{Behauptung}}
-\backslash
-providecommand{
-\backslash
-claimname}{Behauptung}
+, even if standard
+\begin_inset Quotes eld
+\end_inset
+
+word processors
+\begin_inset Quotes erd
+\end_inset
+
+ are not able to do this.
\end_layout
-\begin_layout Standard
-LaTeX and
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+First_Dynamic
\end_layout
\end_inset
- will then conspire to produce the correct text in the output.
+ 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.
\end_layout
-\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
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Right_Address_Box
\end_layout
\end_inset
- and
+ 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
+
+\end_deeper
+\begin_layout Description
\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.
- That said, however, any layout created with the intention that it will
- be included with LyX should use these tags where appropriate.
+NeedProtect
\end_layout
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Floats"
-
\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_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+
+\emph on
+0
\end_layout
\end_inset
-,
-\begin_inset Flex MenuItem
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-table
+1
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- Standard floats are included in the file
+] Whether fragile commands in this style should be
\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
+\backslash
+protect
\end_layout
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
+\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:
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether this command should itself be protected.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Extension
+Newline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\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
+
+\emph on
+1
\end_layout
\end_inset
- [
+] Whether newlines are translated into LaTeX newlines (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\backslash
-=
-\begin_inset Quotes erd
-\end_inset
+\backslash
+\end_layout
-\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.
+) 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
-HTML*
+NextNoIndent
\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
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\emph default
-,
\begin_inset Flex Code
status collapsed
\end_inset
-] Indicates whether the float is already defined in the document class or
- if we instead need to load
+] If set to true, and if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+DefaultStyle
\end_layout
\end_inset
- and use what it provides to define it on-the-fly.
- The default is
+ (usually
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Standard
\end_layout
\end_inset
-, which means: use
+) 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
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+ObsoletedBy
\end_layout
\end_inset
-.
- It should be set to
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+<name>
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
+] 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
-ListCommand
+OptionalArgs
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+int=0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\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
-\begin_inset Quotes erd
-\end_inset
+\change_deleted -712698321 1353679722
-] 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
+mycmd[opt1]{req1}{contents of paragraph}
+\end_layout
-\begin_layout Plain Layout
-UsesFloatPkg
+\begin_layout Standard
+
+\change_deleted -712698321 1353679722
+but one cannot have things like:
\end_layout
-\end_inset
+\begin_layout LyX-Code
- is false, since there is no standard way to generate this command.
- It is ignored if
-\begin_inset Flex Code
-status collapsed
+\change_deleted -712698321 1353679722
-\begin_layout Plain Layout
-UsesFloatPkg
+\backslash
+mycmd[opt1]{req1}[opt2]{contents of paragraph}
\end_layout
-\end_inset
+\begin_layout Standard
+
+\change_deleted -712698321 1353679722
+at least, not without ERT (with which you can have anything).
+
+\change_unchanged
- is true, since in that case there is a standard way to define the command.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
+ParbreakIsNewline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\end_inset
-\begin_inset Quotes erd
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
\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.
+] 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
status collapsed
\begin_layout Plain Layout
-NumberWithin
+ParIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+string=""
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Newline newline
\end_inset
-\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+Parindent
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
-\end_layout
-
-\begin_layout Description
+ 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
-Placement
+NextNoIndent
\end_layout
\end_inset
- [
+.
+ Also,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Standard
\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:
+ style paragraphs inside environments use the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-t
+Parindent
\end_layout
\end_inset
-,
+ of the environment, not their native one.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-b
+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
-p
+ParSep
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-h
+float=0
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+] The vertical space between two paragraphs of this style.
+\end_layout
+
+\begin_layout Description
+\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.
+Parskip
\end_layout
\end_inset
- On top of that there is a new type,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+float=0
\end_layout
\end_inset
-, which does not really correspond to a float, since it means: put it
+] LyX allows the user to choose either
\begin_inset Quotes eld
\end_inset
-here
+indent
\begin_inset Quotes erd
\end_inset
- and nowhere else.
- Note however that the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-H
-\end_layout
+ or
+\begin_inset Quotes eld
+\end_inset
+skip
+\begin_inset Quotes erd
\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
+ to separate paragraphs.
+ When
\begin_inset Quotes eld
\end_inset
+indent
+\begin_inset Quotes erd
+\end_inset
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tbp
+Parskip
\end_layout
\end_inset
+ is ignored.
+ When
+\begin_inset Quotes eld
+\end_inset
+skip
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+ParIndent
\end_layout
\end_inset
- [
+ is ignored and all paragraphs are separated by the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Parskip
\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
+ argument.
+ The vertical space is calculated with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+Parskip
+\begin_inset space ~
+\end_inset
+
+* DefaultHeight
\end_layout
\end_inset
- set by a copied style by using the special value
-\begin_inset Quotes eld
-\end_inset
+ where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultHeight
+\end_layout
-OFF
-\begin_inset Quotes erd
\end_inset
-, which must be all caps.
+ 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
status collapsed
\begin_layout Plain Layout
-Style
+PassThru
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\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
+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
status collapsed
\begin_layout Plain Layout
-Type
+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
-string
+EndPreamble
\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
+.
\end_layout
-\end_inset
-
-, commands such as
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+RefPrefix
\end_layout
\end_inset
- or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{algorithm*}
+string
\end_layout
\end_inset
- will be available.
+] 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
-UsesFloatPkg
+RequiredArgs
\end_layout
\end_inset
[
\begin_inset Flex Code
-status open
+status collapsed
\begin_layout Plain Layout
-0
+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
-
-\emph on
-1
+OptionalArgs
\end_layout
\end_inset
-] Tells us whether this float is defined using the facilities provided by
-
+ tag above for more information.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+Requires
\end_layout
\end_inset
-, 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
-
-\emph on
-type
+string
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+] Whether the style requires the feature
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+string
\end_layout
\end_inset
.
+ See the description of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Provides
\end_layout
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Flex-insets-and"
+\end_inset
+ above (sec.
+\begin_inset space ~
\end_inset
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:General-text-class"
-\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
+\end_inset
-\begin_layout Standard
-Flex insets come in three different kinds:
+) for information on `features'.
\end_layout
-\begin_layout Itemize
-character style (
+\begin_layout Description
+
+\change_inserted -712698321 1353693371
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+
+\change_inserted -712698321 1353693146
+ResetArgs
+\change_unchanged
+
\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 1353693235
+
+\emph on
+0
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-code
+\change_inserted -712698321 1353693235
+1
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Itemize
-user custom (
+] Resets the LaTeX arguments of this style (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Custom
+
+\change_inserted -712698321 1353693371
+Argument
+\change_unchanged
+
\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
+ tag).
+ This is useful if you have copied a style via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-endnote
+
+\change_inserted -712698321 1353693302
+CopyStyle
+\change_unchanged
+
\end_layout
\end_inset
- module.
+, but you do not want to inherit its (required and optional) arguments.
+\change_unchanged
+
\end_layout
-\begin_layout Itemize
-XML elements (
+\begin_layout Description
+
+\change_inserted -712698321 1354263074
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Element
+
+\change_inserted -712698321 1353866876
+RightDelim
\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
-InsetLayout
+
+\change_inserted -712698321 1353866873
+string
\end_layout
\end_inset
- tag, which shall be explained in a moment.
-\end_layout
-
-\begin_layout Standard
-The
+] 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
-InsetLayout
+
+\change_inserted -712698321 1354263069
+<br/>
+\change_unchanged
+
\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,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+RightMargin
\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
+string=""
\end_layout
\end_inset
- definition must begin with a line of the form:
-\end_layout
-
-\begin_layout LyX-Code
-InsetLayout <Type>
-\end_layout
-
-\begin_layout Standard
-Here
+] Similar to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+LeftMargin
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are two
- cases.
+.
\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>
+Spacing
\end_layout
\end_inset
- any one of the following:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+
+\emph on
+single
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Branch
+onehalf
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Box
+double
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Box:shaded
+other
+\begin_inset space ~
+\end_inset
+
+<value>
\end_layout
\end_inset
-,
+] This defines what the default spacing should be in the style.
+ The arguments
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ERT
+single
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Figure
+onehalf
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Foot
+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
-Index
+other
\end_layout
\end_inset
-,
+, then you must also provide a value argument which will be the actual multiplie
+r value.
+ Note that, contrary to other parameters,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info
+Spacing
\end_layout
\end_inset
-,
+ implies the generation of specific LaTeX code, using the LaTeX package
+
+\family roman
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:menu
+setspace
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+Spellcheck
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Listings
+
+\emph on
+1
\end_layout
\end_inset
-,
+] Allow spell-checking paragraphs of this style.
+ Default is true.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Marginal
+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
-Note:Comment
+TocLevel
\end_layout
\end_inset
-,
+
+\series medium
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+
+\series medium
+int=3
\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
-Note:Greyedout
+TopSep
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OptArg
+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
-Table
+Style
\end_layout
\end_inset
-, or
+ defines text that is to appear in the typeset document, it may use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+LangPreamble
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+BabelPreamble
\end_layout
\end_inset
- must be of the form
-\begin_inset Quotes eld
-\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
-Flex:<name>
+theorems-ams.inc
\end_layout
\end_inset
+ file) shows how this works:
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+Preamble
+\end_layout
-, where
-\begin_inset Flex Code
-status collapsed
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
+\end_layout
-\begin_layout Plain Layout
-name
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
- 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 LyX-Code
+LangPreamble
+\end_layout
-\begin_layout Plain Layout
-LyXType
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
- entry, declaring which type of inset it defines.
+\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
-The
+In principle, any legal LaTeX may appear in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+LangPreamble
\end_layout
\end_inset
- definition can contain the following entries:
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BgColor
+BabelPreamble
\end_layout
\end_inset
- The color for the inset's background.
- The valid colors are defined in
+ 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
-src/ColorCode.h
+
+\backslash
+claimname
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ and its use in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ContentAsLabel
+
+\backslash
+newtheorem
\end_layout
\end_inset
- [
+.
+
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+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
-1
+Preamble
\end_layout
\end_inset
-] Whether to use the content of the inset as the label, when the inset is
- closed.
- Default is false.
-\end_layout
+ tag.
+ What makes it special is the use of the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
+function
+\begin_inset Quotes erd
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+_()
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
-
-\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 Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+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
-
-\emph on
-0
+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
-1
+_()
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
-\end_layout
-
-\begin_layout Description
+ will be replaced with its translation into the language in question; the
+ expression
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+$$lang
\end_layout
\end_inset
- can be
-\begin_inset Flex Code
-status collapsed
+ is replaced by the language name (as used by the babel package).
+\end_layout
-\begin_layout Plain Layout
-Classic
+\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}}
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+addto
+\backslash
+captionsngerman{
+\backslash
+renewcommand{
+\backslash
+claimname}{Behauptung}}
+\begin_inset Newline newline
\end_inset
-,
+
+\backslash
+providecommand{
+\backslash
+claimname}{Behauptung}
+\end_layout
+
+\begin_layout Standard
+LaTeX and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+babel
\end_layout
\end_inset
-, or
+ 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
-Conglomerate
+
+\change_inserted -195340706 1334775793
+layouttranslations
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+
+\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
-Classic
+LangPreamble
\end_layout
\end_inset
-, ERT insets generally
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+BabelPreamble
\end_layout
\end_inset
-, and character styles
+ 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
-Conglomerate
+
+\change_inserted -195340706 1334775793
+layouttranslations
\end_layout
\end_inset
+ file is modified accordingly
+\change_unchanged
.
-\end_layout
+ That said, however, any layout created with the intention that it will
+ be included with LyX should use these tags where appropriate.
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\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
-\begin_layout Plain Layout
-Display
\end_layout
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Floats"
+
\end_inset
- [
-\begin_inset Flex Code
+
+\end_layout
+
+\begin_layout Standard
+It is necessary to define the floats (
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-0
+figure
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+,
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+table
\end_layout
\end_inset
-] Only useful if
+, \SpecialChar \ldots{}
+) in the text class itself.
+ Standard floats are included in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+stdfloats.inc
\end_layout
\end_inset
- is
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdfloats.inc
+\end_layout
+
+\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:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Extension
\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
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}
+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
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+GuiName
\end_layout
\end_inset
- tags.
- Default is true.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+string
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
+=
+\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
status collapsed
\begin_layout Plain Layout
-Font
+HTML*
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
+ These tags control the XHTML output.
See section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Font-description"
+reference "sec:Tags-for-XHTML"
\end_inset
.
- Note that defining this font automatically defines the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelFont
\end_layout
-\end_inset
-
- to the same value, so define this first and define
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+IsPredefined
\end_layout
\end_inset
- later if you want them to be different.
-\end_layout
+ [
+\emph on
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+0
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
-\end_inset
-
-latex
-\begin_inset Quotes erd
-\end_inset
- language, leading to Left-to-Right (latin) output, e.
+\emph default
+,
\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space \space{}
-\end_inset
-in TeX code or URL.
- A kludge.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
\end_layout
-\begin_layout Description
+\end_inset
+
+] Indicates whether the float is already defined in the document class or
+ if instead the LaTeX package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+float
\end_layout
\end_inset
- [
+ needs to be loaded to define it on-the-fly.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
0
\end_layout
\end_inset
-,
+, which means:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+float
\end_layout
\end_inset
-] Indicates whether the
+ is used.
+ It should be set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PlainLayout
+1
\end_layout
\end_inset
- should be used or, instead, the user can change the paragraph style used
- in the inset.
- Default is false.
+ if the float is already defined by the LaTeX document class.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+ListCommand
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
-
-\end_inset
-
-).
- Default is false.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+string
\end_layout
\end_inset
- These tags control XHTML output.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-
+=
+\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' must be omitted.
+ This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InToc
+UsesFloatPkg
\end_layout
\end_inset
- [
+ 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
-
-\emph on
-0
+UsesFloatPkg
\end_layout
\end_inset
-,
+ is true, since in that case there is a standard way to define the command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+ListName
\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
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+string
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
+=
+\begin_inset Quotes erd
+\end_inset
+
+\begin_inset Quotes erd
\end_inset
-).
- Default is false.
+] 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 used by LaTeX for the
+ title and it is used as the title in the XHTML output.
+ It will be translated to the document language.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelFont
+NumberWithin
\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
+string
+\end_layout
\end_inset
-.
- Note that this definition can never appear before
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+NumberWithin
\end_layout
\end_inset
-, lest it be ineffective.
-\end_layout
+ is set to
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+chapter
\end_layout
\end_inset
- What will be displayed on the button or elsewhere as the inset label.
- Some inset types (
+
+\begin_inset Quotes erd
+\end_inset
+
+, the floats will be numbered within chapters.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TeX code
+Placement
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+string
\end_layout
\end_inset
-) modify this label on the fly.
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
+
+\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
-LatexName
+t
\end_layout
\end_inset
- 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
-LatexParam
+b
\end_layout
\end_inset
- The optional parameter for the corresponding
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+p
\end_layout
\end_inset
- stuff, including possible bracket pairs like
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+h
\end_layout
\end_inset
-.
- This parameter cannot be changed from within LyX.
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that the order of these letters in the string is irrelevant, like in
+ LaTeX.
\end_layout
-\begin_layout Description
+\end_inset
+
+ On top of that there is a new type,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+H
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
-
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
\end_inset
-).
-\end_layout
+here
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
+ and nowhere else.
+ Note however that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyxType
+H
\end_layout
\end_inset
- Can be
+ 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
-charstyle
+tbp
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-custom
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-element
+RefPrefix
\end_layout
\end_inset
-, or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-end
+string
\end_layout
\end_inset
- (indicating a dummy definition ending definitions of charstyles, etc).
- This entry is required in and is only meaningful for Flex insets.
- Among other things, it determines on which menu this inset will appear.
- Setting
+] 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
-LyXType
+RefPrefix
\end_layout
\end_inset
- to
+ 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
-charstyle
+Style
\end_layout
\end_inset
- will set
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+string
\end_layout
\end_inset
- to false.
-
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-MultiPar
-\end_layout
+\begin_inset Quotes erd
\end_inset
- can be set to true for charstyle insets, if you wish, by setting it
-\emph on
-after
-\emph default
- you set the
+] The style used when defining the float using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+
+\backslash
+newfloat
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-MultiPar
+Type
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-1
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set
+] 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
-CustomPars
+
+\backslash
+newfloat
\end_layout
\end_inset
- to the same value and
+, commands such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+
+\backslash
+begin{program}
\end_layout
\end_inset
- to the opposite value.
- These can be reset to other values, if they are used
-\emph on
-after
-\emph default
-
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\backslash
+end{algorithm*}
\end_layout
\end_inset
-.
- Default is true.
+ will be available.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NeedProtect
+UsesFloatPkg
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
0
\end_layout
\end_inset
,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] Whether fragile commands in this inset should be
+] Specifies whether this float is defined using the LaTeX package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+float
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether the command should itself be protected.) Default is false.
+, either by the class file, another package or on-the-fly by LyX itself.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+
+\emph on
+type
\end_layout
\end_inset
- [
+ automatically defines the corresponding counter with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-0
+type
\end_layout
\end_inset
-,
-\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
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:ParbreakIsNewline"
-\end_inset
+\end_layout
-).
- Default is false.
+\begin_layout Standard
+Flex insets come in three different kinds:
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+character style (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+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
-\emph on
-0
+\backslash
+noun
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
-\end_layout
-
-\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:PassThru"
+\backslash
+code
+\end_layout
\end_inset
-).
- Default is false.
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+user custom (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+Custom
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Preamble"
+): 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
+endnote
+\end_layout
\end_inset
-).
+ module.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+XML elements (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+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
-] The prefix to use when creating labels referring to insets of this type.
- This allows the use of formatted references.
+ 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
-Requires
+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
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Requires"
-
-\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
+\change_deleted -712698321 1356964515
+optional argument
+\change_inserted -712698321 1356964516
+caption
+\change_unchanged
+s, as well as to define Flex insets.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ResetsFont
+InsetLayout
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
+ definition must begin with a line of the form:
\end_layout
-\end_inset
+\begin_layout LyX-Code
+InsetLayout <type>
+\end_layout
-,
+\begin_layout Standard
+Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+<Type>
\end_layout
\end_inset
-] Whether this inset should use the font of its surrounding environment
- or uses its own.
- Default is true: uses its own.
+ indicates the inset whose layout is being defined, and here there are
+\change_deleted -712698321 1356964888
+three
+\change_inserted -712698321 1356964888
+four
+\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
-Spellcheck
+<Type>
\end_layout
\end_inset
- [
+ any one of the following:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Algorithm
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
-\end_layout
-
-\end_inset
-
-] Spellcheck the contents of this inset.
- Default is true.
+Branch
\end_layout
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Counters"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is both possible and necessary to define the
- counters (
-\begin_inset Flex MenuItem
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+Box
\end_layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+Box:shaded
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- The standard counters are defined in the file
+,
+\change_inserted -712698321 1356964563
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
-\end_layout
-\end_inset
-
-, so you may have to do no more than add
-\end_layout
+\change_inserted -712698321 1356964560
+Caption:Standard
+\change_unchanged
-\begin_layout LyX-Code
-Input stdcounters.inc
\end_layout
-\begin_layout Standard
-to your layout file to get them to work.
- But if you want to define custom counters, then you can do so.
- The counter declaration must begin with:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Counter CounterName
-\end_layout
+,
+\change_unchanged
-\begin_layout Standard
-where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+ERT
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+Figure
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- The following parameters can also be used:
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Foot
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Index
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Info
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+Info:menu
\end_layout
\end_inset
- will be replaced by the expansion of the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Info:shortcut
\end_layout
\end_inset
- (or
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Info:shortcuts
\end_layout
\end_inset
-) of the counter
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-counter
+Listings
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+Marginal
\end_layout
\end_inset
-, where
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+Note:Comment
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\size default
-\emph on
-\noun default
-\color inherit
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+Note:Note
\end_layout
\end_inset
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+Note:Greyedout
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
+,
+\change_deleted -712698321 1356964592
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+
+\change_deleted -712698321 1353866704
+Opt
+\change_unchanged
+Arg
+\change_inserted -712698321 1353866707
+ument
+\change_unchanged
+
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-;
+,
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+Table
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+URL
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
+.
+\end_layout
+
+\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
-Roman
+<Type>
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-;
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+Flex:<name>
\end_layout
\end_inset
- for hebrew numerals.
-\end_layout
-\end_deeper
-\begin_layout Standard
-If LabelString is not defined, a default value is constructed as follows:
- if the counter has a master counter
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+name
\end_layout
\end_inset
- (defined via
+ 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
-Within
+LyXType
\end_layout
\end_inset
-), the string
+ entry, declaring which type of inset it defines.
+\change_inserted 5863208 1334489312
+
+\end_layout
+
+\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
-\backslash
-themaster.
-\backslash
-arabic{counter}
+\change_inserted 5863208 1334489384
+<Type>
\end_layout
\end_inset
- is used; otherwise the string
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-arabic{counter}
+\change_inserted 5863208 1334489392
+Branch:<name>
\end_layout
\end_inset
- is used.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+
+\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_inserted -712698321 1356964893
+
+\end_layout
+
+\begin_layout Enumerate
+
+\change_inserted -712698321 1356965125
+The layout of a user (or class) specific caption is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -712698321 1356964939
+<Type>
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ must be of the form
+\begin_inset Quotes eld
\end_inset
-\begin_inset Quotes erd
-\end_inset
-
-] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\change_inserted -712698321 1356964943
+Caption:<name>
\end_layout
\end_inset
-, but for use in the Appendix.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PrettyFormat
+
+\change_inserted -712698321 1356964939
+name
\end_layout
\end_inset
- [
+ specifies the name of the caption as it appears in the menu.
+ Have a look at the standard caption (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\change_inserted -712698321 1356964987
+Caption:Standard
+\end_layout
-=
-\begin_inset Quotes erd
\end_inset
+), the specific captions of the KOMA-Script classes (
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-] A format for use with formatted references to this counter.
- For example, one might want to have references to section numbers appear
- as
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -712698321 1356965018
+Caption:Above
+\end_layout
-Section 2.4
-\begin_inset Quotes erd
\end_inset
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-##
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+\change_inserted -712698321 1356965021
+Caption:Below
\end_layout
-\begin_layout Description
+\end_inset
+
+) or the
+\emph on
+biling
+\emph default
+ module (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+
+\change_inserted -712698321 1356965045
+Caption:Bicaption
\end_layout
\end_inset
- [
+) for applications.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+InsetLayout
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+ definition can contain the following entries:
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
-] If this is set to the name of another counter, the present counter will
- be reset every time the other one is increased.
- For example,
+\change_inserted -712698321 1353681390
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+
+\change_inserted -712698321 1353681344
+Argument
\end_layout
\end_inset
- is numbered inside
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
+
+\change_inserted -712698321 1353681344
+int
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Font-description"
-
-\end_inset
+] 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
+\change_inserted -712698321 1353681344
+EndArgument
\end_layout
-\begin_layout Standard
-A font description looks like this:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
-\end_layout
+.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout LyX-Code
- ...
-\end_layout
-\begin_layout LyX-Code
-EndFont
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
-\begin_layout Standard
-The following commands are available:
+\end_inset
+
+ for details.
\end_layout
\begin_layout Description
+
+\change_inserted -195340706 1333913893
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+BabelPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+ Preamble for changing languages.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-\emph on
-none
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+BgColor
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+<name>
\end_layout
\end_inset
-,
+] The color for the inset's background.
+ See chapter
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Names-of-colors"
+
+\end_inset
+
+ for a list of the available color names.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+ContentAsLabel
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-blue
+1
\end_layout
\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+CopyStyle
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+<type>
\end_layout
\end_inset
-,
+] As with paragraph styles, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\end_inset
+
+.
+ Note that you need to specify the complete type, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space ~
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
+CopyStyle Flex:<name>
\end_layout
\end_inset
-]
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Family
+CustomPars
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-Roman
+0
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Sans
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+1
\end_layout
\end_inset
-]
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Misc
+Decoration
\end_layout
\end_inset
- [
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Classic
\end_layout
\end_inset
-] Valid arguments are:
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+Minimalistic
\end_layout
\end_inset
-,
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-noun
+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
-underbar
+Classic
\end_layout
\end_inset
-,
+, ERT insets generally
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+Minimalistic
\end_layout
\end_inset
-,
+, and character styles
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_noun
+Conglomerate
\end_layout
\end_inset
- and
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_bar
+Display
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
- For example,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+0
\end_layout
\end_inset
- turns on emphasis, and
+,
+\emph on
+
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\emph default
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
-\end_layout
-\end_inset
+\emph on
+1
+\end_layout
- turns it off.
-
-\begin_inset Newline newline
\end_inset
-If the latter seems puzzling, remember that the font settings for the present
- context are generally inherited from the surrounding context.
- So
+] Only useful if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+LatexType
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+Environment
\end_layout
\end_inset
- [
+.
+ Indicates whether the environment will stand on its own in the 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
+\backslash
+begin{
\emph on
-Medium
+LatexName
+\emph default
+}
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bold
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-]
+ tags.
+ Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Shape
+End
\end_layout
\end_inset
- [
+ Required at the end of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
-\end_layout
+InsetLayout
+\end_layout
\end_inset
-,
+ declarations.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Italic
+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
-SmallCaps
+LabelFont
\end_layout
\end_inset
-,
+ to the same value, so define this first and define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Slanted
+LabelFont
\end_layout
\end_inset
-]
+ later if you want them to be different.
+\change_inserted 155139281 1354130923
+
\end_layout
\begin_layout Description
+
+\change_inserted 155139281 1354130923
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Size
+
+\change_inserted 155139281 1354130923
+ForceLocalFontSwitch
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-tiny
+
+\change_inserted 155139281 1354130923
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-small
+
+\change_inserted 155139281 1354130923
+1
\end_layout
\end_inset
-,
+] When using babel, always use a local font switch (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-normal
+\change_inserted 155139281 1354130923
+
+\backslash
+foreignlanguage
\end_layout
\end_inset
-,
+), never a global one (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+
+\change_inserted 155139281 1354130923
+
+\backslash
+selectlanguage
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+).
+\change_unchanged
-\begin_layout Plain Layout
-larger
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+ForceLTR
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-huge
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
+1
\end_layout
\end_inset
-]
-\end_layout
+] Force the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Citation-format-description"
+latex
+\begin_inset Quotes erd
+\end_inset
+ language, leading to Left-to-Right (Latin) output, e.
+\begin_inset space \thinspace{}
\end_inset
-Citation format description
+g.
+\begin_inset space \space{}
+\end_inset
+
+in TeX code or URL.
+ A kludge.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+ForcePlain
\end_layout
\end_inset
- blocks are used to describe how bibliographic information should be displayed,
- both within LyX itself (in the citation dialog and in tooltips, for example)
- and in XHTML output.
- Such a block might look like this:
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-CiteFormat
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
- article ...
+\emph on
+0
\end_layout
-\begin_layout LyX-Code
- book ...
-\end_layout
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-End
-\end_layout
-\begin_layout Standard
-The individual lines define how the bibliographic information associated
- with an article or book, respectively, is to be displayed, and such a definitio
-n can be given for any `entry type' that might be present in a BibTeX file.
- LyX defines a default format in the source code that will be used if no
- specific definition has been given.
- LyX predefines several formats in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+1
\end_layout
\end_inset
-, which is included in most of LyX's document classes.
-\end_layout
-
-\begin_layout Standard
-The definitions use a simple language that allows BibTeX keys to be replaced
- with their values.
- Keys should be enclosed in
+] Indicates whether the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+PlainLayout
\end_layout
\end_inset
- signs, e.g.:
+ should be used or, instead, the user can change the paragraph style used
+ in the inset.
+ Default is false.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
+FreeSpacing
\end_layout
\end_inset
-.
- So a simple definition might look like this:
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
-\begin_layout LyX-Code
-misc %author%,
-\begin_inset Quotes eld
\end_inset
-%title
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\end_inset
-.
-\end_layout
-
-\begin_layout Standard
-This would print the author, followed by a comma, followed by the title,
- in quotes, followed by a period.
-\end_layout
-\begin_layout Standard
-Of course, sometimes you may want to print a key only if it exists.
- This can be done by using a conditional construction, such as:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%volume%[[vol.
+1
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see sec.
\begin_inset space ~
\end_inset
-%volume%]]}
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
\end_inset
.
- This says: If the
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+HTML*
\end_layout
\end_inset
- key exists, then print
-\begin_inset Quotes eld
-\end_inset
-
-vol.
+ These tags control the XHTML output.
+ See section
\begin_inset space ~
\end_inset
-\begin_inset Quotes erd
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+
\end_inset
- followed by the volume key.
- It is also possible to have an else clause in the conditional, such as:
-
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%author%[[%author%]][[%editor%, ed.]]}
+InToc
\end_layout
\end_inset
-.
- Here, the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
-\end_layout
-\end_inset
+\emph on
+0
+\end_layout
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
-\begin_inset Quotes eld
\end_inset
,
-\begin_inset space ~
+\begin_inset space \thinspace{}
\end_inset
-ed.
-\begin_inset Quotes erd
-\end_inset
- Note that the key is again enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+1
\end_layout
\end_inset
- signs; the entire conditional is enclosed in braces; and the if and else
- clauses are enclosed in double brackets,
-\begin_inset Quotes eld
-\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[[
+KeepEmpty
\end_layout
\end_inset
+ [
+\emph on
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
-\begin_inset Quotes eld
\end_inset
- and
-\begin_inset Quotes eld
+
+\emph default
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-]]
+1
\end_layout
\end_inset
+] As with paragraph styles, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
-\begin_inset Quotes erd
\end_inset
.
- There must be no space between any of these.
\end_layout
-\begin_layout Standard
-There is one other piece of syntax available in definitions, which looks
- like this:
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{!<i>!}
+LabelFont
\end_layout
\end_inset
-.
- This defines a piece of formatting information that is to be used when
- creating
-\begin_inset Quotes eld
+ The font used for the label.
+ See section
+\begin_inset space ~
\end_inset
-rich text
-\begin_inset Quotes erd
-\end_inset
-.
- Obviously, we do not want to output HTML tags when writing plain text,
- so they should be wrapped in
-\begin_inset Quotes eld
-\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
-{!
-\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+.
+ Note that this definition can never appear before
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
-!}
-\begin_inset Quotes erd
\end_inset
-.
+, lest it be ineffective.
\end_layout
-\begin_layout Standard
-Two special sorts of definitions are also possible in a
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+LabelString
\end_layout
\end_inset
- block.
- An example of the first would be:
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-!quotetitle
-\begin_inset Quotes eld
\end_inset
-%title%
+=
\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-This is an abbreviation, or macro, and it can be used by treating it as
- if it were a key:
+] 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
-%!quotetitle%
+TeX code
\end_layout
\end_inset
-.
- LyX will treat
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+Branch
\end_layout
\end_inset
- exactly as it would treat its definition.
- So, let us issue the obvious
-\emph on
-warning
-\emph default
-.
- Do not do this:
+) modify this label on the fly.
\end_layout
-\begin_layout LyX-Code
-!funfun %funfun%
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-or anything like it.
- LyX shouldn't go into an infinite loop, but it may go into a long one before
- it gives up.
-\end_layout
+\change_inserted -195340706 1333913893
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-The second sort of special definition might look like this:
+\begin_layout Plain Layout
+LangPreamble
\end_layout
-\begin_layout LyX-Code
-_pptext pp.
+\end_inset
+
+ Language dependent preamble.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-This defines a translatable piece of text, which allows relevant parts of
- the bibliography to be translated.
- It can be included in a definition by treating it as a key:
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%_pptext%
+LatexName
\end_layout
\end_inset
-.
- Several of these are predefined in
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+<name>
\end_layout
\end_inset
-.
- Note that these are not macros, in the sense just defined.
- They will not be expanded.
-\end_layout
-
-\begin_layout Standard
-So here then is an example that use all these features:
-\end_layout
-
-\begin_layout LyX-Code
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+] The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
-\begin_layout Standard
-This defines a macro that prints the author, followed by a comma, if the
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+LatexParam
\end_layout
\end_inset
- key is defined, or else prints the name of the editor, followed by the
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_edtext
+<parameter>
\end_layout
\end_inset
- or its translation (it is by default
-\begin_inset Quotes eld
-\end_inset
-
-ed.
-\begin_inset Quotes erd
-\end_inset
-
-), if the
+] The optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-editor
+LatexName
\end_layout
\end_inset
- key is defined.
- Note that this is in fact defined in
+ stuff, including possible bracket pairs like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+[]
\end_layout
\end_inset
-, so you can use it in your own definitions, or re-definitions, if you load
- that file first.
-\end_layout
-
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Tags-for-XHTML"
+.
+
+\change_inserted -712698321 1355144715
+This will be output as is after all LaTeX
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
-Tags for XHTML output
+\change_inserted -712698321 1355144713
+Arguments
\end_layout
-\begin_layout Standard
-As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
- by layout information.
- In general, LyX provides sensible defaults and, as mentioned earlier, it
- will even construct default CSS style rules from the other layout tags.
- For example, LyX will attempt to use the information provided in the
+\end_inset
+
+.
+
+\change_unchanged
+This parameter cannot be changed from within LyX
+\change_inserted -712698321 1355144775
+ (use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\change_inserted -712698321 1355144747
+Argument
\end_layout
\end_inset
- declaration for the Chapter style to write CSS that will appropriately
- format chapter headings.
-\end_layout
-
-\begin_layout Standard
-In many cases, then, you may not have to do anything at all to get acceptable
- XHTML output for your own environments, custom insets, and so forth.
- But in some cases you will, and so LyX provides a number of layout tags
- that can be used to customize the XHTML and CSS that are generated.
+ for customizable parameters)
+\change_unchanged
+.
\end_layout
-\begin_layout Standard
-Note that there are two tags,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+LatexType
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+
+\change_deleted -712698321 1353867544
+
+\emph on
+Paragraph
+\emph default
+,
+\change_unchanged
+Command, Environment,
+\change_inserted -712698321 1353867573
+None
+\change_deleted -712698321 1353867557
+Item_Environment,
+\change_unchanged
+
\end_layout
\end_inset
- that may appear outside style and inset declarations.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:General-text-class"
+
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
- for details on these.
-\end_layout
+\change_deleted -712698321 1353867564
+List_Environment
+\change_unchanged
+,
+\change_deleted -712698321 1353867569
+Bib_Environment
+\change_unchanged
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Paragraph-Style-XHTML"
+\end_layout
\end_inset
-Paragraph styles
-\end_layout
+] How the style should be translated into LaTeX.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
-The sort of XHTML LyX outputs for a paragraph depends upon whether we are
- dealing with a normal paragraph, a command, or an environment, where this
- is itself determined by the contents of the corresponding
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXType
-\end_layout
-
-\end_inset
-
- tag.
-
-\end_layout
-
-\begin_layout Standard
-For a command or normal paragraph, the output XHTML has the following form:
+LatexType
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\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
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
->Label</labeltag>
\end_layout
-\begin_layout LyX-Code
-Contents of the paragraph.
-\end_layout
+\begin_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-The label tags are of course omitted if the paragraph does not have a label.
-\end_layout
+\change_deleted -712698321 1353867582
+Paragraph
+\change_inserted -712698321 1353867583
+None
+\change_unchanged
-\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->
+ means nothing special.
+
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Command
+\end_layout
-><labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ means
+\begin_inset Flex Code
+status collapsed
->Environment Label</labeltag>First paragraph.</itemtag>
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-<itemtag>Second paragraph.</itemtag>
-\end_layout
+\backslash
-\begin_layout LyX-Code
-</tag>
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
-\begin_layout Standard
-Note that the label is output only for the first paragraph, as it should
- be for a theorem, for example.
-
-\end_layout
+\end_inset
-\begin_layout Standard
-For a list, we have one of these forms:
+.
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+Environment
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ means
+\begin_inset Flex Code
+status collapsed
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-value
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
->List Label</labeltag>First item.</itemtag>
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
-
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->List Label</labeltag>Second item.</itemtag>
+.
+
\end_layout
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\begin_layout Description
-\begin_layout LyX-Code
+\change_deleted -712698321 1353867600
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Item_Environment
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ is the same as
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+Environment
\end_layout
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+, except that an
+\begin_inset Flex Code
+status collapsed
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
->First item.</itemtag>
+\backslash
+item
\end_layout
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
-
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->Second item.</itemtag>
+ is generated for each paragraph of this environment.
+
\end_layout
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-Note the different orders of
+\change_deleted -712698321 1353867600
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-labeltag
+List_Environment
\end_layout
\end_inset
- and
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-itemtag
+Item_Environment
\end_layout
\end_inset
+, except that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelWidthString
+\end_layout
+
+\end_inset
+
+ is passed as an argument to the environment.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelWidthString
+\end_layout
+
+\end_inset
+
+ can be defined in the
+\begin_inset Flex MenuItem
+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
+\end_layout
+
+\end_inset
+
+ 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
+
+\change_deleted 2090807402 1356919073
+latexname
+\change_inserted 2090807402 1356919073
+LatexName
+\change_unchanged
+[
+\change_deleted 2090807402 1356919073
+latexparam
+\change_inserted 2090807402 1356919002
+LatexParam
+\change_unchanged
+]{\SpecialChar \ldots{}
+}
+\end_layout
+
+\begin_layout Standard
+or:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+begin{
+\change_deleted 2090807402 1356919013
+latexname
+\change_inserted 2090807402 1356919014
+LatexName
+\change_unchanged
+}[
+\change_deleted 2090807402 1356919013
+latexparam
+\change_inserted 2090807402 1356919008
+LatexParam
+\change_unchanged
+] \SpecialChar \ldots{}
+
+\backslash
+end{
+\change_deleted 2090807402 1356919016
+latexname
+\change_inserted 2090807402 1356919016
+LatexName
+\change_unchanged
+}.
+\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
+
+\change_inserted -712698321 1353866742
+LeftDelim
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1353866752
+string
+\end_layout
+
+\end_inset
+
+] 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
+
+\change_inserted -712698321 1354263128
+<br/>
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyxType
+\end_layout
+
+\end_inset
+
+ Can be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+custom
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+element
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+end
+\end_layout
+
+\end_inset
+
+ (indicating a dummy definition ending definitions of charstyles, etc).
+ This entry is required in and is only meaningful for Flex insets.
+ Among other things, it determines on which menu this inset will appear.
+ Setting
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
+\end_layout
+
+\end_inset
+
+ will automatically set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ to false.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ can be set to true for
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
+\end_layout
+
+\end_inset
+
+ insets by setting it
+\emph on
+after
+\emph default
+ you set the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether multiple paragraphs are permitted in this inset.
+ This will also set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CustomPars
+\end_layout
+
+\end_inset
+
+ to the same value and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForcePlain
+\end_layout
+
+\end_inset
+
+ to the opposite value.
+ These can be reset to other values, if they are used
+\emph on
+after
+\emph default
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NeedProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether fragile commands in this inset should be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+protect
+\end_layout
+
+\end_inset
+
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.) Default is false.
+\end_layout
+
+\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 space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\end_inset
+
+.
+ Default is false.
+\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 space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] As with paragraph styles, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\end_inset
+
+.
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
+
+\end_inset
+
+ As with paragraph styles, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\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 insets of this type.
+ This allows the use of formatted references.
+\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
+
+] As with paragraph styles, see sec.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\end_inset
+
+.
+\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
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ResetsFont
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether this inset should use the font of its surrounding environment
+ or uses its own.
+ Default is true: uses its own.
+\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
+\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 space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Allow spell-checking the contents of this inset.
+ Default is true.
+\end_layout
+
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Counters"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+chapter
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+figure
+\end_layout
+
+\end_inset
+
+, \SpecialChar \ldots{}
+) in the text class itself.
+ The standard counters are defined in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdcounters.inc
+\end_layout
+
+\end_inset
+
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
+
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
+
+\begin_layout Standard
+where of course `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CounterName
+\end_layout
+
+\end_inset
+
+' is replaced by the name of the counter.
+ And it must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The following parameters can also be used:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\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
+
+] When defined, this string defines how the counter is displayed.
+ Setting this value sets
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thecounter
+\end_layout
+
+\end_inset
+
+ will be replaced by the expansion of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ (or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+) of the counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+counter
+\end_layout
+
+\end_inset
+
+.
+
+\end_layout
+
+\begin_layout Itemize
+counter values can be expressed using LaTeX-like macros
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
+\end_layout
+
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+numbertype
+\end_layout
+
+\end_inset
+
+ can be:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Actually, the situation is a bit more complicated: any
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\size default
+\emph on
+\noun default
+\color inherit
+numbertype
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ other than those described below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+arabic
+\end_layout
+
+\end_inset
+
+: 1, 2, 3,\SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alph
+\end_layout
+
+\end_inset
+
+ for lower-case letters: a, b, c, \SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alph
+\end_layout
+
+\end_inset
+
+ for upper-case letters: A, B, C, \SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+roman
+\end_layout
+
+\end_inset
+
+ for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Roman
+\end_layout
+
+\end_inset
+
+ for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+hebrew
+\end_layout
+
+\end_inset
+
+ for hebrew numerals.
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+master
+\end_layout
+
+\end_inset
+
+ (defined via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Within
+\end_layout
+
+\end_inset
+
+), the string
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
+\end_layout
+
+\end_inset
+
+ is used; otherwise the string
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{counter}
+\end_layout
+
+\end_inset
+
+ is used.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\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
+
+] Same as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+, but for use in the Appendix.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PrettyFormat
+\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
+
+] A format for use with formatted references to this counter.
+ For example, one might want to have references to section numbers appear
+ as
+\begin_inset Quotes eld
+\end_inset
+
+Section 2.4
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The string should contain
+\begin_inset Quotes eld
+\end_inset
+
+##
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This will be replaced by the counter number itself.
+ So, for sections, it would be: Section ##.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Within
+\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
+
+] If this is set to the name of another counter, the present counter will
+ be reset every time the other one is increased.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+subsection
+\end_layout
+
+\end_inset
+
+ is numbered inside
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+section
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Font-description"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A font description looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
+\emph on
+ or
+\emph default
+ DefaultFont
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+EndFont
+\end_layout
+
+\begin_layout Standard
+The following commands are available:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Color
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+none
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+black
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+white
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+red
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+green
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+blue
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cyan
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+magenta
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+yellow
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Roman
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Sans
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Typewriter
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Misc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Valid arguments are:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+emph
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+noun
+\end_layout
+
+\end_inset
+
+,
+\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
+
+\end_inset
+
+,
+\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
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_noun
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_strikeout
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_bar
+\end_layout
+
+\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,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+emph
+\end_layout
+
+\end_inset
+
+ turns on emphasis, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+ turns it off.
+
+\begin_inset Newline newline
+\end_inset
+
+If the latter seems puzzling, remember that the font settings for the present
+ context are generally inherited from the surrounding context.
+ So
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Series
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Medium
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Bold
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Shape
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Up
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Italic
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+SmallCaps
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Slanted
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Size
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tiny
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+small
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+normal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+large
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+larger
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+largest
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+huge
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+giant
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Citation-format-description"
+
+\end_inset
+
+Citation format description
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks are used to describe how bibliographic information should be displayed,
+ both within LyX itself (in the citation dialog and in tooltips, for example)
+ and in XHTML output.
+ Such a block might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\begin_layout LyX-Code
+ article ...
+\end_layout
+
+\begin_layout LyX-Code
+ book ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+The individual lines define how the bibliographic information associated
+ with an article or book, respectively, is to be displayed, and such a definitio
+n can be given for any `entry type' that might be present in a BibTeX file.
+ LyX defines a default format in the source code that will be used if no
+ specific definition has been given.
+ LyX predefines several formats in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, which is included in most of LyX's document classes.
+\end_layout
+
+\begin_layout Standard
+The definitions use a simple language that allows BibTeX keys to be replaced
+ with their values.
+ Keys should be enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs, e.g.:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+.
+ So a simple definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+misc %author%,
+\begin_inset Quotes eld
+\end_inset
+
+%title
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+This would print the author, followed by a comma, followed by the title,
+ in quotes, followed by a period.
+\end_layout
+
+\begin_layout Standard
+Of course, sometimes you may want to print a key only if it exists.
+ This can be done by using a conditional construction, such as:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%volume%[[vol.
+\begin_inset space ~
+\end_inset
+
+%volume%]]}
+\end_layout
+
+\end_inset
+
+.
+ This says: If the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+volume
+\end_layout
+
+\end_inset
+
+ key exists, then print
+\begin_inset Quotes eld
+\end_inset
+
+vol.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ followed by the volume key.
+ It is also possible to have an else clause in the conditional, such as:
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%author%[[%author%]][[%editor%, ed.]]}
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+Here, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
+\begin_inset Quotes eld
+\end_inset
+
+,
+\begin_inset space ~
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+ Note that the key is again enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs; the entire conditional is enclosed in braces; and the if and else
+ clauses are enclosed in double brackets,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[[
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+]]
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ There must be no space between any of these.
+\end_layout
+
+\begin_layout Standard
+There is one other piece of syntax available in definitions, which looks
+ like this:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{!<i>!}
+\end_layout
+
+\end_inset
+
+.
+ This defines a piece of formatting information that is to be used when
+ creating
+\begin_inset Quotes eld
+\end_inset
+
+rich text
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Obviously, we do not want to output HTML tags when writing plain text,
+ so they should be wrapped in
+\begin_inset Quotes eld
+\end_inset
+
+{!
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+!}
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Two special sorts of definitions are also possible in a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ block.
+ An example of the first would be:
+\end_layout
+
+\begin_layout LyX-Code
+!quotetitle
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+This is an abbreviation, or macro, and it can be used by treating it as
+ if it were a key:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+
+.
+ LyX will treat
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+
+ exactly as it would treat its definition.
+ So, let us issue the obvious
+\emph on
+warning
+\emph default
+.
+ Do not do this:
+\end_layout
+
+\begin_layout LyX-Code
+!funfun %funfun%
+\end_layout
+
+\begin_layout Standard
+or anything like it.
+ LyX shouldn't go into an infinite loop, but it may go into a long one before
+ it gives up.
+\end_layout
+
+\begin_layout Standard
+The second sort of special definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+_pptext pp.
+\end_layout
+
+\begin_layout Standard
+This defines a translatable piece of text, which allows relevant parts of
+ the bibliography to be translated.
+ It can be included in a definition by treating it as a key:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%_pptext%
+\end_layout
+
+\end_inset
+
+.
+ Several of these are predefined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+.
+ Note that these are not macros, in the sense just defined.
+ They will not be expanded.
+\end_layout
+
+\begin_layout Standard
+So here then is an example that use all these features:
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
+
+\family typewriter
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+This defines a macro that prints the author, followed by a comma, if the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is defined, or else prints the name of the editor, followed by the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+_edtext
+\end_layout
+
+\end_inset
+
+ or its translation (it is by default
+\begin_inset Quotes eld
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+), if the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+editor
+\end_layout
+
+\end_inset
+
+ key is defined.
+ Note that this is in fact defined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, so you can use it in your own definitions, or re-definitions, if you load
+ that file first.
+\end_layout
+
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-XHTML"
+
+\end_inset
+
+Tags for XHTML output
+\end_layout
+
+\begin_layout Standard
+As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
+ by layout information.
+ In general, LyX provides sensible defaults and, as mentioned earlier, it
+ will even construct default CSS style rules from the other layout tags.
+ For example, LyX will attempt to use the information provided in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ declaration for the Chapter style to write CSS that will appropriately
+ format chapter headings.
+\end_layout
+
+\begin_layout Standard
+In many cases, then, you may not have to do anything at all to get acceptable
+ XHTML output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so LyX provides a number of layout tags
+ that can be used to customize the XHTML and CSS that are generated.
+\end_layout
+
+\begin_layout Standard
+Note that there are two tags,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\end_layout
+
+\end_inset
+
+ that may appear outside style and inset declarations.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:General-text-class"
+
+\end_inset
+
+ for details on these.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Paragraph-Style-XHTML"
+
+\end_inset
+
+Paragraph styles
+\end_layout
+
+\begin_layout Standard
+The sort of XHTML LyX outputs for a paragraph depends upon whether we are
+ dealing with a normal paragraph, a command, or an environment, where this
+ is itself determined by the contents of the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LaTeXType
+\end_layout
+
+\end_inset
+
+ tag.
+
+\end_layout
+
+\begin_layout Standard
+For a command or normal paragraph, the output XHTML has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the paragraph.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The label tags are of course omitted if the paragraph does not have a label.
+\end_layout
+
+\begin_layout Standard
+For an environment that is not some sort of list, the XHTML takes this form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Environment Label</labeltag>First paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag>Second paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note that the label is output only for the first paragraph, as it should
+ be for a theorem, for example.
+
+\end_layout
+
+\begin_layout Standard
+For a list, we have one of these forms:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note the different orders of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+.
+ Which order we get depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ is false (the default), you get the first of these, with the label within
+ the item; if true, you get the second, with the label outside the item.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each paragraph type can be controlle
+d by means of the layout tags we are about to describe.
+ As mentioned earlier, however, LyX uses sensible defaults for many of these,
+ so you often may not need to do very much to get good XHTML output.
+ Think of the available tags as there so you can tweak things to your liking.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`mydiv'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+layoutname
+\end_layout
+
+\end_inset
+
+ is the LyX name of the layout, made lowercase, for example: chapter.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLForceCSS
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Whether to output the default CSS information LyX generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+.
+ Setting this to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLItem
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for individual paragraphs of environments, replacing
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLItemAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the item tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname_item'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for paragraph and item labels, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+, unless
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
+\end_layout
+
+\end_inset
+
+ is either
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Top_Environment
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Centered_Top_Environment
+\end_layout
+
+\end_inset
+
+, in which case it defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the label tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname_label'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Meaningful only for list-like environments, this tag controls whether
+ the label tag is output before or inside the item tag.
+ This is used, for example, in the description environment, where we want
+ `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<dt>\SpecialChar \ldots{}
+</dt><dd>\SpecialChar \ldots{}
+</dd>
+\end_layout
+
+\end_inset
+
+.
+ Default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+: The label tag is output inside the item tag.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<script>
+\end_layout
+
+\end_inset
+
+ block defining an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
+\end_layout
+
+\end_inset
+
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTitle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Marks this style as the one to be used to generate the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<title>
+\end_layout
+
+\end_inset
+
+ tag for the XHTML file.
+ By default, it is false.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdtitle.inc
+\end_layout
+
+\end_inset
+
+ file sets it to true for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+title
+\end_layout
+
+\end_inset
+
+ environment.
+
+\end_layout
+
+\begin_layout Subsection
+InsetLayout XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output of insets can also be controlled by information in layout
+ files.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+At present, this is true only for
+\begin_inset Quotes eld
+\end_inset
+
+text
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets you can type into) and is not true for
+\begin_inset Quotes eld
+\end_inset
+
+command
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets that are associated with dialog boxes).
+\end_layout
+
+\end_inset
+
+ Here, too, LyX tries to provide sensible defaults, and it constructs default
+ CSS style rules.
+ But everything can be customized.
+\end_layout
+
+\begin_layout Standard
+The XHTML LyX outputs for an inset has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+<innertag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Contents of the inset.</innertag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+If the inset permits multiple paragraphs---that is, if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true---then the contents of the inset will itself be output as paragraphs
+ formatted according to the styles used for those paragraphs (standard,
+ quote, and the like).
+ The label tag is of course omitted if the paragraph does not have a label
+ and, at present, is always
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+ The inner tag is optional and, by default, does not appear.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myinset' onclick=`\SpecialChar \ldots{}
+'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+insetname
+\end_layout
+
+\end_inset
+
+ is the LyX name of the inset, made lowercase and with non-alphanumeric
+ characters converted to underscores, for example: footnote.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLForceCSS
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Whether to output the default CSS information LyX generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+.
+ Setting this to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is 0.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLInnerAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the inner tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname_inner'
+\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
+HTMLInnerTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The inner tag, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+innertag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ By default, there is none.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLIsBlock
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0,
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether this inset represents a standalone block of text (such as a footnote)
+ or instead represents material that is included in the surrounding text
+ (such as a branch).
+ Defaults to 1.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] A label for this inset, possibly including a reference to a counter.
+ For example, for footnote, it might be:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{footnote}
+\end_layout
+
+\end_inset
+
+.
+ This is optional, and there is no default.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<script>
+\end_layout
+
+\end_inset
+
+ block defining an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
+\end_layout
+
+\end_inset
+
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ The default depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true, the default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+; if it is false, the default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Float XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output for floats too can be controlled by layout information.
+ The output has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the float.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The caption, if there is one, is a separate inset and will be output as
+ such.
+ Its appearance can be controlled via the InsetLayout for caption insets.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myfloat' onclick=`\SpecialChar \ldots{}
+'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`float float-floattype'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+floattype
+\end_layout
+
+\end_inset
+
+ is LyX's name for this type of float, as determined by the float declaration
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Floats"
+
+\end_inset
+
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this float is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for this float, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+ and will rarely need changing.
+\end_layout
+
+\begin_layout Subsection
+Bibliography formatting
+\end_layout
+
+\begin_layout Standard
+The bibliography can be formatted using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Citation-format-description"
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Subsection
+LyX-generated CSS
+\end_layout
+
+\begin_layout Standard
+We have several times mentioned that LyX will generate default CSS style
+ rules for both insets and paragraph styles, based upon the other layout
+ information that is provided.
+ In this section, we shall say a word about which layout information LyX
+ uses and how.
+\end_layout
+
+\begin_layout Standard
+At present, LyX auto-generates CSS only for font information, making use
+ of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Series
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Shape
+\end_layout
+
+\end_inset
+
+, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Size
+\end_layout
+
+\end_inset
+
+ specified in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ declaration.
+ (See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.) The translation is mostly straightforward and obvious.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family Sans
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ becomes
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+font-family: sans-serif;
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The correspondence of LyX sizes and CSS sizes is a little less obvious
+ but nonetheless intuitive.
+ See the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+getSizeCSS()
+\end_layout
+
+\end_inset
+
+ function in
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+src/FontInfo.cpp
+\end_layout
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Chapter
+Including External Material
+\end_layout
+
+\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
+
+\begin_layout Plain Layout
+WARNING: This portion of the documentation has not been updated for some
+ time.
+ We certainly hope that it is still accurate, but there are no guarantees.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The use of material from sources external to LyX is covered in detail in
+ the
+\emph on
+Embedded Objects
+\emph default
+ manual.
+ This part of the manual covers what needs to happen behind the scenes for
+ new sorts of material to be included.
+\end_layout
+
+\begin_layout Section
+How does it work?
+\end_layout
+
+\begin_layout Standard
+The external material feature is based on the concept of a
+\emph on
+template
+\emph default
.
- Which order we get depends upon the setting of
+ A template is a specification of how LyX should interface with a certain
+ kind of material.
+ As bundled, LyX comes with predefined templates for Xfig figures, various
+ raster format images, chess diagrams, and LilyPond music notation.
+ You can check the actual list by using the menu
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+External Material
+\end_layout
+
+\end_inset
+
+.
+ Furthermore, it is possible to roll your own template to support a specific
+ kind of material.
+ Later we'll describe in more detail what is involved, and hopefully you
+ will submit all the templates you create so we can include them in a later
+ LyX version.
+\end_layout
+
+\begin_layout Standard
+Another basic idea of the external material feature is to distinguish between
+ the original file that serves as a base for final material and the produced
+ file that is included in your exported or printed document.
+ For example, consider the case of a figure produced with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+Xfig
\end_layout
\end_inset
-: If
+.
+ The Xfig application itself works on an original file with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+.fig
+\end_layout
+
+\end_inset
+
+ extension.
+ Within Xfig, you create and change your figure, and when you are done,
+ you save the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+fig
+\end_layout
+
+\end_inset
+
+-file.
+ When you want to include the figure in your document, you invoke
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+transfig
+\end_layout
+
+\end_inset
+
+ in order to create a PostScript file that can readily be included in your
+ LaTeX file.
+ In this case, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.fig
+\end_layout
+
+\end_inset
+
+ file is the original file, and the PostScript file is the produced file.
+\end_layout
+
+\begin_layout Standard
+This distinction is important in order to allow updating of the material
+ while you are in the process of writing the document.
+ Furthermore, it provides us with the flexibility that is needed to support
+ 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 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
+zed on the different export formats that LyX supports.
+\end_layout
+
+\begin_layout Standard
+Besides supporting the production of different products according to the
+ exported format, it supports tight integration with editing and viewing
+ applications.
+ In the case of an Xfig figure, you are able to invoke Xfig on the original
+ file with a single click from within the external material dialog in LyX,
+ and also preview the produced PostScript file with Ghostview with another
+ click.
+ No more fiddling around with the command line and/or file browsers to locate
+ and manipulate the original or produced files.
+ In this way, you are finally able to take full advantage of the many different
+ applications that are relevant to use when you write your documents, and
+ ultimately be more productive.
+\end_layout
+
+\begin_layout Section
+The external template configuration file
+\end_layout
+
+\begin_layout Standard
+It is relatively easy to add custom external template definitions to LyX.
+ However, be aware that doing this in an careless manner most probably
+\emph on
+will
+\emph default
+ introduce an easily exploitable security hole.
+ So before you do this, please read the discussion about security in section
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Security-discussion"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Having said that, we encourage you to submit any interesting templates that
+ you create.
+
+\end_layout
+
+\begin_layout Standard
+The external templates are defined in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir/lib/external_templates
+\end_layout
+
+\end_inset
+
+ file.
+ You can place your own version in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir/external_templates
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+A typical template looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Template XFig
+\end_layout
+
+\begin_layout LyX-Code
+GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+\end_layout
+
+\begin_layout LyX-Code
+HelpText
+\end_layout
+
+\begin_layout LyX-Code
+An XFig figure.
+\end_layout
+
+\begin_layout LyX-Code
+HelpTextEnd
+\end_layout
+
+\begin_layout LyX-Code
+InputFormat fig
+\end_layout
+
+\begin_layout LyX-Code
+FileFilter "*.fig"
+\end_layout
+
+\begin_layout LyX-Code
+AutomaticProduction true
+\end_layout
+
+\begin_layout LyX-Code
+Transform Rotate
+\end_layout
+
+\begin_layout LyX-Code
+Transform Resize
+\end_layout
+
+\begin_layout LyX-Code
+Format LaTeX
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pstex_t}
+\end_layout
+
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat pstex
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pstex_t"
+\end_layout
+
+\begin_layout LyX-Code
+Requirement "graphicx"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+\end_layout
- is false (the default), you get the first of these, with the label within
- the item; if true, you get the second, with the label outside the item.
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.eps"
\end_layout
-\begin_layout Standard
-The specific tags and attributes output for each paragraph type can be controlle
-d by means of the layout tags we are about to describe.
- As mentioned earlier, however, LyX uses sensible defaults for many of these,
- so you often may not need to do very much to get good XHTML output.
- Think of the available tags as there so you can tweak things to your liking.
+\begin_layout LyX-Code
+ReferencedFile dvi "$$AbsPath$$Basename.eps"
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
-\begin_layout Plain Layout
-HTMLAttr
+\begin_layout LyX-Code
+Format PDFLaTeX
\end_layout
-\end_inset
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
- [
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
+\end_layout
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+UpdateFormat pdftex
+\end_layout
-\begin_layout Plain Layout
-class=`mydiv'
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pdftex_t"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.pdf"
+\end_layout
-.
- By default, LyX will output
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+\begin_layout LyX-Code
+Format Ascii
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+Product "$$Contents(
+\backslash
+"$$AbsPath$$Basename.asc
+\backslash
+")"
+\end_layout
-\begin_layout Plain Layout
-class=`layoutname'
+\begin_layout LyX-Code
+UpdateFormat asciixfig
\end_layout
-\end_inset
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.asc"
+\end_layout
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+Format DocBook
+\end_layout
-, where
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+Product "<graphic fileref=
+\backslash
+"$$AbsOrRelPathMaster$$Basename.eps
+\backslash
+">
+\end_layout
-\begin_layout Plain Layout
-layoutname
+\begin_layout LyX-Code
+ </graphic>"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+UpdateFormat eps
+\end_layout
- is the LyX name of the layout, made lowercase, for example: chapter.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.eps"
+\end_layout
-\begin_layout Plain Layout
-HTMLStyle
+\begin_layout LyX-Code
+ReferencedFile docbook "$$AbsPath$$Basename.eps"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\end_layout
- for that purpose.
+\begin_layout LyX-Code
+FormatEnd
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+Product "[XFig: $$FName]"
+\end_layout
-\begin_layout Plain Layout
-HTMLForceCSS
+\begin_layout LyX-Code
+FormatEnd
\end_layout
-\end_inset
+\begin_layout LyX-Code
+TemplateEnd
+\end_layout
- [
+\begin_layout Standard
+As you can see, the template is enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+Template
\end_layout
\end_inset
-] Whether to output the default CSS information LyX generates for this layout,
- even if additional information is explicitly provided via
+ \SpecialChar \ldots{}
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+TemplateEnd
\end_layout
\end_inset
.
- Setting this to
+ It contains a header specifying some general settings and, for each supported
+ primary document file format, a section
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Format
\end_layout
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is
+ \SpecialChar \ldots{}
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+FormatEnd
\end_layout
\end_inset
.
\end_layout
+\begin_layout Subsection
+The template header
+\end_layout
+
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLItem
-\end_layout
-
+AutomaticProduction
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+true|false
\end_layout
\end_inset
-] The tag to be used for individual paragraphs of environments, replacing
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-itemtag
+ Whether the file represented by the template must be generated by LyX.
+ This command must occur exactly once.
\end_layout
-\end_inset
-
- in the examples above.
- Defaults to
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
-\end_layout
-
+FileFilter
+\begin_inset space ~
\end_inset
-.
+<pattern>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-HTMLItemAttr
-\end_layout
+ A glob pattern that is used in the file dialog to filter out the desired
+ files.
+ If there is more than one possible file extension (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
- [
+tgif has
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+.obj
\end_layout
-\end_inset
-
-] Attributes for the item tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
-
+\end_inset
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname_item'
+.tgo
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
+), use something like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+"*.{obj,tgo}"
\end_layout
\end_inset
- for that purpose.
+.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLLabel
+GuiName
+\begin_inset space ~
+\end_inset
+
+<guiname>
\end_layout
\end_inset
- [
+ The text that is displayed on the button.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+HelpText
+\begin_inset space ~
+\end_inset
+
+<text>
+\begin_inset space ~
+\end_inset
+
+HelpTextEnd
\end_layout
\end_inset
-] The tag to be used for paragraph and item labels, replacing
+ The help text that is used in the External dialog.
+ Provide enough information to explain to the user just what the template
+ can provide him with.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-labeltag
+InputFormat
+\begin_inset space ~
+\end_inset
+
+<format>
\end_layout
\end_inset
- in the examples above.
- Defaults to
+ The file format of the original file.
+ This must be the name of a format that is known to LyX (see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Formats"
+
+\end_inset
+
+).
+ Use
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
+*
\end_layout
\end_inset
-, unless
+
+\begin_inset Quotes erd
+\end_inset
+
+ if the template can handle original files of more than one format.
+ LyX will attempt to interrogate the file itself in order to deduce its
+ format in this case.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+Template
+\begin_inset space ~
+\end_inset
+
+<id>
\end_layout
\end_inset
- is either
+ A unique name for the template.
+ It must not contain substitution macros (see below).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+Transform
+\begin_inset space ~
+\end_inset
+
+Rotate|Resize|Clip|Extra
\end_layout
\end_inset
- or
+ This command specifies which transformations are supported by this template.
+ It may occur zero or more times.
+ This command enables the corresponding tabs in the external dialog.
+ Each
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+Transform
\end_layout
\end_inset
-, in which case it defaults to
+ command must have either a corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+TransformCommand
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ or a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelAttr
+TransformOption
\end_layout
\end_inset
- [
+ command in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Format
\end_layout
\end_inset
-] Attributes for the label tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
+ section.
+ Otherwise the transformation will not be supported by that format.
+\end_layout
+\begin_layout Subsection
+The Format section
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname_label'
-\end_layout
-
+Format
+\begin_inset space ~
\end_inset
+LaTeX|PDFLaTeX|PlainText|DocBook
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
+ The primary document file format that this format definition is for.
+ Not every template has a sensible representation in all document file formats.
+ Please define nevertheless a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+Format
\end_layout
\end_inset
- for that purpose.
+ section for all templates.
+ Use a dummy text when no representation is available.
+ Then you can at least see a reference to the external material in the exported
+ document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
-\end_layout
-
+Option
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+<name>
+\begin_inset space ~
+\end_inset
-\emph on
-0
-\emph default
-,1
+<value>
\end_layout
\end_inset
-] Meaningful only for list-like environments, this tag controls whether
- the label tag is output before or inside the item tag.
- This is used, for example, in the description environment, where we want
- `
+ This command defines an additional macro
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<dt>\SpecialChar \ldots{}
-</dt><dd>\SpecialChar \ldots{}
-</dd>
+$$<name>
\end_layout
\end_inset
-.
- Default is
+ for substitution in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Product
\end_layout
\end_inset
-: The label tag is output inside the item tag.
-\end_layout
-
-\begin_layout Description
+.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+<value>
\end_layout
\end_inset
- Information to be output in the
+ itself may contain substitution macros.
+ The advantage over using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<head>
+<value>
\end_layout
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+ directly in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+Product
\end_layout
\end_inset
- block defining an
+ is that the substituted value of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
+$$<name>
\end_layout
\end_inset
- handler.
+ is sanitized so that it is a valid optional argument in the document format.
+ This command may occur zero or more times.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLStyle
-\end_layout
-
+Product
+\begin_inset space ~
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
+<text>
\end_layout
\end_inset
- block, so only the CSS itself need be included.
+ The text that is inserted in the exported document.
+ This is actually the most important command and can be quite complex.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTag
-\end_layout
-
+Preamble
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+<name>
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+ This command specifies a preamble snippet that will be included in the
+ LaTeX preamble.
+ It has to be defined using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+PreambleDef
\end_layout
\end_inset
- in the examples above.
- Defaults to
+ \SpecialChar \ldots{}
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+PreambleDefEnd
\end_layout
\end_inset
.
+ This command may occur zero or more times.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTitle
-\end_layout
-
+ReferencedFile
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+<format>
+\begin_inset space ~
+\end_inset
-\emph on
-0
-\emph default
-,1
+<filename>
\end_layout
\end_inset
-] Marks this style as the one to be used to generate the
+ This command denotes files that are created by the conversion process and
+ are needed for a particular export format.
+ If the filename is relative, it is interpreted relative to the master document.
+ This command may be given zero or more times.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<title>
+Requirement
+\begin_inset space ~
+\end_inset
+
+<package>
\end_layout
\end_inset
- tag for the XHTML file.
- By default, it is false.
- The
+ The name of a required LaTeX package.
+ The package is included via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdtitle.inc
+
+\backslash
+usepackage{}
\end_layout
\end_inset
- file sets it to true for the
+ in the LaTeX preamble.
+ This command may occur zero or more times.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-title
-\end_layout
+TransformCommand
+\begin_inset space ~
+\end_inset
+Rotate
+\begin_inset space ~
\end_inset
- environment.
-
+RotationLatexCommand
\end_layout
-\begin_layout Subsection
-InsetLayout XHTML
+\end_inset
+
+ This command specifies that the built in LaTeX command should be used for
+ rotation.
+ This command may occur once or not at all.
\end_layout
-\begin_layout Standard
-The XHTML output of insets can also be controlled by information in layout
- files.
-\begin_inset Foot
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-At present, this is true only for
-\begin_inset Quotes eld
-\end_inset
-
-text
-\begin_inset Quotes erd
-\end_inset
-
- insets (insets you can type into) and is not true for
-\begin_inset Quotes eld
+TransformCommand
+\begin_inset space ~
\end_inset
-command
-\begin_inset Quotes erd
+Resize
+\begin_inset space ~
\end_inset
- insets (insets that are associated with dialog boxes).
+ResizeLatexCommand
\end_layout
\end_inset
- Here, too, LyX tries to provide sensible defaults, and it constructs default
- CSS style rules.
- But everything can be customized.
+ This command specifies that the built in LaTeX command should be used for
+ resizing.
+ This command may occur once or not at all.
\end_layout
-\begin_layout Standard
-The XHTML LyX outputs for an inset has the following form:
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
+\begin_layout Plain Layout
+TransformOption
+\begin_inset space ~
\end_inset
-value
-\begin_inset Quotes erd
+Rotate
+\begin_inset space ~
\end_inset
->
-\end_layout
-
-\begin_layout LyX-Code
-<labeltag>Label</labeltag>
+RotationLatexOption
\end_layout
-\begin_layout LyX-Code
-<innertag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->Contents of the inset.</innertag>
-\end_layout
-
-\begin_layout LyX-Code
-</tag>
+ This command specifies that rotation is done via an optional argument.
+ This command may occur once or not at all.
\end_layout
-\begin_layout Standard
-If the inset permits multiple paragraphs---that is, if
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
-\end_layout
-
+TransformOption
+\begin_inset space ~
\end_inset
- is true---then the contents of the inset will itself be output as paragraphs
- formatted according to the styles used for those paragraphs (standard,
- quote, and the like).
- The label tag is of course omitted if the paragraph does not have a label
- and, at present, is always
-\begin_inset Flex Code
-status collapsed
+Resize
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-span
+ResizeLatexOption
\end_layout
\end_inset
-.
- The inner tag is optional and, by default, does not appear.
-\end_layout
-
-\begin_layout Standard
-The specific tags and attributes output for each inset can be controlled
- by means of the following layout tags.
+ This command specifies that resizing is done via an optional argument.
+ This command may occur once or not at all.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+TransformOption
+\begin_inset space ~
+\end_inset
+
+Clip
+\begin_inset space ~
+\end_inset
+
+ClipLatexOption
\end_layout
\end_inset
- [
+ This command specifies that clipping is done via an optional argument.
+ This command may occur once or not at all.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
+TransformOption
+\begin_inset space ~
+\end_inset
+Extra
+\begin_inset space ~
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
+ExtraLatexOption
+\end_layout
+
\end_inset
+ This command specifies that an extra optional argument is used.
+ This command may occur once or not at all.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`myinset' onclick=`\SpecialChar \ldots{}
-'
+UpdateFormat
+\begin_inset space ~
+\end_inset
+
+<format>
\end_layout
\end_inset
+ The file format of the converted file.
+ This must be the name of a format that is known to LyX (see the
+\begin_inset Flex MenuItem
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File Format
+\end_layout
-.
- By default, LyX will output
-\begin_inset Quotes eld
\end_inset
+ dialog).
+ This command must occur exactly once.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`insetname'
+UpdateResult
+\begin_inset space ~
+\end_inset
+
+<filename>
\end_layout
\end_inset
+ The file name of the converted file.
+ The file name must be absolute.
+ This command must occur exactly once.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Preamble definitions
+\end_layout
-, where
+\begin_layout Standard
+The external template configuration file may contain additional preamble
+ definitions enclosed by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-insetname
+PreambleDef
\end_layout
\end_inset
- is the LyX name of the inset, made lowercase and with non-alphanumeric
- characters converted to underscores, for example: footnote.
-\end_layout
-
-\begin_layout Description
+ \SpecialChar \ldots{}
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+PreambleDefEnd
\end_layout
\end_inset
- [
+.
+ They can be used by the templates in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+Format
\end_layout
\end_inset
-] Whether to output the default CSS information LyX generates for this layout,
- even if additional information is explicitly provided via
+ section.
+\end_layout
+
+\begin_layout Section
+The substitution mechanism
+\end_layout
+
+\begin_layout Standard
+When the external material facility invokes an external program, it is done
+ on the basis of a command defined in the template configuration file.
+ These commands can contain various macros that are expanded before execution.
+ Execution always take place in the directory of the containing document.
+\end_layout
+
+\begin_layout Standard
+Also, whenever external material is to be displayed, the name will be produced
+ by the substitution mechanism, and most other commands in the template
+ definition support substitution as well.
+\end_layout
+
+\begin_layout Standard
+The available macros are the following:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+$$AbsOrRelPathMaster
\end_layout
\end_inset
-.
- Setting this to
+ The file path, absolute or relative to the master LyX document.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+$$AbsOrRelPathParent
\end_layout
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is 0.
+ The file path, absolute or relative to the LyX document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLInnerAttr
+$$AbsPath
\end_layout
\end_inset
- [
+ The absolute file path.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+$$Basename
\end_layout
\end_inset
-] Attributes for the inner tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
-
+ The filename without path and without the extension.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`insetname_inner'
-\end_layout
-
+$$Contents(
+\begin_inset Quotes eld
\end_inset
-
+filename.ext
\begin_inset Quotes erd
\end_inset
-.
+)
\end_layout
-\begin_layout Description
+\end_inset
+
+ This macro will expand to the contents of the file with the name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerTag
+filename.ext
\end_layout
\end_inset
- [
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+$$Extension
\end_layout
\end_inset
-] The inner tag, replacing
+ The file extension (including the dot).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-innertag
+$$FName
\end_layout
\end_inset
- in the examples above.
- By default, there is none.
+ The filename of the file specified in the external material dialog.
+ This is either an absolute name, or it is relative to the LyX document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLIsBlock
+$$FPath
\end_layout
\end_inset
- [
+ The path part of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0,
-\emph on
-1
+$$FName
\end_layout
\end_inset
-] Whether this inset represents a standalone block of text (such as a footnote)
- or instead represents material that is included in the surrounding text
- (such as a branch).
- Defaults to 1.
+ (absolute name or relative to the LyX document).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLLabel
+$$RelPathMaster
\end_layout
\end_inset
- [
+ The file path, relative to the master LyX document.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+$$RelPathParent
\end_layout
\end_inset
-] A label for this inset, possibly including a reference to a counter.
- For example, for footnote, it might be:
+ The file path, relative to the LyX document.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{footnote}
+$$Sysdir
\end_layout
\end_inset
-.
- This is optional, and there is no default.
+ This macro will expand to the absolute path of the system directory.
+ This is typically used to point to the various helper scripts that are
+ bundled with LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+$$Tempname
\end_layout
\end_inset
- Information to be output in the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<head>
+ A name and full path to a temporary file which will be automatically deleted
+ whenever the containing document is closed, or the external material insertion
+ deleted.
\end_layout
+\begin_layout Standard
+All path macros contain a trailing directory separator, so you can construct
+ e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+the absolute filename with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+$$AbsPath$$Basename$$Extension
\end_layout
\end_inset
- block defining an
+.
+\end_layout
+
+\begin_layout Standard
+The macros above are substituted in all commands unless otherwise noted.
+ The command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
+Product
\end_layout
\end_inset
- handler.
-\end_layout
-
-\begin_layout Description
+ supports additionally the following substitutions if they are enabled by
+ the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+Transform
\end_layout
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+TransformCommand
\end_layout
\end_inset
- block, so only the CSS itself need be included.
+ commands:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTag
+$$ResizeFront
\end_layout
\end_inset
- [
+ The front part of the resize command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+$$ResizeBack
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+ The back part of the resize command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+$$RotateFront
\end_layout
\end_inset
- in the examples above.
- The default depends upon the setting of
+ The front part of the rotation command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+$$RotateBack
\end_layout
\end_inset
-: If
+ The back part of the rotation command.
+\end_layout
+
+\begin_layout Standard
+The value string of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+Option
\end_layout
\end_inset
- is true, the default is
+ command supports additionally the following substitutions if they are enabled
+ by the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+Transform
\end_layout
\end_inset
-; if it is false, the default is
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-Float XHTML
-\end_layout
-
-\begin_layout Standard
-The XHTML output for floats too can be controlled by layout information.
- The output has the following form:
+TransformOption
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
\end_inset
->
+ commands:
\end_layout
-\begin_layout LyX-Code
-Contents of the float.
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-</tag>
+\begin_layout Plain Layout
+$$Clip
\end_layout
-\begin_layout Standard
-The caption, if there is one, is a separate inset and will be output as
- such.
- Its appearance can be controlled via the InsetLayout for caption insets.
-
+\end_inset
+
+ The clip option.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+$$Extra
\end_layout
\end_inset
- [
+ The extra option.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+$$Resize
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
-
+ The resize option.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`myfloat' onclick=`\SpecialChar \ldots{}
-'
+$$Rotate
\end_layout
\end_inset
+ The rotation option.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+You may ask why there are so many path macros.
+ There are mainly two reasons:
+\end_layout
-.
- By default, LyX will output
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
+Relative and absolute file names should remain relative or absolute, respectivel
+y.
+ Users may have reasons to prefer either form.
+ Relative names are useful for portable documents that should work on different
+ machines, for example.
+ Absolute names may be required by some programs.
+\end_layout
+
+\begin_layout Enumerate
+LaTeX treats relative file names differently than LyX and other programs
+ in nested included files.
+ For LyX, a relative file name is always relative to the document that contains
+ the file name.
+ For LaTeX, it is always relative to the master document.
+ These two definitions are identical if you have only one document, but
+ differ if you have a master document that includes part documents.
+ That means that relative filenames must be transformed when presented to
+ LaTeX.
+ Fortunately LyX does this automatically for you if you choose the right
+ macros.
+\end_layout
+\begin_layout Standard
+So which path macro should be used in new template definitions? The rule
+ is not difficult:
+\end_layout
+\begin_layout Itemize
+Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`float float-floattype'
+$$AbsPath
\end_layout
\end_inset
+ if an absolute path is required.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-, where
+\begin_layout Itemize
+Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-floattype
+$$AbsOrRelPathMaster
\end_layout
\end_inset
- is LyX's name for this type of float, as determined by the float declaration
- (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Floats"
-
-\end_inset
-
-), though made lowercase and with non-alphanumeric characters converted
- to underscores, for example: float-table.
+ if the substituted string is some kind of LaTeX input.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+Else use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+$$AbsOrRelPathParent
\end_layout
\end_inset
- CSS style information to be included when this float is used.
- Note that this will automatically be wrapped in a layout-generated
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
+ in order to preserve the user's choice.
\end_layout
+\begin_layout Standard
+There are special cases where this rule does not work and e.
+\begin_inset space \thinspace{}
\end_inset
- block, so only the CSS itself need be included.
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Description
+relative names are needed, but normally it will work just fine.
+ One example for such a case is the command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
\end_layout
\end_inset
- [
+ in the XFig template above: We can't use the absolute name because the
+ copier for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+.pstex_t
\end_layout
\end_inset
-] The tag to be used for this float, replacing
-\begin_inset Quotes eld
+ files needs the relative name in order to rewrite the file content.
+\end_layout
+
+\begin_layout Section
+Security discussion
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Security-discussion"
+
\end_inset
+\end_layout
+
+\begin_layout Standard
+The external material feature interfaces with a lot of external programs
+ and does so automatically, so we have to consider the security implications
+ of this.
+ In particular, since you have the option of including your own filenames
+ and/or parameter strings and those are expanded into a command, it seems
+ that it would be possible to create a malicious document which executes
+ arbitrary commands when a user views or prints the document.
+ This is something we definitely want to avoid.
+\end_layout
+
+\begin_layout Standard
+However, since the external program commands are specified in the template
+ configuration file only, there are no security issues if LyX is properly
+ configured with safe templates only.
+ This is so because the external programs are invoked with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+execvp
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- in the example above.
- The default is
+-system call rather than the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+system
\end_layout
\end_inset
- and will rarely need changing.
+ system-call, so it's not possible to execute arbitrary commands from the
+ filename or parameter section via the shell.
\end_layout
-\begin_layout Subsection
-Bibliography formatting
+\begin_layout Standard
+This also implies that you are restricted in what command strings you can
+ use in the external material templates.
+ In particular, pipes and redirection are not readily available.
+ This has to be so if LyX should remain safe.
+ If you want to use some of the shell features, you should write a safe
+ script to do this in a controlled manner, and then invoke the script from
+ the command string.
+
\end_layout
\begin_layout Standard
-The bibliography can be formatted using
+It is possible to design a template that interacts directly with the shell,
+ but since this would allow a malicious user to execute arbitrary commands
+ by writing clever filenames and/or parameters, we generally recommend that
+ you only use safe scripts that work with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+execvp
\end_layout
\end_inset
- blocks.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Citation-format-description"
+ system call in a controlled manner.
+ Of course, for use in a controlled environment, it can be tempting to just
+ fall back to use ordinary shell scripts.
+ If you do so, be aware that you
+\emph on
+will
+\emph default
+ provide an easily exploitable security hole in your system.
+ Of course it stands to reason that such unsafe templates will never be
+ included in the standard LyX distribution, although we do encourage people
+ to submit new templates in the open source tradition.
+ But LyX as shipped from the official distribution channels will never have
+ unsafe templates.
+\end_layout
+
+\begin_layout Standard
+Including external material provides a lot of power, and you have to be
+ careful not to introduce security hazards with this power.
+ A subtle error in a single line in an innocent looking script can open
+ the door to huge security problems.
+ So if you do not fully understand the issues, we recommend that you consult
+ a knowledgeable security professional or the LyX development team if you
+ have any questions about whether a given template is safe or not.
+ And do this before you use it in an uncontrolled environment.
+\end_layout
+
+\begin_layout Chapter
+\start_of_appendix
+List of functions to be used in layouts
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:List-of-functions"
\end_inset
- for the details.
-\end_layout
-\begin_layout Subsection
-LyX-generated CSS
\end_layout
\begin_layout Standard
-We have several times mentioned that LyX will generate default CSS style
- rules for both insets and paragraph styles, based upon the other layout
- information that is provided.
- In this section, we shall say a word about which layout information LyX
- uses and how.
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="10" columns="6">
+<features rotate="0" tabularvalignment="middle">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+accents
\end_layout
-\begin_layout Standard
-At present, LyX auto-generates CSS only for font information, making use
- of the
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+bbding
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+dvipost
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Family
+fancybox
\end_layout
\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Series
+hhline
\end_layout
\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Shape
+latexsym
\end_layout
\end_inset
-
-, and
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Size
+amsbsy
\end_layout
\end_inset
-
- specified in the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Font
+bm
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- declaration.
- (See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
-\end_inset
+\end_layout
-.) The translation is mostly straightforward and obvious.
- For example,
-\begin_inset Quotes eld
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+feyn
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Family Sans
+hyperref
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+listings
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+amscd
+\end_layout
- becomes
-\begin_inset Quotes eld
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+booktabs
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-font-family: sans-serif;
+endnotes
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+fixltx2e
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
- The correspondence of LyX sizes and CSS sizes is a little less obvious
- but nonetheless intuitive.
- See the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-getSizeCSS()
+longtable
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- function in
-\begin_inset Flex URL
-status collapsed
+\begin_layout Plain Layout
+amsmath
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-src/FontInfo.cpp
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- for the details.
-
+\begin_layout Plain Layout
+enumitem
\end_layout
-\begin_layout Chapter
-Including External Material
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+float
\end_layout
-\begin_layout Standard
-\begin_inset Box Shadowbox
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "t"
-use_parbox 0
-use_makebox 0
-width "100col%"
-special "none"
-height "1in"
-height_special "totalheight"
-status open
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-WARNING: This portion of the documentation has not been updated for some
- time.
- We certainly hope that it is still accurate, but there are no guarantees.
+ifsym
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-
+\begin_layout Plain Layout
+lyxskak
\end_layout
-\begin_layout Standard
-The use of material from sources external to LyX is covered in detail in
- the
-\emph on
-Embedded Objects
-\emph default
- manual.
- This part of the manual covers what needs to happen behind the scenes for
- new sorts of material to be included.
-\end_layout
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout Section
-How does it work?
+\begin_layout Plain Layout
+amssymb
\end_layout
-\begin_layout Standard
-The external material feature is based on the concept of a
-\emph on
-template
-\emph default
-.
- A template is a specification of how LyX should interface with a certain
- kind of material.
- As bundled, LyX comes with predefined templates for Xfig figures, various
- raster format images, chess diagrams, and LilyPond music notation.
- You can check the actual list by using the menu
-\begin_inset Flex MenuItem
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
-External Material
+CJK
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
- Furthermore, it is possible to roll your own template to support a specific
- kind of material.
- Later we'll describe in more detail what is involved, and hopefully you
- will submit all the templates you create so we can include them in a later
- LyX version.
+\begin_layout Plain Layout
+esint
\end_layout
-\begin_layout Standard
-Another basic idea of the external material feature is to distinguish between
- the original file that serves as a base for final material and the produced
- file that is included in your exported or printed document.
- For example, consider the case of a figure produced with
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Xfig
+framed
\end_layout
\end_inset
-
-.
- The Xfig application itself works on an original file with the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-.fig
+ifthen
\end_layout
\end_inset
-
- extension.
- Within Xfig, you create and change your figure, and when you are done,
- you save the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-fig
+
\end_layout
\end_inset
-
--file.
- When you want to include the figure in your document, you invoke
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-transfig
+amstext
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- in order to create a PostScript file that can readily be included in your
- LaTeX file.
- In this case, the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+color
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-.fig
+
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
- file is the original file, and the PostScript file is the produced file.
\end_layout
-\begin_layout Standard
-This distinction is important in order to allow updating of the material
- while you are in the process of writing the document.
- Furthermore, it provides us with the flexibility that is needed to support
- 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 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
-zed on the different export formats that LyX supports.
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+
\end_layout
-\begin_layout Standard
-Besides supporting the production of different products according to the
- exported format, it supports tight integration with editing and viewing
- applications.
- In the case of an Xfig figure, you are able to invoke Xfig on the original
- file with a single click from within the external material dialog in LyX,
- and also preview the produced PostScript file with Ghostview with another
- click.
- No more fiddling around with the command line and/or file browsers to locate
- and manipulate the original or produced files.
- In this way, you are finally able to take full advantage of the many different
- applications that are relevant to use when you write your documents, and
- ultimately be more productive.
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+makeidx
\end_layout
-\begin_layout Section
-The external template configuration file
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+amsthm
\end_layout
-\begin_layout Standard
-It is relatively easy to add custom external template definitions to LyX.
- However, be aware that doing this in an careless manner most probably
-\emph on
-will
-\emph default
- introduce an easily exploitable security hole.
- So before you do this, please read the discussion about security in section
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Security-discussion"
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+covington
+\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
-.
\end_layout
-\begin_layout Standard
-Having said that, we encourage you to submit any interesting templates that
- you create.
-
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+graphicx
\end_layout
-\begin_layout Standard
-The external templates are defined in the
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-LyXDir/lib/external_templates
+jurabib
\end_layout
\end_inset
-
- file.
- You can place your own version in
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-UserDir/external_templates
+marvosym
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
+\begin_layout Plain Layout
+array
\end_layout
-\begin_layout Standard
-A typical template looks like this:
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-Template XFig
+\begin_layout Plain Layout
+csquotes
\end_layout
-\begin_layout LyX-Code
-GuiName "XFig: $$AbsOrRelPathParent$$Basename"
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-HelpText
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-An XFig figure.
\end_layout
-\begin_layout LyX-Code
-HelpTextEnd
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-InputFormat fig
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-FileFilter "*.fig"
\end_layout
-\begin_layout LyX-Code
-AutomaticProduction true
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-Transform Rotate
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-Transform Resize
\end_layout
-\begin_layout LyX-Code
-Format LaTeX
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
+\begin_layout Plain Layout
+mathdesign
\end_layout
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
-\end_layout
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
+\begin_layout Plain Layout
+ascii
\end_layout
-\begin_layout LyX-Code
-
-\backslash
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pstex_t}
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
\end_layout
-\begin_layout LyX-Code
-UpdateFormat pstex
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pstex_t"
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-Requirement "graphicx"
\end_layout
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.eps"
+\begin_layout Plain Layout
+mathdesign
\end_layout
-\begin_layout LyX-Code
-ReferencedFile dvi "$$AbsPath$$Basename.eps"
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-Format PDFLaTeX
\end_layout
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
+\begin_layout Plain Layout
+mathdots
\end_layout
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
-\end_layout
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-
-\backslash
+\begin_layout Plain Layout
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
\end_layout
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-UpdateFormat pdftex
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pdftex_t"
\end_layout
-\begin_layout LyX-Code
-Requirement "graphicx"
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.pdf"
\end_layout
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-Format Ascii
+\begin_layout Plain Layout
+mathdots
\end_layout
-\begin_layout LyX-Code
-Product "$$Contents(
-\backslash
-"$$AbsPath$$Basename.asc
-\backslash
-")"
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-UpdateFormat asciixfig
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.asc"
\end_layout
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-Format DocBook
+\begin_layout Plain Layout
+subfig
\end_layout
-\begin_layout LyX-Code
-Product "<graphic fileref=
-\backslash
-"$$AbsOrRelPathMaster$$Basename.eps
-\backslash
-">
-\end_layout
+\end_inset
+</cell>
+</row>
+</lyxtabular>
-\begin_layout LyX-Code
- </graphic>"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-UpdateFormat eps
-\end_layout
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.eps"
\end_layout
-\begin_layout LyX-Code
-ReferencedFile docbook "$$AbsPath$$Basename.eps"
-\end_layout
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="10" columns="6">
+<features rotate="0" tabularvalignment="middle">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<column alignment="left" valignment="top" width="14col%">
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\begin_layout Plain Layout
+makeidx
\end_layout
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout LyX-Code
-Product "[XFig: $$FName]"
+\begin_layout Plain Layout
+pdfcolmk
\end_layout
-\begin_layout LyX-Code
-FormatEnd
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+setspace
\end_layout
-\begin_layout LyX-Code
-TemplateEnd
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+textcomp
\end_layout
-\begin_layout Standard
-As you can see, the template is enclosed in
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Template
+ulem
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- \SpecialChar \ldots{}
-
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+xargs
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TemplateEnd
+marvosym
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
- It contains a header specifying some general settings and, for each supported
- primary document file format, a section
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+pdfpages
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Format
+slashed
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- \SpecialChar \ldots{}
-
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+textgreek
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-FormatEnd
+undertilde
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
+\begin_layout Plain Layout
+xcolor
\end_layout
-\begin_layout Subsection
-The template header
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mathdesign
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-AutomaticProduction
-\begin_inset space ~
+pifont
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-true|false
+\begin_layout Plain Layout
+soul
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- Whether the file represented by the template must be generated by LyX.
- This command must occur exactly once.
+\begin_layout Plain Layout
+tfrupee
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-FileFilter
-\begin_inset space ~
+units
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<pattern>
+\begin_layout Plain Layout
+xy
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- A glob pattern that is used in the file dialog to filter out the desired
- files.
- If there is more than one possible file extension (e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+mathdots
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-
-tgif has
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-.obj
+pmboxdraw
\end_layout
\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-.tgo
+splitidx
\end_layout
\end_inset
-
-), use something like
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-"*.{obj,tgo}"
+tipa
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
- This command must occur exactly once.
+\begin_layout Plain Layout
+url
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-GuiName
-\begin_inset space ~
-\end_inset
-<guiname>
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The text that is displayed on the button.
- This command must occur exactly once.
+\begin_layout Plain Layout
+mathrsfs
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-HelpText
-\begin_inset space ~
-\end_inset
+polyglossia
+\end_layout
-<text>
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-HelpTextEnd
+\begin_layout Plain Layout
+subfig
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The help text that is used in the External dialog.
- Provide enough information to explain to the user just what the template
- can provide him with.
- This command must occur exactly once.
+\begin_layout Plain Layout
+tipx
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-InputFormat
-\begin_inset space ~
-\end_inset
-<format>
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file format of the original file.
- This must be the name of a format that is known to LyX (see section
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+yhmath
+\end_layout
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Formats"
+\begin_layout Plain Layout
+mhchem
+\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+prettyref
+\end_layout
-).
- Use
-\begin_inset Quotes eld
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+subscript
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-*
+tone
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+varioref
+\end_layout
-\begin_inset Quotes erd
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
- if the template can handle original files of more than one format.
- LyX will attempt to interrogate the file itself in order to deduce its
- format in this case.
- This command must occur exactly once.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Template
-\begin_inset space ~
+multirow
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<id>
+\begin_layout Plain Layout
+pxfonts
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
- A unique name for the template.
- It must not contain substitution macros (see below).
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Transform
-\begin_inset space ~
+txfonts
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-Rotate|Resize|Clip|Extra
+\begin_layout Plain Layout
+verbatim
\end_layout
\end_inset
-
- This command specifies which transformations are supported by this template.
- It may occur zero or more times.
- This command enables the corresponding tabs in the external dialog.
- Each
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Transform
+
\end_layout
\end_inset
-
- command must have either a corresponding
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformCommand
+
\end_layout
\end_inset
-
- or a
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
+
\end_layout
\end_inset
-
- command in the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Format
+
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- section.
- Otherwise the transformation will not be supported by that format.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsection
-The Format section
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Format
-\begin_inset space ~
-\end_inset
-LaTeX|PDFLaTeX|PlainText|DocBook
\end_layout
\end_inset
-
- The primary document file format that this format definition is for.
- Not every template has a sensible representation in all document file formats.
- Please define nevertheless a
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Format
+
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- section for all templates.
- Use a dummy text when no representation is available.
- Then you can at least see a reference to the external material in the exported
- document.
+\begin_layout Plain Layout
+natbib
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Option
-\begin_inset space ~
-\end_inset
+rotating
+\end_layout
-<name>
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
-<value>
\end_layout
\end_inset
-
- This command defines an additional macro
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$<name>
+
\end_layout
\end_inset
-
- for substitution in
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
+wasysym
\end_layout
\end_inset
-
-.
-
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-<value>
+
\end_layout
\end_inset
-
- itself may contain substitution macros.
- The advantage over using
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-<value>
+nomencl
\end_layout
\end_inset
-
- directly in
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
+rotfloat
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- is that the substituted value of
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$<name>
+
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- is sanitized so that it is a valid optional argument in the document format.
- This command may occur zero or more times.
+\begin_layout Plain Layout
+wrapfig
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
-\begin_inset space ~
+
+\end_layout
+
\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
-<text>
+\begin_layout Chapter
+List of supported LyX functions to be used in layouts
\end_layout
-\end_inset
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="10" columns="8">
+<features rotate="0" tabularvalignment="middle">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<column alignment="left" valignment="top" width="0">
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The text that is inserted in the exported document.
- This is actually the most important command and can be quite complex.
- This command must occur exactly once.
+\begin_layout Plain Layout
+accents
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Preamble
-\begin_inset space ~
+bm
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<name>
+\begin_layout Plain Layout
+esint
\end_layout
\end_inset
-
- This command specifies a preamble snippet that will be included in the
- LaTeX preamble.
- It has to be defined using
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDef
+ifthen
\end_layout
\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDefEnd
+mathrsfs
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-.
- This command may occur zero or more times.
+\begin_layout Plain Layout
+prettyref
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-ReferencedFile
-\begin_inset space ~
-\end_inset
+subscript
+\end_layout
-<format>
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-<filename>
+\begin_layout Plain Layout
+units
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command denotes files that are created by the conversion process and
- are needed for a particular export format.
- If the filename is relative, it is interpreted relative to the master document.
- This command may be given zero or more times.
+\begin_layout Plain Layout
+amsbsy
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Requirement
-\begin_inset space ~
+booktabs
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<package>
+\begin_layout Plain Layout
+fancybox
\end_layout
\end_inset
-
- The name of a required LaTeX package.
- The package is included via
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-
-\backslash
-usepackage{}
+jurabib
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- in the LaTeX preamble.
- This command may occur zero or more times.
+\begin_layout Plain Layout
+mhchem
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformCommand
-\begin_inset space ~
-\end_inset
+pxfonts
+\end_layout
-Rotate
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-RotationLatexCommand
+\begin_layout Plain Layout
+textcomp
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that the built in LaTeX command should be used for
- rotation.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+url
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformCommand
-\begin_inset space ~
-\end_inset
+amscd
+\end_layout
-Resize
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-ResizeLatexCommand
+\begin_layout Plain Layout
+calc
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that the built in LaTeX command should be used for
- resizing.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+feyn
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+latexsym
+\end_layout
-Rotate
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-RotationLatexOption
+\begin_layout Plain Layout
+multirow
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that rotation is done via an optional argument.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+refstyle
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+textgreek
+\end_layout
-Resize
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-ResizeLatexOption
+\begin_layout Plain Layout
+varioref
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that resizing is done via an optional argument.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+amsmath
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+CJK
+\end_layout
-Clip
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-ClipLatexOption
+\begin_layout Plain Layout
+fixltx2e
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that clipping is done via an optional argument.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+listings
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+natbib
+\end_layout
-Extra
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-ExtraLatexOption
+\begin_layout Plain Layout
+rotating
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that an extra optional argument is used.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+tfrupee
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-UpdateFormat
-\begin_inset space ~
+verbatim
+\end_layout
+
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<format>
+\begin_layout Plain Layout
+amssymb
\end_layout
\end_inset
-
- The file format of the converted file.
- This must be the name of a format that is known to LyX (see the
-\begin_inset Flex MenuItem
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
+color
+\end_layout
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File Format
+\begin_layout Plain Layout
+float
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- dialog).
- This command must occur exactly once.
+\begin_layout Plain Layout
+longtable
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-UpdateResult
-\begin_inset space ~
+nomencl
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-<filename>
+\begin_layout Plain Layout
+rotfloat
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The file name of the converted file.
- The file name must be absolute.
- This command must occur exactly once.
+\begin_layout Plain Layout
+tipa
\end_layout
-\begin_layout Subsection
-Preamble definitions
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+wasysym
\end_layout
-\begin_layout Standard
-The external template configuration file may contain additional preamble
- definitions enclosed by
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDef
+amstext
\end_layout
\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDefEnd
+covington
\end_layout
\end_inset
-
-.
- They can be used by the templates in the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Format
+framed
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- section.
+\begin_layout Plain Layout
+lyxskak
\end_layout
-\begin_layout Section
-The substitution mechanism
-\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout Standard
-When the external material facility invokes an external program, it is done
- on the basis of a command defined in the template configuration file.
- These commands can contain various macros that are expanded before execution.
- Execution always take place in the directory of the containing document.
+\begin_layout Plain Layout
+pdfcolmk
\end_layout
-\begin_layout Standard
-Also, whenever external material is to be displayed, the name will be produced
- by the substitution mechanism, and most other commands in the template
- definition support substitution as well.
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+setspace
\end_layout
-\begin_layout Standard
-The available macros are the following:
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+tipx
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsOrRelPathMaster
+wrapfig
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file path, absolute or relative to the master LyX document.
+\begin_layout Plain Layout
+amsthm
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsOrRelPathParent
+csquotes
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file path, absolute or relative to the LyX document.
+\begin_layout Plain Layout
+graphicx
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsPath
+makeidx
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The absolute file path.
+\begin_layout Plain Layout
+pdfpages
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Basename
+slashed
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The filename without path and without the extension.
+\begin_layout Plain Layout
+tone
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Contents(
-\begin_inset Quotes eld
-\end_inset
+xargs
+\end_layout
-filename.ext
-\begin_inset Quotes erd
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-)
+\begin_layout Plain Layout
+array
\end_layout
\end_inset
-
- This macro will expand to the contents of the file with the name
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-filename.ext
+dvipost
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
+\begin_layout Plain Layout
+hhline
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Extension
+marvosym
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The file extension (including the dot).
+\begin_layout Plain Layout
+pifont
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$FName
+soul
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The filename of the file specified in the external material dialog.
- This is either an absolute name, or it is relative to the LyX document.
+\begin_layout Plain Layout
+txfonts
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$FPath
+xcolor
\end_layout
\end_inset
-
- The path part of
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$FName
+ascii
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- (absolute name or relative to the LyX document).
+\begin_layout Plain Layout
+endnotes
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$RelPathMaster
+hyperref
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file path, relative to the master LyX document.
+\begin_layout Plain Layout
+mathdesign
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$RelPathParent
+pmboxdraw
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The file path, relative to the LyX document.
+\begin_layout Plain Layout
+splitidx
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Sysdir
+ulem
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This macro will expand to the absolute path of the system directory.
- This is typically used to point to the various helper scripts that are
- bundled with LyX.
+\begin_layout Plain Layout
+xy
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Tempname
+bbding
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- A name and full path to a temporary file which will be automatically deleted
- whenever the containing document is closed, or the external material insertion
- deleted.
+\begin_layout Plain Layout
+enumitem
\end_layout
-\begin_layout Standard
-All path macros contain a trailing directory separator, so you can construct
- e.
-\begin_inset space \thinspace{}
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Plain Layout
+ifsym
+\end_layout
-the absolute filename with
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsPath$$Basename$$Extension
+mathdots
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-.
+\begin_layout Plain Layout
+polyglossia
\end_layout
-\begin_layout Standard
-The macros above are substituted in all commands unless otherwise noted.
- The command
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
+subfig
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- supports additionally the following substitutions if they are enabled by
- the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Plain Layout
+undertilde
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Transform
+yhmath
\end_layout
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
\end_inset
- and
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-TransformCommand
\end_layout
+\begin_layout Standard
+accents amsbsy amscd amsmath amssymb amstext amsthm array ascii bbding bm
+ booktabs calc CJK color covington csquotes dvipost endnotes enumitem esint
+ fancybox feyn fixltx2e float framed graphicx hhline hyperref ifsym ifthen
+ jurabib latexsym listings longtable lyxskak makeidx marvosym mathdesign
+ mathdots mathrsfs mhchem multirow natbib nomencl pdfcolmk pdfpages pifont
+ pmboxdraw polyglossia prettyref pxfonts refstyle rotating rotfloat setspace
+ slashed soul splitidx subfig subscript textcomp textgreek tfrupee tipa
+ tipx tone txfonts ulem undertilde units url varioref verbatim wasysym wrapfig
+ xargs xcolor xy yhmath
+\end_layout
+
+\begin_layout Chapter
+Names of available colors to be used in layouts
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:Names-of-colors"
+
\end_inset
- commands:
+
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
+The colors listed here are the standard colors and the those that you can
+ adjust in the LyX preferences.
+\end_layout
-\begin_layout Plain Layout
-$$ResizeFront
+\begin_layout Description
+none
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\strikeout off
+\uuline off
+\uwave off
+\noun off
+\color none
+ No particular color -- clear or default
\end_layout
-\end_inset
+\begin_layout Description
+black
+\end_layout
- The front part of the resize command.
+\begin_layout Description
+white
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+red
+\end_layout
-\begin_layout Plain Layout
-$$ResizeBack
+\begin_layout Description
+green
\end_layout
-\end_inset
+\begin_layout Description
+blue
+\end_layout
- The back part of the resize command.
+\begin_layout Description
+cyan
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+magenta
+\end_layout
-\begin_layout Plain Layout
-$$RotateFront
+\begin_layout Description
+yellow
\end_layout
-\end_inset
+\begin_layout Description
+cursor Cursor color
+\end_layout
- The front part of the rotation command.
+\begin_layout Description
+background Background color
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+foreground Foreground color
+\end_layout
-\begin_layout Plain Layout
-$$RotateBack
+\begin_layout Description
+selection Background color of selected text
\end_layout
-\end_inset
+\begin_layout Description
+selectiontext Foreground color of selected text
+\end_layout
- The back part of the rotation command.
+\begin_layout Description
+latex Text color in LaTeX mode
\end_layout
-\begin_layout Standard
-The value string of the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+preview The color used for previews
+\end_layout
-\begin_layout Plain Layout
-Option
+\begin_layout Description
+inlinecompletion Inline completion color
\end_layout
-\end_inset
+\begin_layout Description
+nonunique_inlinecompletion Inline completion color for the non-unique part
+\end_layout
- command supports additionally the following substitutions if they are enabled
- by the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+notelabel Label color for notes
+\end_layout
-\begin_layout Plain Layout
-Transform
+\begin_layout Description
+notebg Background color of notes
\end_layout
-\end_inset
+\begin_layout Description
+commentlabel Label color for comments
+\end_layout
- and
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+commentbg Background color of comments
+\end_layout
-\begin_layout Plain Layout
-TransformOption
+\begin_layout Description
+greyedoutlabel Label color for greyedout insets
\end_layout
-\end_inset
+\begin_layout Description
+greyedouttext Color for greyedout inset text
+\end_layout
- commands:
+\begin_layout Description
+greyedoutbg Background color of greyedout inset
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+shadedbg Background color of shaded box
+\end_layout
-\begin_layout Plain Layout
-$$Clip
+\begin_layout Description
+listingsbg Background color of listings inset
\end_layout
-\end_inset
+\begin_layout Description
+branchlabel Label color for branches
+\end_layout
- The clip option.
+\begin_layout Description
+footlabel Label color for footnotes
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+indexlabel Label color for index insets
+\end_layout
-\begin_layout Plain Layout
-$$Extra
+\begin_layout Description
+marginlabel Label color for margin notes
\end_layout
-\end_inset
+\begin_layout Description
+phantomtext Text color for phantom insets
+\end_layout
- The extra option.
+\begin_layout Description
+urllabel Label color for URL insets
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+urltext Color for URL inset text
+\end_layout
-\begin_layout Plain Layout
-$$Resize
+\begin_layout Description
+depthbar Color for the depth bars in the margin
\end_layout
-\end_inset
+\begin_layout Description
+language Color for marking foreign language words
+\end_layout
- The resize option.
+\begin_layout Description
+command Text color for command insets
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+commandbg Background color for command insets
+\end_layout
-\begin_layout Plain Layout
-$$Rotate
+\begin_layout Description
+commandframe Frame color for command insets
\end_layout
-\end_inset
+\begin_layout Description
+special Special chars text color
+\end_layout
- The rotation option.
+\begin_layout Description
+graphicsbg Graphics inset background color
\end_layout
-\begin_layout Standard
-You may ask why there are so many path macros.
- There are mainly two reasons:
+\begin_layout Description
+math Math inset text color
\end_layout
-\begin_layout Enumerate
-Relative and absolute file names should remain relative or absolute, respectivel
-y.
- Users may have reasons to prefer either form.
- Relative names are useful for portable documents that should work on different
- machines, for example.
- Absolute names may be required by some programs.
+\begin_layout Description
+mathbg Math inset background color
\end_layout
-\begin_layout Enumerate
-LaTeX treats relative file names differently than LyX and other programs
- in nested included files.
- For LyX, a relative file name is always relative to the document that contains
- the file name.
- For LaTeX, it is always relative to the master document.
- These two definitions are identical if you have only one document, but
- differ if you have a master document that includes part documents.
- That means that relative filenames must be transformed when presented to
- LaTeX.
- Fortunately LyX does this automatically for you if you choose the right
- macros.
+\begin_layout Description
+mathmacrobg Macro math inset background color
\end_layout
-\begin_layout Standard
-So which path macro should be used in new template definitions? The rule
- is not difficult:
+\begin_layout Description
+mathmacrohoverbg Macro math inset background color hovered
\end_layout
-\begin_layout Itemize
-Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+mathmacrolabel Macro math label color
+\end_layout
-\begin_layout Plain Layout
-$$AbsPath
+\begin_layout Description
+mathmacroframe Macro math frame color
\end_layout
-\end_inset
+\begin_layout Description
+mathmacroblend Macro math blended color
+\end_layout
- if an absolute path is required.
+\begin_layout Description
+mathmacrooldarg Macro template color for old parameters
\end_layout
-\begin_layout Itemize
-Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+mathmacronewarg Macro template color for new parameters
+\end_layout
-\begin_layout Plain Layout
-$$AbsOrRelPathMaster
+\begin_layout Description
+mathframe Math inset frame color under focus
\end_layout
-\end_inset
+\begin_layout Description
+mathcorners Math inset frame color not under focus
+\end_layout
- if the substituted string is some kind of LaTeX input.
+\begin_layout Description
+mathline Math line color
\end_layout
-\begin_layout Itemize
-Else use
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+collapsable Collapsable insets text
+\end_layout
-\begin_layout Plain Layout
-$$AbsOrRelPathParent
+\begin_layout Description
+collapsableframe Collapsable insets frame
\end_layout
-\end_inset
+\begin_layout Description
+insetbg Inset marker background color
+\end_layout
- in order to preserve the user's choice.
+\begin_layout Description
+insetframe Inset marker frame color
\end_layout
-\begin_layout Standard
-There are special cases where this rule does not work and e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Description
+error Error box text color
+\end_layout
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Description
+eolmarker End of line marker color
+\end_layout
-relative names are needed, but normally it will work just fine.
- One example for such a case is the command
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+added_space Added space colour
+\end_layout
-\begin_layout Plain Layout
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+\begin_layout Description
+appendix Appendix marker color
\end_layout
-\end_inset
+\begin_layout Description
+changebar Changebar color
+\end_layout
- in the XFig template above: We can't use the absolute name because the
- copier for
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+deletedtext Deleted text color
+\end_layout
-\begin_layout Plain Layout
-.pstex_t
+\begin_layout Description
+addedtext Added text color
\end_layout
-\end_inset
+\begin_layout Description
+changedtextauthor1 Changed text color author 1
+\end_layout
- files needs the relative name in order to rewrite the file content.
+\begin_layout Description
+changedtextauthor2 Changed text color author 2
\end_layout
-\begin_layout Section
-Security discussion
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Security-discussion"
+\begin_layout Description
+changedtextauthor3 Changed text color author 3
+\end_layout
-\end_inset
+\begin_layout Description
+changedtextauthor4 Changed text color author 4
+\end_layout
+\begin_layout Description
+changedtextauthor5 Changed text color author 5
+\end_layout
+\begin_layout Description
+deletedtextmodifier Deleted text modifying color
\end_layout
-\begin_layout Standard
-The external material feature interfaces with a lot of external programs
- and does so automatically, so we have to consider the security implications
- of this.
- In particular, since you have the option of including your own filenames
- and/or parameter strings and those are expanded into a command, it seems
- that it would be possible to create a malicious document which executes
- arbitrary commands when a user views or prints the document.
- This is something we definitely want to avoid.
+\begin_layout Description
+tabularline Table line color
\end_layout
-\begin_layout Standard
-However, since the external program commands are specified in the template
- configuration file only, there are no security issues if LyX is properly
- configured with safe templates only.
- This is so because the external programs are invoked with the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+tabularonoffline Table line color
+\end_layout
-\begin_layout Plain Layout
-execvp
+\begin_layout Description
+bottomarea Bottom area color
\end_layout
-\end_inset
+\begin_layout Description
+newpage New page color
+\end_layout
--system call rather than the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+pagebreak Page break color
+\end_layout
-\begin_layout Plain Layout
-system
+\begin_layout Description
+buttonframe Color used for button frame
\end_layout
-\end_inset
+\begin_layout Description
+buttonbg Color used for bottom background
+\end_layout
- system-call, so it's not possible to execute arbitrary commands from the
- filename or parameter section via the shell.
+\begin_layout Description
+buttonhoverbg Color used for buttom under focus
\end_layout
-\begin_layout Standard
-This also implies that you are restricted in what command strings you can
- use in the external material templates.
- In particular, pipes and redirection are not readily available.
- This has to be so if LyX should remain safe.
- If you want to use some of the shell features, you should write a safe
- script to do this in a controlled manner, and then invoke the script from
- the command string.
+\begin_layout Description
+paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
\end_layout
-\begin_layout Standard
-It is possible to design a template that interacts directly with the shell,
- but since this would allow a malicious user to execute arbitrary commands
- by writing clever filenames and/or parameters, we generally recommend that
- you only use safe scripts that work with the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-execvp
+\begin_layout Description
+previewframe Preview frame color
\end_layout
-\end_inset
+\begin_layout Description
+inherit Color is inherited
+\end_layout
- system call in a controlled manner.
- Of course, for use in a controlled environment, it can be tempting to just
- fall back to use ordinary shell scripts.
- If you do so, be aware that you
-\emph on
-will
-\emph default
- provide an easily exploitable security hole in your system.
- Of course it stands to reason that such unsafe templates will never be
- included in the standard LyX distribution, although we do encourage people
- to submit new templates in the open source tradition.
- But LyX as shipped from the official distribution channels will never have
- unsafe templates.
+\begin_layout Description
+regexpframe Color for regexp frame
\end_layout
-\begin_layout Standard
-Including external material provides a lot of power, and you have to be
- careful not to introduce security hazards with this power.
- A subtle error in a single line in an innocent looking script can open
- the door to huge security problems.
- So if you do not fully understand the issues, we recommend that you consult
- a knowledgeable security professional or the LyX development team if you
- have any questions about whether a given template is safe or not.
- And do this before you use it in an uncontrolled environment.
+\begin_layout Description
+ignore For ignoring updates of a color
\end_layout
\end_body