-#LyX 2.2 created this file. For more info see http://www.lyx.org/
-\lyxformat 503
+#LyX 2.4 created this file. For more info see https://www.lyx.org/
+\lyxformat 598
\begin_document
\begin_header
+\save_transient_properties true
\origin /systemlyxdir/doc/
\textclass scrbook
\begin_preamble
% the documentation team
% email: lyx-docs@lists.lyx.org
-\usepackage{ifpdf} % part of the hyperref bundle
-\ifpdf % if pdflatex is used
-
- % set fonts for nicer pdf view
- \IfFileExists{lmodern.sty}
- {\usepackage{lmodern}}{}
-
-\fi % end if pdflatex is used
-
% the pages of the TOC is numbered roman
% and a pdf-bookmark for the TOC is added
\let\myTOC\tableofcontents
}
}{}
\end_preamble
-\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
+\options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\begin_modules
logicalmkup
\end_modules
-\maintain_unincluded_children false
-\begin_local_layout
-Format 57
-InsetLayout Flex:MenuItem
-LyxType charstyle
-LabelString menu
-LatexType command
-LatexName menuitem
-Font
-Family Sans
-EndFont
-Preamble
-\newcommand*{\menuitem}[1]{{\sffamily #1}}
-EndPreamble
-ResetsFont true
-End
-# In case we need to do with sans...
-#InsetLayout CharStyle:Code
-#Font
-#Family Sans
-#EndFont
-#Preamble
-#\renewcommand{\code}[1]{{\sffamily #1}}
-#EndPreamble
-#End
-\end_local_layout
+\maintain_unincluded_children no
\language english
\language_package default
-\inputencoding auto
-\fontencoding global
-\font_roman "default" "default"
-\font_sans "default" "default"
-\font_typewriter "default" "default"
+\inputencoding utf8
+\fontencoding auto
+\font_roman "lmodern" "default"
+\font_sans "lmss" "default"
+\font_typewriter "lmtt" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
-\font_osf false
+\font_roman_osf false
+\font_sans_osf false
+\font_typewriter_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures true
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command default
\index_command default
\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_package amsmath 0
-\use_package amssymb 0
-\use_package cancel 0
-\use_package esint 0
+\use_package amsmath 1
+\use_package amssymb 1
+\use_package cancel 1
+\use_package esint 1
\use_package mathdots 1
-\use_package mathtools 0
-\use_package mhchem 0
-\use_package stackrel 0
-\use_package stmaryrd 0
-\use_package undertilde 0
+\use_package mathtools 1
+\use_package mhchem 1
+\use_package stackrel 1
+\use_package stmaryrd 1
+\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\suppress_date false
\justification true
\use_refstyle 0
+\use_minted 0
+\use_lineno 0
+\notefontcolor #0000ff
\branch OutDated
\selected 0
\filename_suffix 0
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
-\quotes_language english
+\is_math_indent 1
+\math_indentation default
+\math_numbering_side default
+\quotes_style english
+\dynamic_quotes 0
\papercolumns 1
\papersides 2
\paperpagestyle headings
+\tablestyle default
\tracking_changes true
\output_changes false
+\change_bars false
+\postpone_fragile_content false
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
+\docbook_table_output 0
+\author -970929547 "Thibaut Cuvelier"
\author -712698321 "Jürgen Spitzmüller"
-\author -195340706 "Georg Baum"
-\author 274215730 "scott"
+\author -495245474 "Jean-Marc Lasgouttes"
+\author 5863208 "ab"
+\author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
+\author 1075283030 "Thibaut"
\end_header
\begin_body
LatexCommand href
target "lyx-docs@lists.lyx.org"
type "mailto:"
+literal "false"
\end_inset
\begin_inset Newline newline
\end_inset
-Version 2.1.x
+Version 2.3.x
\end_layout
\begin_layout Standard
\begin_layout Standard
\begin_inset Branch OutDated
+inverted 0
status collapsed
\begin_layout Standard
Before continuing to read this chapter, you should find out where your
\SpecialChar LyX
library and user directories are by using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and the latter
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
's behavior.
You can change many of these files from within \SpecialChar LyX
itself through the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The files, which are to be found in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
It is currently unused by the \SpecialChar LyX
program itself, but the information extracted,
and more, is made available with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+citeengines/
+\end_layout
+
+\end_inset
+
+ contains files with the extension
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.citeengine
+\end_layout
+
+\end_inset
+
+ which define the diverse citation possibilities (natbib, biblatex etc.).
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
clipart/
\end_layout
contains example files that explain how to use some features.
In the file browser, press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
contains image files that are used by the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
contains some files that demonstrate the capabilities of the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
appearing on the toolbar.
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+xtemplates/
+\end_layout
+
+\end_inset
+
+ contains files with the extension
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.xtemplate
+\end_layout
+
+\end_inset
+
+ which define the templates for the insertion of external material to a
+ \SpecialChar LyX
+ document; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Including-External-Material"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Subsection
Files you don't want to modify
\end_layout
this file contains the list of \SpecialChar LyX
developers.
The contents are displayed with the menu entry
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-external_templates
-\end_layout
-
-\end_inset
-
- this file contains the templates available to the new
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-External
-\begin_inset space ~
-\end_inset
-
-Template
-\end_layout
-
-\end_inset
-
- feature, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:Including-External-Material"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-\begin_inset Flex Code
-status collapsed
-
\begin_layout Plain Layout
languages
\end_layout
\end_inset
- this file contains information about unicode-encoded glyphs and the way
+ this file contains information about Unicode-encoded glyphs and the way
they are supported by \SpecialChar LyX
via \SpecialChar LaTeX
.
\end_inset
in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
The preferences set in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
When you reconfigure using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will be added to the list of classes in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and the items in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
subdirectory, however, since it contains a file written by the configuration
script (also accessible through
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The first step is to define your file formats if they are not already defined.
To do so, open the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
dialog.
Under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
button to define your new format.
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
field contains the name used to identify the format in the GUI.
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
You will also need to enter a file extension.
These are all required.
The optional
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
field is used to provide a keyboard shortcut on the menus.
(For example, pressing
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
A Format can have a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and an
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
associated with it.
For example, you might want to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
next section.
The viewer is launched when you view an image in \SpecialChar LyX
or use the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
menu.
The editor is for example launched when you right-click on an image and
choose
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
LatexCommand href
name "IANA"
target "http://www.iana.org/assignments/media-types/"
+literal "false"
\end_inset
LatexCommand href
name "freedesktop.org"
target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
+literal "false"
\end_inset
\begin_layout Standard
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
), the format will appear in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
menu.
The format will also appear in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The option
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
that a format can contain vector graphics.
This information is used to determine the target format of included graphics
for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
export.
Included graphics may need to be converted to either
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, since
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
cannot handle other image formats.
If an included graphic is not already in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
format, it is converted to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
if the vector format option is set, and otherwise to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-The definitions of the copiers may use four variables:
+The definitions of the copiers may use eight variables:
\end_layout
\begin_layout Labeling
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
—and make it executable, if you need to do so on your platform.
Then, in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
dialog, select under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
into the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
For example, if appropriate programs are found, \SpecialChar LyX
will automatically install
copiers for the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, so HTML generated from
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will end up in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can define your own Converters to convert files between different formats.
This is done in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
To define a new converter, select the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
from the drop-down lists, enter the command needed for the conversion,
and then press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
latex
+\change_inserted -712698321 1524656940
+=flavor
+\change_unchanged
+
\end_layout
\end_inset
This will make \SpecialChar LyX
's \SpecialChar LaTeX
error logs available.
+
+\change_inserted -712698321 1524657018
+ The optional
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657012
+flavor
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657005
+latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified,
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657018
+latex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
\begin_layout Plain Layout
needaux
+\change_inserted -712698321 1524656935
+=flavor
+\change_unchanged
+
\end_layout
\end_inset
Needs the \SpecialChar LaTeX
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
file for the conversion.
+
+\change_inserted -712698321 1524657047
+ The optional
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+flavor
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ value specifies the form of \SpecialChar LaTeX
+ that is run in order to generate the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657047
+.aux
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ file (
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex, pdflatex, platex, xetex, luatex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+).
+ If no value is specified,
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1524657030
+latex
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ is used.
+\change_unchanged
+
\end_layout
\begin_layout Labeling
\begin_layout Standard
The following three flags are not really flags at all because they take
an argument in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
format:
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -712698321 1523206314
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523206193
+hyperref-driver
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ The name of the driver that needs to be loaded with the
+\family sans
+hyperref
+\family default
+ package for this converter.
+ The loading of the correct driver is necessary to get some PDF-specific
+ features.
+ See the
+\family sans
+hyperref
+\family default
+ manual for details.
+\end_layout
+
\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex Code
\end_layout
\begin_layout Standard
-None of these last three are presently used in any of the converters that
- are installed with \SpecialChar LyX
+
+\change_inserted -712698321 1523206384
+A suitable hyperref-driver is set for some converters that are installed
+ with \SpecialChar LyX
+.
+
+\change_deleted -712698321 1523206388
+None of these
+\change_inserted -712698321 1523206389
+The
+\change_unchanged
+ last three
+\change_inserted -712698321 1523206400
+ flags, however,
+\change_unchanged
+ are presently
+\change_inserted -712698321 1523206407
+not
+\change_unchanged
+used in any of the
+\change_inserted -712698321 1523206437
+pre-installed
+\change_unchanged
+converters
+\change_deleted -712698321 1523206442
+ that are installed with \SpecialChar LyX
+
+\change_unchanged
.
\end_layout
\begin_layout Enumerate
Directly, using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
via (DVI and) PostScript, using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
via DVI, using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
directly using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
directly using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
.
For example, in the standard configuration, the formats named
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
),
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
),
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
),
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
), and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
(for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
) are defined, all of which share the extension
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset href
LatexCommand href
name "information on the web"
-target "http://www.lyx.org/HowToUseSVN"
+target "https://www.lyx.org/HowToUseGIT"
+literal "false"
\end_inset
\end_inset
- files, as well.
+ files, as well, see
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
+\end_layout
+
+\end_inset
+
+.
\end_layout
\end_inset
\begin_layout Standard
The online documentation (in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Check out the documentation translation web page at
\begin_inset CommandInset href
LatexCommand href
-name "http://www.lyx.org/Translation"
-target "http://www.lyx.org/Translation"
+name "https://www.lyx.org/Translation"
+target "https://www.lyx.org/Translation"
+literal "false"
\end_inset
\end_inset
(
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
directory.
-\end_layout
+\begin_inset Note Greyedout
+status open
-\begin_layout Itemize
-Sometimes the original document (from the \SpecialChar LyX
- team) will be updated.
- Use the source viewer at
-\begin_inset CommandInset href
-LatexCommand href
-name "http://www.lyx.org/trac/timeline"
-target "http://www.lyx.org/trac/timeline"
+\begin_layout Plain Layout
+\series bold
+Note:
+\series default
+ For a complex document with external material (images, etc.), if you make
+ a copy e.
+\begin_inset space \thinspace{}
\end_inset
- to see what has been changed.
- That way you can easily see which parts of the translated document need
- to be updated.
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-If you ever find an error in the original document, fix it and notify the
- rest of the documentation team of the changes! (You didn't forget to join
- the documentation team, did you?)
+in a temp dir, beware that the links to external material may be broken
+ when the document is moved to a different place.
+ The best way is to retrieve the \SpecialChar LyX
+ tree from git (see
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+https://www.lyx.org/HowToUseGIT
+\end_layout
+
+\end_inset
+
+) and to edit the doc file in place.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+Sometimes the original document (from the \SpecialChar LyX
+ team) will be updated.
+ Use the source viewer at
+\begin_inset CommandInset href
+LatexCommand href
+name "https://www.lyx.org/trac/timeline"
+target "https://www.lyx.org/trac/timeline"
+literal "false"
+
+\end_inset
+
+ to see what has been changed.
+ That way you can easily see which parts of the translated document need
+ to be updated.
+\end_layout
+
+\begin_layout Standard
+If you ever find an error in the original document, fix it and notify the
+ rest of the documentation team of the changes! (You didn't forget to join
+ the documentation team, did you?)
\end_layout
\begin_layout Standard
\begin_inset Branch OutDated
+inverted 0
status collapsed
\begin_layout Section
\begin_layout Standard
An example of a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
statement to cause the symbol
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
to be output for the keystroke
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
Note that a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
\emph default
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
This allows you to press
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
\shape default
in this case cancels the last dead key, so if you press
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For example, in order to map
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
.
You could bind the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
file.
Now, whenever you type the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
never takes a circumflex accent.
Hitting
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Please note this last point! If you bind a key to a dead-key, you'll need
to rebind the character on that key to yet another key.
Binding the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
One common way to bind dead-keys is to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
acts in some ways just like
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
files.
I have my
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
symbolic keys bound such things as
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
key: One of the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
You can edit your preferences so that your desired language environment
is automatically configured when \SpecialChar LyX
starts up, via the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
LatexCommand href
name "CTAN"
target "http://www.ctan.org/"
+literal "false"
\end_inset
\begin_layout Enumerate
Now you need to decide if the package should be available for all users
or only for you.
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
\end_inset
-.
+ or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
+Live
+ distribution.
The location of the `user' \SpecialChar TeX
tree is defined by
\begin_inset Flex Code
$HOME/texmf
\end_layout
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family sans
+$HOME/.texliveXXXX
+\end_layout
+
\end_inset
.
.)
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
Note that this will be the correct path only on English installations.
that there are new files.
This depends on the used \SpecialChar LaTeX
-Distribution:
-\begin_inset Separator parbreak
-\end_inset
-
-
\end_layout
\begin_deeper
that there are new packages available.
So, in \SpecialChar LyX
, use the menu
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-Slides
-\begin_inset space ~
-\end_inset
-
-(FoilTex)
+FoilTex
\end_layout
\end_inset
will now be available under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-.
+ (in the
+\begin_inset Quotes eld
+\end_inset
+
+Presentations
+\begin_inset Quotes erd
+\end_inset
+
+ category).
\end_layout
If you would like to use a \SpecialChar LaTeX
document class that is not even listed in the
menu
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset href
LatexCommand href
name "layout section on the LyX wiki"
-target "http://wiki.lyx.org/Layouts/Layouts"
+target "https://wiki.lyx.org/Layouts/Layouts"
+literal "false"
\end_inset
requires editing that file.
Modules, by contrast, are selected in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
appear in the menu.
However, changes you make to the module will be seen immediately, if you
open
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Any format is acceptable, but one would normally use the format current
at the time.
(In \SpecialChar LyX
- 2.1, the current layout format is 48.) You should be aware that local
- layout is not supported by versions of \SpecialChar LyX
- prior to 1.6, so you should not
- use it if you want to be able to export your document to \SpecialChar LyX
- 1.5 or earlier
- (without, that is, losing the local layout information).
- If you wish to be able to export to 1.6—local layout is supported in 1.6,
- though there is no UI for it—then you should use format 11 and, of course,
- use only layout constructs that were available in \SpecialChar LyX
- 1.6.
+
+\begin_inset Info
+type "lyxinfo"
+arg "version"
+\end_inset
+
+, the current layout format is
+\begin_inset Info
+type "lyxinfo"
+arg "layoutformat"
+\end_inset
+
+.)
\end_layout
\begin_layout Standard
\begin_layout Subsection
Layout for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Supporting a style file is usually fairly easy.
Supporting a new class file is a bit harder.
We'll discuss the former in this section and the latter in the next.
- Similar remarks apply, of course, if you want to support a new DocBook
- DTD.
+
+\change_deleted 5863208 1594239023
+Similar remarks apply, of course, if you want to support a new DocBook DTD.
+\change_unchanged
+
\end_layout
\begin_layout Standard
document class.
For the sake of the example, we'll assume that the style file is called
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and that it is meant to be used with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout LyX-Code
\backslash
-Declare\SpecialChar LaTeX
-Class{report}
+DeclareLaTeXClass{Report (Standard Class)}
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
\backslash
-Declare\SpecialChar LaTeX
-Class[report, myclass.sty]{report (myclass)}
+DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
\end_layout
\begin_layout Standard
\begin_layout Standard
Start \SpecialChar LyX
and select
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Then restart \SpecialChar LyX
and try creating a new document.
You should see "
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-report (myclass)
+Report (My Class)
\end_layout
\end_inset
" as a document class option in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
If
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout LyX-Code
#
\backslash
-DeclareLyXModule{My Package}
+DeclareLyXModule{My Class}
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-#Support for mypkg.sty.
+#Support for myclass.sty.
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Format 35
+Format
+\begin_inset Info
+type "lyxinfo"
+arg "layoutformat"
+\end_inset
+
+
\begin_inset Newline newline
\end_inset
\backslash
-usepackage{mypkg}
+usepackage{myclass}
\begin_inset Newline newline
\end_inset
\begin_layout Subsection
Layout for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
There are two possibilities here.
One is that the class file is itself based upon an existing document class.
For example, many thesis classes are based upon
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout LyX-Code
\backslash
-Declare\SpecialChar LaTeX
-Class[thesis,book]{thesis}
+DeclareLaTeXClass[thesis,book]{thesis}
\end_layout
\begin_layout Standard
\end_inset
to the same place, and redefine the template path in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Note, by the way, that there is a template which has a particular meaning:
-
+\begin_inset Newline linebreak
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
.
This template is loaded every time you create a new document with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
To create this template from inside \SpecialChar LyX
, all you have to do is to open a document
with the correct settings, and use the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
have to be converted separately.
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Cite-Engine-Files"
+
+\end_inset
+
+Cite engine files
+\end_layout
+
+\begin_layout Standard
+A specific form of layout files are the so-called
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files that are located in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+citeengines/
+\end_layout
+
+\end_inset
+
+ sub-directory.
+ Their purpose is to define the specifics of \SpecialChar LaTeX
+ packages aimed at bibliography
+ generation, such as
+\family sans
+natbib
+\family default
+,
+\family sans
+ jurabib
+\family default
+ or
+\family sans
+biblatex
+\family default
+, but also the way how normal Bib\SpecialChar TeX
+ citations (without additional packages)
+ are handled in \SpecialChar LyX
+ is defined in such a file.
+
+\end_layout
+
+\begin_layout Standard
+More specifically, it is defined which packages \SpecialChar LyX
+ needs to load, which citation
+ commands are available, how these are to be displayed in \SpecialChar LyX
+ (in the workarea,
+ the dialogs, the context menus) as well as in the XHTML and plain text
+ output.
+ Furthermore, the files specify available style variants (author-year, numerical
+, etc.) and their specifics.
+ The cite engine files are also used to generate the options that are available
+ in
+\family sans
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography\SpecialChar menuseparator
+Style engine
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+Even though a cite engine file is essentially a normal layout file that
+ could theoretically include any layout information, it usually primarily
+ includes some specific parameters such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFramework
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks.
+ The syntax of the latter two is described in
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ and
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-format-description"
+
+\end_inset
+
+, as well as in the files themselves.
+\end_layout
+
\begin_layout Section
\begin_inset CommandInset label
LatexCommand label
\end_inset
that appears above is used as a description of the text class in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
in the example) is also used in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
package.
- Finally, it is also possible to declare classes for DocBook code.
+
+\change_deleted 5863208 1594239179
+Finally, it is also possible to declare classes for DocBook code.
Typical declarations will look like:
\end_layout
\begin_layout LyX-Code
+\change_deleted 5863208 1594239179
+
\size small
#% Do not delete the line below; configure depends on this
\end_layout
\begin_layout LyX-Code
+\change_deleted 5863208 1594239179
+
\size small
#
\backslash
\begin_layout LyX-Code
+\change_deleted 5863208 1594239179
+
\size small
#
\backslash
DeclareCategory{Articles (DocBook)}
+\change_unchanged
+
\end_layout
\begin_layout Standard
\end_inset
, run
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Once the layout file is installed, you can edit it and see your changes
without having to reconfigure or to restart \SpecialChar LyX
.
-
\begin_inset Foot
status collapsed
You can force a reload of the current layout by using the \SpecialChar LyX
function
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Warning
\emph default
:
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout LyX-Code
#
\backslash
-DeclareLyXModule[endnotes.sty]{Endnotes}
+DeclareLyXModule[endnotes.sty]{Endnotes}
+\change_inserted -712698321 1554395911
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -712698321 1554395924
+
+\size small
+#
+\backslash
+DeclareCategory{Foot- and Endnotes}
+\change_deleted -712698321 1554395911
+
+\size default
+
+\change_unchanged
+
\end_layout
\begin_layout Standard
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
-\begin_inset Flex MenuItem
+The mandatory argument
+\change_inserted -712698321 1554395956
+ of
+\family typewriter
+
+\backslash
+DeclareLyXModule
+\change_unchanged
+
+\family default
+, in curly brackets, is the name of the module, as it should appear in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
packages
on which the module depends.
It is also possible to use the form
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
'.
+
+\change_inserted -712698321 1554396133
+ The
+\family typewriter
+
+\backslash
+DeclareCategory
+\family default
+ declaration is not strictly mandatory, but you should add it, since it
+ is helpful to find the module.
+ Please have a look at the existing module categories and if appropriate,
+ use one of those.
+\change_unchanged
+
\end_layout
\begin_layout Standard
-The module declaration should then be followed by lines like the following
+The module
+\change_inserted -712698321 1554395988
+and category
+\change_unchanged
+declaration should then be followed by lines like the following:
\begin_inset Foot
status collapsed
\end_inset
-:
+
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
The description is used in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Subsection
-Format number
+The CiteEngine file declaration
\end_layout
\begin_layout Standard
-The first non-comment line of any layout file, included file, or module
-
-\emph on
-must
-\emph default
- contain the file format number:
+A cite engine file must begin with a line like the following:
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
+\begin_layout LyX-Code
+#
+\backslash
+DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
+\end_layout
+
+\begin_layout Standard
+The mandatory argument, in curly brackets, is the name of the cite style,
+ as it should appear in
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Format
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+.
+ The argument in square brackets is optional: It declares any \SpecialChar LaTeX
+ packages
+ on which the cite engine depends.
+\end_layout
+
+\begin_layout Standard
+The cite engine declaration should then be followed by lines like the following:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-int
+Preferably in English if the module should be published with \SpecialChar LyX
+.
+ This description will appear in the list of messages to be translated and
+ will be thus translated with the next interface update.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout LyX-Code
+# DescriptionBegin
+\end_layout
+
+\begin_layout LyX-Code
+# Biblatex supports many author-year and numerical styles.
+\end_layout
+
+\begin_layout LyX-Code
+# It is mainly aimed at the Humanities.
+ It is highly
+\end_layout
+
+\begin_layout LyX-Code
+# customizable, fully localized and provides many features
+\end_layout
+
+\begin_layout LyX-Code
+# that are not possible with BibTeX.
+ The use of 'biber' as
+\end_layout
+
+\begin_layout LyX-Code
+# bibliography processor is advised.
+\end_layout
+
+\begin_layout LyX-Code
+# DescriptionEnd
+\end_layout
+
+\begin_layout Standard
+The description is used in
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bibliography
+\end_layout
+
+\end_inset
+
+ to provide the user with information about the cite engine.
+\end_layout
+
+\begin_layout Subsection
+Format number
+\end_layout
+
+\begin_layout Standard
+The first non-comment line of any layout file, included file, or module
+
+\emph on
+must
+\emph default
+ contain the file format number:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int
\end_layout
\end_inset
.
The format for the present version of \SpecialChar LyX
- is format 35.
+ is format 60.
But each version of \SpecialChar LyX
is capable of reading earlier versions' layout files,
just as they are capable of reading files produced by earlier versions
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1526899478
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
-\end_layout
-
-\end_inset
- Adds information that will be output in the
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1526898610
+AddToCiteEngine <engine>
+\change_unchanged
-\begin_layout Plain Layout
-<head>
\end_layout
\end_inset
- 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
-status collapsed
-
-\begin_layout Plain Layout
-<head>
-\end_layout
+ Extends the possibilities for displaying citation references.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
-.
+ for details.
Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
-\end_layout
-\end_inset
+\change_inserted -712698321 1526898823
+End
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+AddToHTMLPreamble
\end_layout
\end_inset
- Adds information to the document preamble.
- Must end with
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
+ Adds information that will be output in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+<head>
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+ 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
status collapsed
\begin_layout Plain Layout
-CiteFormat
+<head>
\end_layout
\end_inset
- Defines formats for use in the display of bibliographic information.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Citation-format-description"
-
-\end_inset
-
- for details.
+.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+EndPreamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-ClassOptions
+AddToPreamble
\end_layout
\end_inset
- Describes various global options supported by the document class.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:ClassOptions"
-
+ Adds information to the document preamble.
+ Must end with
+\begin_inset Newline newline
\end_inset
- for a description.
- Must end with
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+EndPreamble
\end_layout
\end_inset
\end_inset
.
+\change_inserted -712698321 1562592950
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1562593040
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Columns
+
+\change_inserted -712698321 1562592954
+BibInToc
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -712698321 1562592950
+
\emph on
-1
+0
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-2
+
+\change_inserted -712698321 1562592950
+1
+\change_unchanged
+
\end_layout
\end_inset
-] Whether the class should
-\emph on
-default
-\emph default
- to having one or two columns.
- Can be changed in the
-\begin_inset Flex MenuItem
+] If the document class adds the bibliography to the table of contents,
+ add this option with value
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
-\end_layout
-\end_inset
+\change_inserted -712698321 1562592996
+1
+\change_unchanged
- dialog.
\end_layout
-\begin_layout Description
+\end_inset
+
+ (or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+
+\change_inserted -712698321 1562593006
+true
+\change_unchanged
+
\end_layout
\end_inset
- [
+).
+ This prevents the bibliography from being added twice.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+CiteEngine <engine>
\end_layout
\end_inset
-] This sequence defines the properties for a counter.
- If the counter does not yet exist, it is created; if it does exist, it
- is modified.
+ Defines the possibilities for displaying citation references.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-engine-description"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+ for details.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
-\begin_inset Newline newline
-\end_inset
-
-See
+ Primarily used in cite engine files (see
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Counters"
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
- for details on counters.
+).
+
+\change_inserted -712698321 1526898530
+ Note that if you specify this in a layout file or module, any cite engine
+ definition will be overridden.
+ Also see
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898530
+AddToCiteEngine
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-DefaultFont
+CiteFormat
\end_layout
\end_inset
- Sets the default font used to display the document.
+ Defines formats for use in the display of bibliographic information.
See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Font-description"
+reference "subsec:Citation-format-description"
\end_inset
- for how to declare fonts.
+ for details.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndFont
+End
\end_layout
\end_inset
\end_inset
.
-\end_layout
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
-\begin_layout Description
-\begin_inset Flex Code
+\end_inset
+
+).
+
+\change_inserted -712698321 1526898585
+ A cite format defined in a layout or module will override the cite engine
+ definition.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultModule
+CiteFramework
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<module>
+
+\emph on
+bibtex
\end_layout
\end_inset
-] 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
\begin_layout Plain Layout
-.module
+biblatex
\end_layout
\end_inset
- extension.
- The user can still remove the module, but it will be active at the outset.
- (This applies only when new files are created, or when this class is chosen
- for an existing document.)
+] Determines whether
+\family sans
+Biblatex
+\family default
+ or Bib\SpecialChar TeX
+ is used to generate a Bibliography.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+ClassOptions
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+ Describes various global options supported by the document class.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:ClassOptions"
-\begin_layout Plain Layout
-<style>
-\end_layout
+\end_inset
+ for a description.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex MenuItem
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+End
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
- This will default to the first defined style if not given, but you are
- encouraged to use this directive.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ExcludesModule
+Columns
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<module>
+
+\emph on
+1
\end_layout
\end_inset
-] This tag indicates that the module (which is specified by filename without
- the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-.module
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
- 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
status collapsed
\begin_layout Plain Layout
-theorems-sec
+2
\end_layout
\end_inset
- module that numbers theorems by section.
- This tag may
+] Whether the class should
\emph on
-not
+default
\emph default
- be used in a module.
- Modules have their own way of excluding other modules (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Layout-modules"
+ to having one or two columns.
+ Can be changed in the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
+\end_layout
\end_inset
-).
+ dialog.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Float
+Counter
\end_layout
\end_inset
- Defines a new float.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Floats"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
\end_inset
- for details.
+] This sequence defines the properties for a counter.
+ If the counter does not yet exist, it is created; if it does exist, it
+ is modified.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
+\begin_inset Newline newline
+\end_inset
+
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+ for details on counters.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+DefaultFont
\end_layout
\end_inset
- Sets the information that will be output in the
-\begin_inset Flex Code
-status collapsed
+ Sets the default font used to display the document.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-\begin_layout Plain Layout
-<head>
-\end_layout
+\end_inset
+ for how to declare fonts.
+ Must end with
+\begin_inset Quotes eld
\end_inset
- block when this document class is output to XHTML.
- Note that this will completely override any prior
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+EndFont
\end_layout
\end_inset
- or
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+DefaultModule
\end_layout
\end_inset
- declarations.
- (Use
-\begin_inset Newline newline
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+<module>
\end_layout
\end_inset
- if you just want to add material to the preamble.) Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+] 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
\begin_layout Plain Layout
-EndPreamble
+.module
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ extension.
+ The user can still remove the module, but it will be active at the outset.
+ (This applies only when new files are created, or when this class is chosen
+ for an existing document.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTOCSection
+DefaultStyle
\end_layout
\end_inset
\end_inset
-] 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
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Section
-\end_layout
-
-\end_inset
-
-; for books
-\begin_inset Flex Code
+] This is the style that will be assigned to new paragraphs, usually
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Chapter
+Standard
\end_layout
\end_inset
.
- If it is not given, then \SpecialChar LyX
- will attempt to figure out which layout to use.
+ This will default to the first defined style if not given, but you are
+ encouraged to use this directive.
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515112870
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-IfCounter
+
+\change_inserted -970929547 1515112782
+DocBookRoot
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<counter>
+
+\change_inserted -970929547 1515112766
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Modifies the properties of the given counter.
- If the counter does not exist, the statement is ignored.
- Must end with
+] The root element (at the top of the document) to use when outputting documents
+ with this class in DocBook.
+ The default value is
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+
+\change_inserted -970929547 1515112845
+article
+\change_unchanged
+
\end_layout
\end_inset
\end_inset
.
-\begin_inset Newline newline
-\end_inset
-
-See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Counters"
-\end_inset
+\change_deleted 1075283030 1594226862
+
+\change_inserted 1075283030 1594226777
- for details on counters.
\end_layout
\begin_layout Description
+
+\change_inserted 1075283030 1594226859
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-IfStyle
+
+\change_inserted 1075283030 1594226785
+DocBookForceAbstract
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<style>
+
+\change_inserted 1075283030 1594226804
+boolean
+\change_unchanged
+
\end_layout
\end_inset
-] Modifies the properties of the given paragraph style.
- If the style does not exist, the statement is ignored.
- Must end with
+] If
\begin_inset Quotes eld
\end_inset
-\begin_inset Flex Code
-status collapsed
+\family typewriter
+true
+\family default
-\begin_layout Plain Layout
-End
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+, the root element will always have an
+\family typewriter
+<abstract>
+\family default
+ tag.
+ The default value is
+\begin_inset Quotes eld
\end_inset
+\family typewriter
+false
+\family default
+
\begin_inset Quotes erd
\end_inset
.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Input
+ExcludesModule
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<filename>
+<module>
\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,
+] This tag indicates that the module (which is specified by filename without
+ the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdclass.inc
+.module
\end_layout
\end_inset
-, which contains most of the basic layouts.
-\end_layout
-
-\begin_layout Description
+ 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
status collapsed
\begin_layout Plain Layout
-InsetLayout
+theorems-sec
\end_layout
\end_inset
- [
+ module that numbers theorems by section.
+ This tag may
+\emph on
+not
+\emph default
+ be used in a module.
+ Modules have their own way of excluding other modules (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Layout-modules"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<type>
+Float
\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.
+ Defines a new float.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Floats"
+
+\end_inset
+
+ for details.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
-\begin_inset Newline newline
-\end_inset
-
-See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Flex-insets-and"
-
-\end_inset
-
- for more information.
-
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LeftMargin
+HTMLPreamble
\end_layout
\end_inset
- [
+ Sets the information that will be output in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+<head>
\end_layout
\end_inset
-] A string that indicates the width of the left margin on the screen, for
- example,
-\begin_inset Quotes eld
-\end_inset
-
-
+ block when this document class is output to XHTML.
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MMMMM
+HTMLPreamble
\end_layout
\end_inset
+ or
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\end_layout
-.
- (Note that this is not a `length', like
-\begin_inset Quotes eld
\end_inset
-2ex
-\begin_inset Quotes erd
+ declarations.
+ (Use
+\begin_inset Newline newline
\end_inset
-.)
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoCounter
+AddToHTMLPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<counter>
-\end_layout
-
+ if you just want to add material to the preamble.) Must end with
+\begin_inset Quotes eld
\end_inset
-] Deletes an existing counter, usually one defined in an included file.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoFloat
+EndPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<float>
-\end_layout
+\begin_inset Quotes erd
\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
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NoStyle
+HTMLTOCSection
\end_layout
\end_inset
\end_inset
-] Deletes an existing style.
-\end_layout
-
-\begin_layout Description
+] 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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputFormat
+Section
\end_layout
\end_inset
- [
+; for books
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<format>
+Chapter
\end_layout
\end_inset
-] The file format (as defined in the \SpecialChar LyX
- preferences) produced by this document
- class.
- It is mainly useful when
+.
+ If it is not given, then \SpecialChar LyX
+ will attempt to figure out which layout to use.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+IfCounter
\end_layout
\end_inset
- is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-literate
+<counter>
\end_layout
\end_inset
- and one wants to define a new type of literate document.
- The format is reset to
+] Modifies the properties of the given counter.
+ 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
-docbook
+End
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- or
-\begin_inset Quotes eld
+.
+\begin_inset Newline newline
\end_inset
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+ for details on counters.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex
+Input
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<filename>
+\end_layout
-\begin_inset Quotes erd
\end_inset
- when the corresponding
+] 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
\begin_layout Plain Layout
-OutputType
+stdclass.inc
\end_layout
\end_inset
- parameter is encountered.
+, which contains most of the basic layouts.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-OutputType
+InsetLayout
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-lat
-\emph default
-ex
+<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
-docbook
+End
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-literate
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Flex-insets-and"
\end_inset
-] Specifies what sort of output documents using this class will produce.
+ for more information.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PackageOptions
+LeftMargin
\end_layout
\end_inset
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
-\end_layout
-
-\end_inset
-
-] Specifies options, given in the second string, for the package named by
- the first string.
- For example,
+] A string that indicates the width of the left margin on the screen, for
+ example,
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-PackageOptions natbib square
+MMMMM
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- will cause
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-natbib
-\end_layout
+.
+ (Note that this is not a `length', like
+\begin_inset Quotes eld
+\end_inset
+2ex
+\begin_inset Quotes erd
\end_inset
- to be loaded with the
+.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-square
+MaxCiteNames
\end_layout
\end_inset
- option.
- (For \SpecialChar TeX
-perts, this causes \SpecialChar LyX
- to output:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-PassOptionsToPackage{natbib}{square}
+integer
\end_layout
\end_inset
- prior to loading
-\begin_inset Flex Code
-status collapsed
+] An integer that determines the maximal number of names displayed in an
+ author-year citation before the citation switches to
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-natbib
-\end_layout
+FirstAuthor et al.
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Primarily used in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
\end_inset
-.)
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PageStyle
+ModifyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-plain
+<style>
\end_layout
\end_inset
-,
+] Modifies the properties of the given paragraph style.
+ If the style does not exist, this section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-empty
+End
\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
-headings
+NoCounter
\end_layout
\end_inset
-] The default pagestyle.
- Can be changed in the
-\begin_inset Flex MenuItem
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar menuseparator
-Settings
+<counter>
\end_layout
\end_inset
- dialog.
+] Deletes an existing counter, usually one defined in an included file.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Preamble
+NoFloat
\end_layout
\end_inset
- Sets the preamble for the \SpecialChar LaTeX
- document.
- Note that this will completely override any prior
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+<float>
\end_layout
\end_inset
- or
+] 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
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+NoStyle
\end_layout
\end_inset
- declarations.
- (Use
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+<style>
\end_layout
\end_inset
- if you just want to add material to the preamble.) Must end with
-\begin_inset Quotes eld
-\end_inset
-
+] Deletes an existing style.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+OutlinerName
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+<type>
\end_layout
-\begin_layout Description
+\end_inset
+
+] [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+<string>
\end_layout
\end_inset
- [
+] Define a new table of contents with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+<type>
\end_layout
\end_inset
-] [
+ and name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<string>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+.
+ See also the AddToToc commands.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+OutputFormat
\end_layout
\end_inset
-] Whether the class already provides the feature
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+<format>
\end_layout
\end_inset
-.
- A feature is in general the name of a package (e.
-\begin_inset space \thinspace{}
-\end_inset
+] The file format (as defined in the \SpecialChar LyX
+ preferences) produced by this document
+ class.
+ It is mainly useful when
+\begin_inset Flex Code
+status collapsed
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Plain Layout
+OutputType
+\end_layout
+\end_inset
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-amsmath
+literate
\end_layout
\end_inset
- or
+ and one wants to define a new type of literate document.
+ The format is reset to
+\change_deleted 5863208 1594239413
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-makeidx
+docbook
\end_layout
\end_inset
-) or a macro (e.
-\begin_inset space \thinspace{}
+
+\begin_inset Quotes erd
\end_inset
-g.
-\begin_inset space \space{}
+ or
+\change_unchanged
+
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-url
+latex
\end_layout
\end_inset
- or
+
+\begin_inset Quotes erd
+\end_inset
+
+ when the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-boldsymbol
+OutputType
\end_layout
\end_inset
-).
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:List-of-functions"
-
-\end_inset
-
- for the list of features.
+ parameter is encountered.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ProvidesModule
+OutputType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+lat
+\emph default
+ex
\end_layout
\end_inset
-] Indicates that this layout provides the functionality of the module mentioned,
- which should be specified by the filename without the
+,
+\change_deleted 5863208 1594239430
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.module
+docbook
\end_layout
\end_inset
- extension.
- This will typically be used if the layout includes the module directly,
- rather than using the
+,
+\change_unchanged
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultModule
+literate
\end_layout
\end_inset
- tag to indicate that it ought to be used.
- It could also be used in a module that provided an alternate implementation
- of the same functionality.
+] Specifies what sort of output documents using this class will produce.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Requires
+PackageOptions
\end_layout
\end_inset
\end_inset
-] Whether the class requires the feature
+
\begin_inset Flex Code
status collapsed
\end_inset
-.
- Multiple features must be separated by commas.
- Note that you can only request supported features.
- (See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:List-of-functions"
-
-\end_inset
-
- for the list of features.)
-\change_inserted -712698321 1438601536
-.
- If you require a package with specific options, you can additionally use
-
+] Specifies options, given in the second string, for the package named by
+ the first string.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1438601526
-PackageOptions
+PackageOptions natbib square
\end_layout
\end_inset
-.
-\change_unchanged
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
+ will cause
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+natbib
\end_layout
\end_inset
- [
+ to be loaded with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+square
\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
-
-
+ option.
+ (For \SpecialChar TeX
+perts, this causes \SpecialChar LyX
+ to output:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MMMMM
+
+\backslash
+PassOptionsToPackage{natbib}{square}
\end_layout
\end_inset
+ prior to loading
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+.)
+\change_inserted -712698321 1565102364
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1565102470
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SecNumDepth
+
+\change_inserted -712698321 1565102365
+PageSize
+\change_unchanged
+
\end_layout
\end_inset
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
+\change_inserted -712698321 1565105222
-\begin_inset Flex Code
-status collapsed
+\emph on
+custom
+\emph default
+, letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
+ b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
+\change_unchanged
-\begin_layout Plain Layout
-secnumdepth
\end_layout
\end_inset
- counter in \SpecialChar LaTeX
-.
+] The default page size.
+ This is used by some converters.
+\change_unchanged
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Sides
+PageStyle
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-1
+plain
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+empty
+\end_layout
+\end_inset
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-2
+headings
\end_layout
\end_inset
-] Whether the class-default should be printing on one or both sides of the
- paper.
+] The default pagestyle.
Can be changed in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-Style
+Preamble
\end_layout
\end_inset
- [
+ Sets the preamble for the \SpecialChar LaTeX
+ document.
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+Preamble
\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
-\begin_inset Quotes eld
-\end_inset
-
-
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+AddToPreamble
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\begin_inset Newline newline
-\end_inset
-
-See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
- for details on paragraph styles.
-\end_layout
-
-\begin_layout Description
+ declarations.
+ (Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+AddToPreamble
\end_layout
\end_inset
- [
+ if you just want to add material to the preamble.) Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+EndPreamble
\end_layout
\end_inset
-] The name of the command or environment to be used with
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-TitleLatexType
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+Provides
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-CommandAfter
+string
\end_layout
\end_inset
-,
+] [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\emph on
+0
\end_layout
\end_inset
-] Indicates what kind of markup is used to define the title of a document.
-
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandAfter
+1
\end_layout
\end_inset
- means that the macro with name
+] Whether the class already provides the feature
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+string
\end_layout
\end_inset
- will be inserted after the last layout which has
-\begin_inset Quotes eld
+.
+ A feature is in general the name of a package (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
\end_inset
status collapsed
\begin_layout Plain Layout
-InTitle
-\begin_inset space ~
-\end_inset
-
-1
+amsmath
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+makeidx
\end_layout
\end_inset
- corresponds to the case where all layouts which have
-\begin_inset Quotes eld
+) or a macro (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
\end_inset
status collapsed
\begin_layout Plain Layout
-InTitle
-\begin_inset space ~
-\end_inset
-
-1
+url
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- should be enclosed into the
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+boldsymbol
\end_layout
\end_inset
- environment.
+).
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
+
+\end_inset
+
+ for the list of features.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TocDepth
+ProvidesModule
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=3
+string
\end_layout
\end_inset
-] Sets which divisions are included in the table of contents.
- Corresponds to the
+] Indicates that this layout provides the functionality of the module mentioned,
+ which should be specified by the filename without the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tocdepth
+.module
\end_layout
\end_inset
- counter in \SpecialChar LaTeX
-.
-\end_layout
-
-\begin_layout Subsection
+ extension.
+ This will typically be used if the layout includes the module directly,
+ rather than using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+DefaultModule
\end_layout
\end_inset
- section
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:ClassOptions"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-ClassOptions
-\end_layout
-
-\end_inset
-
- section can contain the following entries:
+ tag to indicate that it ought to be used.
+ It could also be used in a module that provided an alternate implementation
+ of the same functionality.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-FontSize
+ProvideStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="10|11|12"
+<style>
\end_layout
\end_inset
-] The list of available font sizes for the document's main font, separated
- by
+] Creates a new paragraph style if it does not already exist.
+ If the style does exist, this section is ignored.
+ Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-|
+End
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Header
+Requires
\end_layout
\end_inset
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
\end_inset
-g.: PUBLIC
-\begin_inset Quotes eld
+] Whether the class requires the feature
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
\end_inset
--//OASIS//DTD DocBook V4.2//EN
-\begin_inset Quotes erd
+.
+ Multiple features must be separated by commas.
+ Note that you can only request supported features.
+ (See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
+
+\end_inset
+
+ for the list of features.).
+ If you require a package with specific options, you can additionally use
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PackageOptions
+\end_layout
+
\end_inset
.
status collapsed
\begin_layout Plain Layout
-PageStyle
+RightMargin
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="empty|plain|headings|fancy"
+string
\end_layout
\end_inset
-] The list of available page sty\SpecialChar softhyphen
-les, separated by
+] A string that indicates the width of the right margin on the screen, for
+ example,
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-|
+MMMMM
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Other
+SecNumDepth
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+int=3
\end_layout
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
+] Sets which divisions get numbered.
+ Corresponds to the
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-documentclass
+secnumdepth
\end_layout
\end_inset
- command.
+ counter in \SpecialChar LaTeX
+.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+Sides
\end_layout
\end_inset
- section 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
-.
+\emph on
+1
\end_layout
-\begin_layout Subsection
-Paragraph styles
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Paragraph-Styles"
-
\end_inset
+,
+\begin_inset space \thinspace{}
+\end_inset
-\end_layout
-\begin_layout Standard
-A paragraph style description looks like this:
-\begin_inset Foot
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new style or modify an existing one.
+2
\end_layout
\end_inset
+] Whether the class-default should be printing on one or both sides of the
+ paper.
+ Can be changed in the
+\begin_inset Flex Noun
+status collapsed
+\begin_layout Plain Layout
+Document\SpecialChar menuseparator
+Settings
\end_layout
-\begin_layout LyX-Code
-Style
-\family roman
-\emph on
-name
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-End
-\end_layout
+\end_inset
-\begin_layout Standard
-where the following commands are allowed:
+ dialog.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Align
+Style
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-block
-\emph default
-, left, right, center
+<name>
\end_layout
\end_inset
-] Paragraph alignment.
-\end_layout
+] 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
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AlignPossible
+End
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
+\begin_inset Quotes erd
+\end_inset
-\emph on
-block
-\emph default
-, left, right, center
-\end_layout
+.
+\begin_inset Newline newline
+\end_inset
+
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
\end_inset
-] A comma separated list of permitted alignments.
- (Some \SpecialChar LaTeX
- styles prohibit certain alignments, since those wouldn't make sense.
- For example a right-aligned or centered enumeration isn't possible.)
+ for details on paragraph styles.
+\change_inserted -712698321 1553617804
+
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1553617862
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+
+\change_inserted -712698321 1553617809
+TableStyle
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int
+
+\change_inserted -712698321 1553617805
+<name>
+\change_unchanged
+
\end_layout
\end_inset
-] Defines argument number <int> of a command\SpecialChar breakableslash
-environment associated with
- the current style.
- This is useful for things like section headings, and only makes sense with
- \SpecialChar 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
+] defines the default table style that is used when inserting a table.
+ The following styles are available:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\change_inserted -712698321 1554308039
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndArgument
+
+\change_inserted -712698321 1554307928
+Formal_with_Footline
+\change_unchanged
+
\end_layout
\end_inset
-.
- So a command with two optional arguments has:
-\begin_inset Separator parbreak
+: formal (
+\begin_inset Quotes eld
\end_inset
+booktabs
+\begin_inset Quotes erd
+\end_inset
+) style with horizontal lines only, using a bold top and bottom line, the
+ first and last row are additionally separated from the table body with
+ a thin middle line.
\end_layout
-\begin_deeper
-\begin_layout Quote
+\begin_layout Itemize
-\family typewriter
-Argument 1
-\end_layout
-
-\begin_layout Quote
-
-\family typewriter
-...
-\end_layout
-
-\begin_layout Quote
+\change_inserted -712698321 1554308087
+\begin_inset Flex Code
+status collapsed
-\family typewriter
-EndArgument
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Quote
+\change_inserted -712698321 1554308042
+Formal_without_Footline
+\change_unchanged
-\family typewriter
-Argument 2
\end_layout
-\begin_layout Quote
+\end_inset
-\family typewriter
-...
+: same as the above, but the last row is not separated with a middle line
+ from the body.
\end_layout
-\begin_layout Quote
-
-\family typewriter
-EndArgument
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Inside the
+\change_inserted -712698321 1553618031
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+
+\change_inserted -712698321 1553618006
+Simple_Grid
+\change_unchanged
+
\end_layout
\end_inset
- definition, the following specifications are possible:
+: Simple table lines.
\end_layout
\begin_layout Itemize
+
+\change_inserted -712698321 1553618309
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
-\end_layout
-
-\end_inset
-
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1553618031
+Grid_with_Head
+\change_unchanged
-\begin_layout Plain Layout
-[string]
\end_layout
\end_inset
- 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
+: Like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MenuString
-\end_layout
-
-\end_inset
-
-).
- 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
+\change_inserted -712698321 1553618043
+Simple_Grid
+\change_unchanged
- (e.
-\begin_inset space \thinspace{}
-\end_inset
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
+, but with the header column offset with a second horizontal line.
+ This is also the default style of \SpecialChar LyX
+.
+\end_layout
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Itemize
+\change_inserted -712698321 1553618280
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Short Title|S
-\end_layout
-\end_inset
+\change_inserted -712698321 1553618261
+No_Borders
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-).
+: Table without lines.
+\change_unchanged
+
\end_layout
-\begin_layout Itemize
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MenuString
+TitleLatexName
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+string="maketitle"
\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
-
-|
-\begin_inset Quotes erd
-\end_inset
-
- (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
-\begin_inset Quotes eld
-\end_inset
-
-
+] The name of the command or environment to be used with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Short Title|S
+TitleLatexType
\end_layout
\end_inset
+.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-).
- This specification is optional.
- If it is not given the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+TitleLatexType
\end_layout
\end_inset
- will be used instead for the menu.
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tooltip
+
+\emph on
+CommandAfter
\end_layout
\end_inset
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+Environment
\end_layout
\end_inset
- A longer explanatory text that appears in the tooltip when hovering over
- the argument inset.
-\end_layout
-
-\begin_layout Itemize
+] Indicates what kind of markup is used to define the title of a document.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Mandatory
+CommandAfter
\end_layout
\end_inset
- [
+ means that the macro with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+TitleLatexName
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+ will be inserted after the last layout which has
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
+InTitle
+\begin_inset space ~
+\end_inset
+
1
\end_layout
\end_inset
-] Declare if this is a mandatory (1) or an optional (0) 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
-{...}
-\end_layout
+\begin_inset Quotes erd
\end_inset
-, while optional arguments are delimited by
+.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[...]
+Environment
\end_layout
\end_inset
+ corresponds to the case where all layouts which have
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
\end_layout
\end_inset
-
+
+\begin_inset Quotes erd
+\end_inset
+
+ should be enclosed into the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[int=0]
+TitleLatexName
\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
+ environment.
+\end_layout
-g., in \SpecialChar LaTeX
- commands, optional arguments often require previous optional arguments
- to be output (at least empty), as in
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-command[][argument]{text}
+TocDepth
\end_layout
\end_inset
-.
- This can be achieved by the statement
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires 1
+int=3
\end_layout
\end_inset
- within
+] Sets which divisions are included in the table of contents.
+ Corresponds to the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument 2
+tocdepth
\end_layout
\end_inset
+ counter in \SpecialChar LaTeX
.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftDelim
+ClassOptions
\end_layout
\end_inset
-
+ section
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:ClassOptions"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+ClassOptions
\end_layout
\end_inset
- defines a custom left delimiter (instead of
+ section can contain the following entries:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{
+FontSize
\end_layout
\end_inset
- or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[
+string="10|11|12"
\end_layout
\end_inset
-).
- A line break in the output can be indicated by
+] The list of available font sizes for the document's main font, separated
+ by
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+|
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-RightDelim
+.
+
+\change_inserted -712698321 1565110196
+ Any number is possible.
\end_layout
-\end_inset
+\begin_layout Description
-
+\change_inserted -712698321 1565110259
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+
+\change_inserted -712698321 1565110199
+FontSizeFormat
+\change_unchanged
+
\end_layout
\end_inset
- defines a custom right delimiter (instead of
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-}
+
+\change_inserted -712698321 1565110196
+string
+\change_unchanged
+
\end_layout
\end_inset
- or
+] The format for the font size option.
+ Default:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-]
+
+\change_inserted -712698321 1565110238
+$$spt
+\change_unchanged
+
\end_layout
\end_inset
-).
- A line break in the output can be indicated by
+.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
-\end_layout
-\end_inset
+\change_inserted -712698321 1565110248
+$$s
+\change_unchanged
-.
\end_layout
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+\end_inset
+
+ is a placeholder for the font size.
+\change_unchanged
-\begin_layout Plain Layout
-DefaultArg
\end_layout
-\end_inset
+\begin_layout Description
-
+\change_deleted 5863208 1594239483
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+Header
\end_layout
\end_inset
- defines an argument that is inserted if and only if no user-specified arguments
- were given, i.
+ Used to set the DTD line with XML-based output classes.
+ E.
\begin_inset space \thinspace{}
\end_inset
-e.
-\begin_inset space \space{}
+g.: PUBLIC
+\begin_inset Quotes eld
\end_inset
-if no argument inset has been inserted (note that also an empty argument
- inset omits the DefaultArg).
- Multiple arguments need to be separated by comma.
-\end_layout
+-//OASIS//DTD DocBook V4.2//EN
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-\begin_inset Flex Code
-status collapsed
+.
+\change_inserted -712698321 1565101761
-\begin_layout Plain Layout
-PresetArg
\end_layout
-\end_inset
+\begin_layout Description
-
+\change_inserted -712698321 1565180598
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
-\end_layout
-\end_inset
+\change_inserted -712698321 1565101918
+PageSize
+\change_unchanged
- 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.
\end_layout
-\begin_layout Itemize
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\change_inserted -712698321 1565105399
+string="letter|\SpecialChar allowbreak
+legal|\SpecialChar allowbreak
+executive|\SpecialChar allowbreak
+a0|\SpecialChar allowbreak
+a1|\SpecialChar allowbreak
+a2|\SpecialChar allowbreak
+a3|\SpecialChar allowbreak
+a4|\SpecialChar allowbreak
+a5|\SpecialChar allowbreak
+a6|\SpecialChar allowbreak
+b0|\SpecialChar allowbreak
+b1|\SpecialChar allowbreak
+b2|\SpecialChar allowbreak
+b3|\SpecialChar allowbreak
+b4|\SpecialChar allowbreak
+b5|\SpecialChar allowbreak
+b6|\SpecialChar allowbreak
+c0|\SpecialChar allowbreak
+c1|\SpecialChar allowbreak
+c
+2|\SpecialChar allowbreak
+c3|\SpecialChar allowbreak
+c4|\SpecialChar allowbreak
+c5|\SpecialChar allowbreak
+c6|\SpecialChar allowbreak
+b0j|\SpecialChar allowbreak
+b1j|\SpecialChar allowbreak
+b2j|\SpecialChar allowbreak
+b3j|\SpecialChar allowbreak
+b4j|\SpecialChar allowbreak
+b5j|\SpecialChar allowbreak
+b6j"
+\change_unchanged
+
\end_layout
\end_inset
- The font used for the argument content, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
+] The list of available page sizes, separated by
+\begin_inset Quotes eld
\end_inset
-.
-\end_layout
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\change_inserted -712698321 1565101779
+|
+\change_unchanged
+
\end_layout
\end_inset
- The font used for the label; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+\begin_inset Quotes erd
\end_inset
.
+ Currently, only the listed sizes are supported.
+ Other sizes might be entered as custom class option.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+
+\change_inserted -712698321 1565180623
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+
+\change_inserted -712698321 1565180605
+PageSizeFormat
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-Classic
-\emph default
-, Minimalistic, Conglomerate
+\change_inserted -712698321 1565180601
+string
+\change_unchanged
+
\end_layout
\end_inset
-] describes the rendering style used for the inset's frame and buttons.
-\end_layout
-
-\begin_layout Itemize
+] The format for the page size option.
+ Default:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AutoInsert
+
+\change_inserted -712698321 1565180618
+$$spaper
+\change_unchanged
+
\end_layout
\end_inset
+.
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[int=0]
-\end_layout
-
-\end_inset
- If this is set to
-\begin_inset Flex Code
-status collapsed
+\change_inserted -712698321 1565180601
+$$s
+\change_unchanged
-\begin_layout Plain Layout
-1
\end_layout
\end_inset
-, this argument is automatically inserted when the respective style is selected.
- Currently, only one argument per style\SpecialChar breakableslash
-layout can be automatically inserted.
-\change_inserted -712698321 1431166542
+ is a placeholder for the paper size.
+\change_unchanged
\end_layout
-\begin_layout Itemize
-
-\change_inserted -712698321 1431166604
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1431166548
-InsertCotext
+PageStyle
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1431166543
-[int=0]
+string="empty|plain|headings|fancy"
\end_layout
\end_inset
- If this is set to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1431166543
-1
-\end_layout
-
+] The list of available page sty\SpecialChar softhyphen
+les, separated by
+\begin_inset Quotes eld
\end_inset
-, this argument will be inserted with a copy of the co-text (either selected
- text or the whole paragraph) as content.
-\end_layout
-
-\begin_layout Itemize
-\change_inserted -712698321 1431070588
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1431070522
-PassThruChars
+|
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1431070522
-string of characters
-\end_layout
+\begin_inset Quotes erd
\end_inset
-]
-\family typewriter
-
-\family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
- Note that, contrary to PassThru, this needs to be explicitly defined for
- arguments.
- That is, arguments do not inherit PassThruChars from their parent inset
- or layout.
-\change_unchanged
-
+.
\end_layout
-\begin_layout Standard
-By default, the text entered in the \SpecialChar LyX
- workarea in the respective layout is
- the last (mandatory) argument of a command if the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Other
\end_layout
\end_inset
- is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+string=""
\end_layout
\end_inset
-.
- However, arguments with the prefix
+] Some document class options, separated by a comma, that will be added
+ to the optional part of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-post:
+
+\backslash
+documentclass
\end_layout
\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
+ command.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-post:1
+ClassOptions
\end_layout
\end_inset
-.
- Post-arguments are ignored in any other
+ section must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+End
\end_layout
\end_inset
- than
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Command
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
+\begin_layout Subsection
+Paragraph styles
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Styles"
+
\end_inset
-.
+
\end_layout
\begin_layout Standard
-Arguments for list
-\begin_inset Flex Code
+A paragraph style description looks like this:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+Note that this will either define a new style or modify an existing one.
\end_layout
\end_inset
-s (as in
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
+\end_layout
-\backslash
-item[foo]
+\begin_layout LyX-Code
+Style
+\family roman
+\emph on
+name
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ ...
+\end_layout
-) have the prefix
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+where the following commands are allowed:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-item:
+AddToToc
\end_layout
\end_inset
- followed by the number (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument item:1
+string
\end_layout
\end_inset
-)
+=""] This paragraph will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ Default: disabled.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Align
\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
+\emph on
+block
+\emph default
+, left, right, center
+\end_layout
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
\end_inset
+] Paragraph alignment.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+AlignPossible
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
+\emph on
+block
+\emph default
+, left, right, center
+\end_layout
\end_inset
- for details on its use.
+] A comma separated list of permitted alignments.
+ (Some \SpecialChar LaTeX
+ styles prohibit certain alignments, since those wouldn't make sense.
+ For example a right-aligned or centered enumeration isn't possible.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-BottomSep
+Argument
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+int
\end_layout
\end_inset
-]
-\begin_inset Foot
+] Defines argument number <int> of a command\SpecialChar breakableslash
+environment associated with
+ the current style.
+ This is useful for things like section headings, and only makes sense with
+ \SpecialChar 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
-Note that a `float' here is a real number, such as: 1.5.
+EndArgument
\end_layout
\end_inset
- 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.
+.
+ So a command with two optional arguments has:
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_deeper
+\begin_layout Quote
-\begin_layout Plain Layout
-Category
+\family typewriter
+Argument 1
\end_layout
-\end_inset
+\begin_layout Quote
- [
-\begin_inset Flex Code
-status collapsed
+\family typewriter
+...
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout Quote
+
+\family typewriter
+EndArgument
\end_layout
-\end_inset
+\begin_layout Quote
-] 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.
-
+\family typewriter
+Argument 2
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Quote
-\begin_layout Plain Layout
-CommandDepth
+\family typewriter
+...
\end_layout
-\end_inset
+\begin_layout Quote
- Depth of XML command.
- Used only with XML-type formats.
+\family typewriter
+EndArgument
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+Argument
\end_layout
\end_inset
- [
+ definition, the following specifications are possible:
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+LabelString
\end_layout
\end_inset
-] Copies all the features of an existing style into the current one.
-\end_layout
-
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+[string]
\end_layout
\end_inset
- [
+ 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
-<name>
+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
-status collapsed
+).
+ 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_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 \SpecialChar LyX
- may change without warning
- in later versions.
-\end_layout
+|
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+Short Title|S
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-No_Label
-\emph default
-, Box, Filled_Box, Static
+MenuString
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+[string]
\end_layout
\end_inset
- is
-\begin_inset Newline newline
+ 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
+
+|
+\begin_inset Quotes erd
+\end_inset
+
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-Environment
+Short Title|S
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+).
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+LabelString
\end_layout
\end_inset
- or
+ will be used instead for the menu.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+Tooltip
\end_layout
\end_inset
-).
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-No_Label
+[string]
\end_layout
\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Mandatory
+\end_layout
-nothing
-\begin_inset Quotes erd
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+
+\emph on
+0
\end_layout
\end_inset
- (resp.
-\begin_inset space \space{}
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-Filled_Box
+1
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
+] Declare if this is a mandatory (1) or an optional (0) 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
+{...}
+\end_layout
+
\end_inset
-black) square suitable for end of proof markers,
+, while optional arguments are delimited by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+[...]
\end_layout
\end_inset
- is an explicit text string.
+
+\change_inserted -712698321 1555579782
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_inserted -712698321 1555579780
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+
+\change_inserted -712698321 1555579780
+NewlineCmd
+\change_unchanged
+
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\change_inserted -712698321 1555579780
+[string]
+\change_unchanged
+
\end_layout
\end_inset
-] The string used for a label with a
+ Option to define a different command (from the default
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
-\end_layout
-\end_inset
+\change_inserted -712698321 1555579780
+\backslash
+
+\backslash
+
+\change_unchanged
+
+\end_layout
-\begin_inset Newline newline
\end_inset
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
+\end_layout
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+Requires
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+[int=0]
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+ 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 \SpecialChar 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
+
+\backslash
+command[][argument]{text}
+\end_layout
\end_inset
.
- Note that defining this font automatically defines the
+ This can be achieved by the statement
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Requires 1
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ within
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Argument 2
\end_layout
\end_inset
.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLocal
+LeftDelim
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int=0
+[string]
\end_layout
\end_inset
-] Used for backporting new styles to stable \SpecialChar LyX
- versions.
- The first stable version that supports this tag is \SpecialChar LyX
- 2.1.0.
- The argument is a number which may either be 0, -1 or any value greater
- than zero.
- If the
+ defines a custom left delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLocal
+{
\end_layout
\end_inset
- flag of a style is greater than zero, it will always be written to the
- document header.
- If a .lyx file is read, the style definitions from the document header are
- added to the document class.
- Therefore even older \SpecialChar LyX
- versions can handle the style.
- The argument of
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLocal
+[
\end_layout
\end_inset
- is a version number: If the style is read, and the version number is less
- than the version number of the already existing style in the document class,
- the new style is ignored.
- If the version number is greater, the new style replaces the existing style.
- A value of -1 means an infinite version number, i.
-\begin_inset space \thinspace{}
-\end_inset
+).
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<br/>
+\end_layout
-e.
-\begin_inset space \space{}
\end_inset
-the style is always used.
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+RightDelim
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+[string]
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
+ defines a custom right delimiter (instead of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+}
+\end_layout
+\end_inset
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+]
\end_layout
\end_inset
-] Usually \SpecialChar 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 \SpecialChar LaTeX
- code.
- For this reason,
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+<br/>
\end_layout
\end_inset
- can be enabled.
- Note that \SpecialChar LyX
- will create protected blanks for the additional blanks when
- in another mode than \SpecialChar LaTeX
--mode.
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+DefaultArg
\end_layout
\end_inset
- These tags are used with XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Style-XHTML"
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[string]
+\end_layout
\end_inset
-.
+ defines an argument that is inserted if and only if no user-specified arguments
+ were given, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+if no argument inset has been inserted (note that also an empty argument
+ inset omits the DefaultArg).
+ Multiple arguments need to be separated by comma.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InnerTag
+PresetArg
\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
+
+ 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.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InPreamble
+Font
+\end_layout
+
+\end_inset
+
+ The font used for the argument content, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\change_inserted -712698321 1559484228
+
+\end_layout
+
+\begin_layout Itemize
+
+\change_inserted -712698321 1559484228
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
+FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
+\change_inserted -712698321 1559484228
+
\emph on
0
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -712698321 1559484228
1
+\change_unchanged
+
\end_layout
\end_inset
-] If
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LabelFont
\end_layout
\end_inset
-, 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
+ The font used for the label; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Decoration
\end_layout
\end_inset
- is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+
+\emph on
+Classic
+\emph default
+, Minimalistic, Conglomerate
\end_layout
\end_inset
- or
+] describes the rendering style used for the inset's frame and buttons.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+AutoInsert
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle
+[int=0]
\end_layout
\end_inset
- [
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+1
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
+, this argument is automatically inserted when the respective style is selected.
+
+\change_deleted -712698321 1559484200
+ Currently, only one argument per style\SpecialChar breakableslash
+layout can be automatically inserted.
+\change_unchanged
+\end_layout
+
+\begin_layout Itemize
+\change_inserted -712698321 1559491402
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\change_inserted -712698321 1559490711
+InsertOnNewline
+\change_unchanged
+
\end_layout
\end_inset
-] If
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\change_inserted -712698321 1559490703
+[int=0]
+\change_unchanged
+
\end_layout
\end_inset
-, marks the style as being part of a title block (see also the
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\change_inserted -712698321 1559490703
+1
+\change_unchanged
+
\end_layout
\end_inset
- and
+, this argument will be inserted on a new line with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\change_inserted -712698321 1559491402
+AutoInsert
+\change_unchanged
+
\end_layout
\end_inset
- global entries).
+ (only available within Flex insets).
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemCommand
+InsertCotext
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="item"
+[int=0]
\end_layout
\end_inset
-] The \SpecialChar 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
-
-item
-\begin_inset Quotes erd
-\end_inset
-
-, resulting in
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+1
\end_layout
\end_inset
- in the \SpecialChar LaTeX
- output).
+, this argument will be inserted with a copy of the co-text (either selected
+ text or the whole paragraph) as content.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemSep
+PassThru
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+
+\emph on
+inherited
+\emph default
+, true, false
\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
+] Whether the contents of this argument should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
+ By default, the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParSep
+PassThru
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+ status is inherited by the inset or paragraph layout the argument belongs
+ to, true and false change the status for the given argument only.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemSep
+PassThruChars
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemTag
+string of characters
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+]
+\family typewriter
+
+\family default
+Defines individual characters
+\begin_inset Newline linebreak
+\end_inset
+
+that should be output in raw form, meaning without special translations
+ that \SpecialChar LaTeX
+ would require.
+ Note that, contrary to PassThru, this needs to be explicitly defined for
+ arguments.
+ That is, arguments do not inherit PassThruChars from their parent inset
+ or layout.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+IsTocCaption
\end_layout
\end_inset
\end_inset
-] Usually \SpecialChar LyX
- does not allow you to leave a paragraph empty, since it would
- lead to empty \SpecialChar 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.
+] If this is set to 1, the argument will output its content in the corresponding
+ item in the table of contents.
+ See AddToToc.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+By default, the text entered in the \SpecialChar 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
-LabelBottomsep
+LatexType
\end_layout
\end_inset
- [
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+Command
\end_layout
\end_inset
-] The vertical space between the label and the text body.
- Only used for labels that are above the text body (
+.
+ However, arguments with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+post:
\end_layout
\end_inset
- and
-\begin_inset Newline newline
-\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
-Centered_Top_Environment
+post:1
\end_layout
\end_inset
-).
-\end_layout
-
-\begin_layout Description
+.
+ Post-arguments are ignored in any other
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+LatexType
\end_layout
\end_inset
- [
+ than
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Command
\end_layout
\end_inset
-] The name of the counter for automatic numbering.
- In order to have the counter appear with your label, you will need to reference
- it in the
+.
+\end_layout
+
+\begin_layout Standard
+Arguments for list
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\family typewriter
-LabelString
+\backslash
+item
\end_layout
\end_inset
-.
- This will work with
+s (as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+
+\backslash
+item[foo]
\end_layout
\end_inset
-s,
+) have the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+item:
\end_layout
\end_inset
-,
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Above
+Argument item:1
\end_layout
\end_inset
- and
+).
+\change_inserted -712698321 1534487781
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1534488561
+Finally, there is a special argument type with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered
+
+\change_inserted -712698321 1534487844
+listpreamble:
+\change_unchanged
+
\end_layout
\end_inset
-, at least.
-\begin_inset Newline newline
+.
+ It is not really an argument, but uses the argument interface (thus, the
+ prefix is also followed by a number, e.
+\begin_inset space \thinspace{}
\end_inset
-This
-\emph on
-may
-\emph default
- also be given if
+g.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+
+\change_inserted -712698321 1534488412
+Argument listpreamble:1
+\change_unchanged
+
\end_layout
\end_inset
- is
+).
+ As the name implies, it is targeted at lists such as
+\family sans
+Itemize
+\family default
+,
+\family sans
+Enumerate
+\family default
+,
+\family sans
+Description
+\family default
+, or
+\family sans
+Bibliography
+\family default
+.
+ Its content will be output at the list start, before the first
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+
+\change_inserted -712698321 1534488058
+
+\backslash
+item
+\change_unchanged
+
\end_layout
\end_inset
-, though this case is a bit complicated.
- Suppose you declare
+, on an own line (a place that is otherwise not accessible in \SpecialChar LyX
+).
+ This way, users can insert redefinitions (of lengths etc.) to individual
+ lists.
+ By default, these arguments do not have a delimiter.
+\change_unchanged
+
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AutoNests
+\end_layout
+
+\end_inset
+
+ Includes a comma-separated list of layouts that should be nested in and
+ after the current layout.
+ Only makes sense for nestable layouts (such as environments).
+ Must be ended by
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-LabelCounter myenum
+EndAutoNests
\end_layout
\end_inset
\end_inset
.
- Then the actual counters used are
+ See also
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumi
+IsAutoNestedBy
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumii
+BabelPreamble
\end_layout
\end_inset
-,
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiii
+BabelPreamble
\end_layout
\end_inset
- and
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiv
+EndBabelPreamble
\end_layout
\end_inset
-, much as in \SpecialChar LaTeX
-.
- These counters must all be declared separately.
-\begin_inset Newline newline
+
+\begin_inset Quotes erd
\end_inset
-See
+.
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Counters"
+reference "subsec:I18n"
\end_inset
- for details on counters.
+ for details on its use.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelFont
+BottomSep
\end_layout
\end_inset
- The font used for the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelIndent
+float=0
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+]
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-string=""
+Note that a `float' here is a real number, such as: 1.5.
\end_layout
\end_inset
-] Text that indicates how far a label should be indented.
+ 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
-LabelSep
+Category
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+string
\end_layout
\end_inset
-] 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.
+] 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
-LabelString
+CommandDepth
\end_layout
\end_inset
- [
+ Depth of XML command.
+ Used only with XML-type formats.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+CopyStyle
\end_layout
\end_inset
-] The string used for the label.
- When
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+string
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Counters"
-
-\end_inset
-
-.
+] Copies all the features of an existing style into the current one.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+DependsOn
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+<name>
\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
-LabelString
-\end_layout
-
-\end_inset
-
-.
- Note that every
-\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
-LabelString
+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 \SpecialChar LyX
+ may change without warning
+ in later versions.
\end_layout
\end_inset
- statement resets
-\begin_inset Newline newline
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelStringAppendix
-\end_layout
-
-\end_inset
- too.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelTag
+EndLabeltype
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+
+\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LatexType
+\end_layout
-\emph on
-No_Label
-\emph default
-, Manual, Static, Above,
-\begin_inset Newline newline
\end_inset
-Centered, Sensitive, Enumerate,
+ is
\begin_inset Newline newline
\end_inset
-Itemize, Bibliography
-\end_layout
-
-\end_inset
-
-]
-\begin_inset Separator parbreak
-\end_inset
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Environment
\end_layout
-\begin_deeper
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+Item_Environment
\end_layout
\end_inset
- 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
-
-\begin_layout Description
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+List_Environment
\end_layout
\end_inset
- means the label is simply what is declared as
+).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+No_Label
\end_layout
\end_inset
-.
- This will be displayed
+ means
\begin_inset Quotes eld
\end_inset
-inline
+nothing
\begin_inset Quotes erd
\end_inset
-, at the beginning of the paragraph.
- If the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Box
\end_layout
\end_inset
- is
+ (resp.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Filled_Box
\end_layout
\end_inset
-, then it will be displayed only in the first paragraph of any sequence
- of paragraphs with the same
+) 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
-Style
+Static
\end_layout
\end_inset
-.
+ is an explicit text string.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Above
+EndLabelString
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_inset space ~
-\end_inset
+\begin_layout Plain Layout
+string=""
+\end_layout
-and
-\begin_inset space ~
\end_inset
-
+] The string used for a label with a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered
+Static
\end_layout
\end_inset
- are special cases of
+
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+EndLabelType
\end_layout
\end_inset
.
- The label will be printed above the paragraph either at the beginning of
- the line or centered.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Sensitive
+Font
\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
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-Table
-\begin_inset Quotes erd
\end_inset
.
-\begin_inset Newline newline
-\end_inset
-
-
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+LabelFont
\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.
- For the case that a caption is inserted outside of a float the
+ 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
-
- will appear as
-\begin_inset Quotes eld
-\end_inset
-
-Senseless!
-\begin_inset Quotes erd
\end_inset
.
status collapsed
\begin_layout Plain Layout
-Enumerate
+ForceLocal
\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 Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemize
+int=0
\end_layout
\end_inset
- produces various bullets at the different levels.
- It is also hardcoded.
-\end_layout
-
-\begin_layout Description
+] Used for backporting new styles to stable \SpecialChar LyX
+ versions.
+ The first stable version that supports this tag is \SpecialChar LyX
+ 2.1.0.
+ The argument is a number which may either be 0, -1 or any value greater
+ than zero.
+ If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+ForceLocal
\end_layout
\end_inset
- should be used only with
+ flag of a style is greater than zero, it will always be written to the
+ document header.
+ If a .lyx file is read, the style definitions from the document header are
+ added to the document class.
+ Therefore even older \SpecialChar LyX
+ versions can handle the style.
+ The argument of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType BibEnvironment
+ForceLocal
\end_layout
\end_inset
-.
+ is a version number: if the style is read, and the version number is less
+ than the version number of the already existing style in the document class,
+ the new style is ignored.
+ If the version number is greater, the new style replaces the existing style.
+ A value of -1 means an infinite version number, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+the style is always used.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+FreeSpacing
\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
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
-
-\end_inset
-
- for details on its use.
-\end_layout
-
-\begin_layout Description
+] Usually \SpecialChar 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 \SpecialChar LaTeX
+ code.
+ For this reason,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+FreeSpacing
\end_layout
\end_inset
- [
+ can be enabled.
+
+\change_deleted -495245474 1550490105
+Note that
+\change_unchanged
+\SpecialChar LyX
+ will create protected blanks for the additional blanks when in
+\change_inserted -495245474 1550490096
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+
+\change_inserted -495245474 1550490089
+Passthru 1
+\change_unchanged
+
\end_layout
\end_inset
-] The name of the corresponding \SpecialChar LaTeX
- stuff.
- Either the environment or command name.
-\end_layout
+ is not specified.
+\change_deleted -495245474 1550490116
+another mode than \SpecialChar LaTeX
+-mode.
-\begin_layout Description
+\change_inserted -495245474 1550247760
+ Note that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+
+\change_inserted -495245474 1550247736
+FreeSpacing
+\change_unchanged
+
\end_layout
\end_inset
- [
+ implies
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<parameter>
+
+\change_inserted -495245474 1550247755
+KeepEmpty
+\change_unchanged
+
\end_layout
\end_inset
-] An optional parameter for the corresponding
-\begin_inset Flex Code
-status collapsed
+.
+\change_unchanged
-\begin_layout Plain Layout
-LatexName
\end_layout
-\end_inset
-
- stuff.
- This parameter cannot be changed from within \SpecialChar LyX
- (use
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+HTML*
\end_layout
\end_inset
- for customizable parameters).
- This will be output as is after all \SpecialChar LaTeX
-
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Style-XHTML"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+InnerTag
\end_layout
\end_inset
-s.
+ [FIXME] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexType
+InPreamble
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
-\begin_inset Newline newline
-\end_inset
-
-List_Environment, Bib_Environment
+0
\end_layout
\end_inset
-] How the style should be translated into \SpecialChar LaTeX
-.
-\begin_inset Foot
-status collapsed
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+1
\end_layout
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
-\end_layout
-
-\end_inset
+] If
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+1
+\end_layout
-\begin_inset Separator parbreak
\end_inset
-
-\end_layout
-
-\begin_deeper
-\begin_layout Description
+, 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
-Paragraph
+LatexType
\end_layout
\end_inset
- means nothing special.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\end_inset
- means
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar ldots
-}
+Paragraph
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Environment
+InTitle
\end_layout
\end_inset
- means
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar ldots
-
-\backslash
-end{
\emph on
-LatexName
-\emph default
-}
+0
\end_layout
\end_inset
-.
-
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+1
\end_layout
\end_inset
- is the same as
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+1
\end_layout
\end_inset
-, except that an
+, marks the style as being part of a title block (see also the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+TitleLatexType
+\end_layout
-\backslash
-item
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+ global entries).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-List_Environment
+IsAutoNestedBy
\end_layout
\end_inset
- is the same as
+ Includes a comma-separated list of layouts after which this one should
+ be nested.
+ Only makes sense with regard to nestable layouts (such as environments).
+ Must be ended by
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+EndIsAutoNestedBy
\end_layout
\end_inset
-, except that
-\begin_inset Newline newline
-\end_inset
+\begin_inset Quotes erd
+\end_inset
+.
+ See also
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+AutoNests
\end_layout
\end_inset
- is passed as an argument to the environment.
-\begin_inset Newline newline
-\end_inset
-
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+IsTocCaption
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex MenuItem
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-settings
+\emph on
+0
\end_layout
\end_inset
- dialog.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bib_Environment
+1
\end_layout
\end_inset
- is like
+] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label, if it exists, appears.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+ItemCommand
\end_layout
\end_inset
- but adds additionally the necessary mandatory argument (the longest label)
- to the begin statement of the bibliography environment:
-\begin_inset Newline newline
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{thebibliography}{99}
+string="item"
\end_layout
\end_inset
- It is therefore only useful for bibliography environments.
- The default longest label
-\begin_inset Quotes eld
+] The \SpecialChar 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
-99
+item
\begin_inset Quotes erd
\end_inset
- can be changed by the user in the paragraph settings of a bibliography
- item.
-\end_layout
-
-\begin_layout Standard
-Putting the last few things together, the \SpecialChar LaTeX
- output will be either:
-\end_layout
+, resulting in
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
\backslash
-LatexName[LatexParam]{\SpecialChar ldots
-}
+item
\end_layout
-\begin_layout Standard
-or:
+\end_inset
+
+ in the \SpecialChar LaTeX
+ output).
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\backslash
-begin{LatexName}[LatexParam] \SpecialChar ldots
-
-\backslash
-end{LatexName}.
+\begin_layout Plain Layout
+ItemSep
\end_layout
-\begin_layout Standard
-depending upon the \SpecialChar LaTeX
- type.
-\end_layout
+\end_inset
-\end_deeper
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftDelim
+float=0
\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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+ParSep
\end_layout
\end_inset
-] A string that is put at the beginning of the style content.
- A line break in the output can be indicated by
+.
+ But the whole items of the environment are additionally separated with
+ this
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+ItemSep
\end_layout
\end_inset
.
+ Note that this is a
+\emph on
+ multiplier.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LeftMargin
+ItemTag
\end_layout
\end_inset
- [
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+KeepEmpty
\end_layout
\end_inset
-] If you put styles into environments, the different
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+
+\emph on
+0
\end_layout
\end_inset
- are not simply added, but added with a factor
-\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
+,
+\begin_inset space \thinspace{}
\end_inset
-.
- Note that this parameter is also used when
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Margin
+1
\end_layout
\end_inset
- is defined as
+] Usually \SpecialChar LyX
+ does not allow you to leave a paragraph empty, since it would
+ lead to empty \SpecialChar 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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LabelBottomsep
\end_layout
\end_inset
- or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+float=0
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
-\begin_inset Newline newline
+] 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
+Top_Environment
+\end_layout
+
\end_inset
-For example
-\begin_inset Quotes eld
+ and
+\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-MM
+Centered_Top_Environment
\end_layout
\end_inset
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+LabelCounter
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+string=""
\end_layout
\end_inset
+] The name of the counter for automatic numbering.
+ In order to have the counter appear with your label, you will need to reference
+ it in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
+LabelString
+\end_layout
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
\end_inset
-
+.
+ This will work with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--
+LabelType
\end_layout
\end_inset
+s,
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
- This way was chosen so that the look is the same with each used screen
- font.
+\begin_layout Plain Layout
+Static
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Margin
+Above
\end_layout
\end_inset
- [
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+Centered
\end_layout
\end_inset
-]
+, at least.
\begin_inset Newline newline
\end_inset
-The kind of margin that the style has on the left side.
-\begin_inset Separator parbreak
-\end_inset
-
+This
+\emph on
+may
+\emph default
+ also be given if
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+LabelType
\end_layout
-\begin_deeper
-\begin_layout Description
+\end_inset
+
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+Enumerate
\end_layout
\end_inset
- just means a fixed margin.
-\end_layout
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LabelCounter myenum
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex MenuItem
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Then the actual counters used are
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar menuseparator
-Paragraph
-\begin_inset space ~
+myenumi
+\end_layout
+
\end_inset
-Settings
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+myenumii
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+myenumiii
\end_layout
-\begin_layout Description
+\end_inset
+
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+myenumiv
\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
-\end_inset
-
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
-
-3.2 Very long headline
-\begin_inset Quotes erd
+, much as in \SpecialChar LaTeX
+.
+ These counters must all be declared separately.
+\begin_inset Newline newline
\end_inset
-, even if standard
-\begin_inset Quotes eld
-\end_inset
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
-word processors
-\begin_inset Quotes erd
\end_inset
- are not able to do this.
+ for details on counters.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+LabelFont
\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.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Right_Address_Box
-\end_layout
+ The font used for the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
+.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+LabelIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string=""
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+] Text that indicates how far a label should be indented.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LabelSep
\end_layout
\end_inset
-] Whether fragile commands in this style should be
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+string=""
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether this command should itself be protected.)
+] 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
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Newline
+LabelString
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0
+string=""
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+] The string used for the label.
+ When
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+LabelCounter
\end_layout
\end_inset
-] Whether newlines are translated into \SpecialChar LaTeX
- newlines (
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-
-\end_layout
+ is set, this string can be contain the special formatting commands described
+ in
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
\end_inset
-) or not.
- The translation can be switched off to allow more comfortable \SpecialChar LaTeX
- editing
- inside \SpecialChar LyX
.
\end_layout
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LabelStringAppendix
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string=""
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+] This is used inside the appendix instead of
+\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+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
- [
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<name>
+LabelType
\end_layout
\end_inset
-] Name of a style that has replaced this style.
- This is used to rename a style, while keeping backward compatibility.
-\change_inserted -712698321 1432986397
-
-\end_layout
-
-\begin_layout Description
-
-\change_inserted -712698321 1432986583
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1432986403
-ParagraphGroup
+\emph on
+No_Label
+\emph default
+, Manual, Static, Above,
+\begin_inset Newline newline
+\end_inset
+
+Centered, Sensitive, Enumerate,
+\begin_inset Newline newline
+\end_inset
+
+Itemize, Bibliography
\end_layout
\end_inset
- [
+]
+\end_layout
+
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432986397
-0
+Manual
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+ 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
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432986397
-1
+Static
\end_layout
\end_inset
-] Determines whether consecutive pragraphs of the same type are treated
- as belonging together.
- This has the effect that the
+ means the label is simply what is declared as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432986460
-GuiLabel
+LabelString
\end_layout
\end_inset
- is only printed once before such a group.
- By default, this is true for
+.
+ This will be displayed
+\begin_inset Quotes eld
+\end_inset
+
+inline
+\begin_inset Quotes erd
+\end_inset
+
+, at the beginning of the paragraph.
+ If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432986491
-LaTeXType
+LatexType
\end_layout
\end_inset
-
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432986583
Environment
-\change_unchanged
-
\end_layout
\end_inset
- and
+, then it will be displayed only in the first paragraph of any sequence
+ of paragraphs with the same
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432986572
-Bib_Environment
-\change_unchanged
-
+Style
\end_layout
\end_inset
- and false for all other types.
-\change_unchanged
-
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+Above
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
+\begin_inset space ~
+\end_inset
-\emph on
-0
-\end_layout
-
-\end_inset
-
-,
-\begin_inset space \thinspace{}
+and
+\begin_inset space ~
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+Centered
\end_layout
\end_inset
-] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
- output,
- but only by a line break; together with
+ are special cases of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru 1
+Static
\end_layout
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
+.
+ The label will be printed above the paragraph either at the beginning of
+ the line or centered.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParIndent
+Sensitive
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-string=""
-\end_layout
+Figure
+\begin_inset Quotes erd
+\end_inset
+ and
+\begin_inset Quotes eld
\end_inset
-] The indent of the very first line of a paragraph.
- The
+Table
+\begin_inset Quotes erd
+\end_inset
+
+.
\begin_inset Newline newline
\end_inset
status collapsed
\begin_layout Plain Layout
-Parindent
+Sensitive
\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
+ 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.
+ For the case that a caption is inserted outside of a float the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LabelString
\end_layout
+\end_inset
+
+ will appear as
+\begin_inset Quotes eld
+\end_inset
+
+Senseless!
+\begin_inset Quotes erd
\end_inset
.
- Also,
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Enumerate
\end_layout
\end_inset
- style paragraphs inside environments use the
+ produces the usual sort of enumeration labels.
+ The number type needs to be set in the
+\family sans
+Counter
+\family default
+, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+Itemize
\end_layout
\end_inset
- of the environment, not their native one.
- For example,
-\begin_inset Flex Code
+ produces various bullets at the different levels.
+ The bullet types displayed can be set via
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Standard
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
+Bullets
\end_layout
\end_inset
- paragraphs inside an enumeration are not indented.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParSep
+Bibliography
\end_layout
\end_inset
- [
+ should be used only with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+LatexType BibEnvironment
\end_layout
\end_inset
-] The vertical space between two paragraphs of this style.
+.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
+LangPreamble
\end_layout
\end_inset
- [
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+LangPreamble
\end_layout
\end_inset
-] \SpecialChar LyX
- allows the user to choose either
+ declaration for this style.
+ Must end with
\begin_inset Quotes eld
\end_inset
-indent
-\begin_inset Quotes erd
-\end_inset
- or
-\begin_inset Quotes eld
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndLangPreamble
+\end_layout
+
\end_inset
-skip
+
\begin_inset Quotes erd
\end_inset
- to separate paragraphs.
- When
-\begin_inset Quotes eld
-\end_inset
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
-indent
-\begin_inset Quotes erd
\end_inset
- is chosen,
+ for details on its use.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
+LatexName
\end_layout
\end_inset
- is ignored.
- When
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<name>
+\end_layout
-skip
-\begin_inset Quotes erd
\end_inset
- is chosen,
+] The name of the corresponding \SpecialChar LaTeX
+ stuff.
+ Either the environment or command name.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParIndent
+LatexParam
\end_layout
\end_inset
- is ignored and all paragraphs are separated by the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
+<parameter>
\end_layout
\end_inset
- argument.
- The vertical space is calculated with
+] An optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
-\begin_inset space ~
+LatexName
+\end_layout
+
\end_inset
-* DefaultHeight
+ stuff.
+ This parameter cannot be changed from within \SpecialChar LyX
+ (use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Argument
\end_layout
\end_inset
- where
+ for customizable parameters).
+ This will be output as is after all \SpecialChar LaTeX
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+Argument
\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.
+s.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+LatexType
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-0
-\end_layout
-
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset space \thinspace{}
+List_Environment, Bib_Environment
+\end_layout
+
\end_inset
+] How the style should be translated into \SpecialChar LaTeX
+.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LatexType
\end_layout
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
-\change_inserted -712698321 1429534178
-
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
\end_layout
-\begin_layout Description
+\end_inset
+
-\change_inserted -712698321 1429534242
+\end_layout
-\lang ngerman
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1429534178
-PassThruChars
+Paragraph
\end_layout
\end_inset
+ means nothing special.
+\end_layout
-\lang english
- [
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1429534178
-string of characters
+Command
\end_layout
\end_inset
-]
-\family typewriter
-
-\family default
-Defines individual characters that should be output in raw form, meaning
- without special translations that \SpecialChar LaTeX
- would require.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Description
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
-\end_layout
-\end_inset
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar ldots
+}
+\end_layout
- Information to be included in the \SpecialChar 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
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+Environment
\end_layout
\end_inset
+ means
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar ldots
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RefPrefix
+Item_Environment
\end_layout
\end_inset
- [
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Environment
\end_layout
\end_inset
-] The prefix to use when creating labels referring to paragraphs of this
- type.
- This allows the use of formatted references.
-\end_layout
-
-\begin_layout Description
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+
+\backslash
+item
\end_layout
\end_inset
- [
+ is generated for each paragraph of this environment.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+List_Environment
\end_layout
\end_inset
-] Whether the style requires the feature
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Item_Environment
\end_layout
\end_inset
+, except that
+\begin_inset Newline newline
+\end_inset
-\change_deleted -712698321 1438601713
-.
-\change_unchanged
-
-\change_deleted -712698321 1438601638
-See the description of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+LabelWidthString
\end_layout
\end_inset
- above (
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:General-text-class"
-
+ is passed as an argument to the environment.
+\begin_inset Newline newline
\end_inset
-) for information on `features'.
-\change_inserted -712698321 1438601711
-(see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:List-of-functions"
-
-\end_inset
- for the list of features).
- If you require a package with specific options, you can additionally use
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1438601638
-PackageOptions
+LabelWidthString
\end_layout
\end_inset
- as a general text class parameter (see sec.
+ can be defined in the
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Edit\SpecialChar menuseparator
+Paragraph
\begin_inset space ~
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:General-text-class"
+settings
+\end_layout
\end_inset
-).
-\change_unchanged
-
+ dialog.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ResetArgs
+Bib_Environment
\end_layout
\end_inset
- [
+ is like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Environment
\end_layout
\end_inset
-,
+ but adds the necessary mandatory argument (the longest label) to the begin
+ statement of the bibliography environment:
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\backslash
+begin{thebibliography}{99}
\end_layout
\end_inset
-] Resets the \SpecialChar LaTeX
- arguments of this style (as defined via the
-\begin_inset Flex Code
-status collapsed
+.
+ It is therefore only useful for bibliography environments.
+ The default longest label
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-Argument
+99
+\begin_inset Quotes erd
+\end_inset
+
+ can be changed by the user in the paragraph settings of a bibliography
+ item.
\end_layout
-\end_inset
+\begin_layout Standard
+Putting the last few things together, the \SpecialChar LaTeX
+ output will be either:
+\end_layout
- tag).
- This is useful if you have copied a style via
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-CopyStyle
+\backslash
+LatexName[LatexParam]{\SpecialChar ldots
+}
\end_layout
-\end_inset
+\begin_layout Standard
+or:
+\end_layout
-, but you do not want to inherit its (required and optional) arguments.
+\begin_layout LyX-Code
+
+\backslash
+begin{LatexName}[LatexParam] \SpecialChar ldots
+
+\backslash
+end{LatexName}.
+\end_layout
+
+\begin_layout Standard
+depending upon the \SpecialChar LaTeX
+ type.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightDelim
+LeftDelim
\end_layout
\end_inset
\end_inset
-] A string that is put at the end of the layout content.
+] 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
status collapsed
\begin_layout Plain Layout
-RightMargin
+LeftMargin
\end_layout
\end_inset
\end_inset
-] Similar to
+] If you put styles into environments, the different
\begin_inset Flex Code
status collapsed
\end_inset
-.
-\end_layout
+ are not simply added, but added with a factor
+\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
+\end_inset
-\begin_layout Description
+.
+ Note that this parameter is also used when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+Margin
\end_layout
\end_inset
- [
+ is defined as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-single
+Manual
\end_layout
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
+Dynamic
\end_layout
\end_inset
-,
+.
+ Then it is added to the manual or dynamic margin.
+\begin_inset Newline newline
+\end_inset
+
+For example
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-double
+MM
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-other
-\begin_inset space ~
+\begin_inset Quotes erd
\end_inset
-<value>
-\end_layout
-
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\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
-single
+MM
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-onehalf
-\end_layout
+\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
- and
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-double
+-
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-other
-\end_layout
+\begin_inset Quotes erd
\end_inset
-, then you must also provide a value argument which will be the actual multiplie
-r value.
- Note that, contrary to other parameters,
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+Margin
\end_layout
\end_inset
- implies the generation of specific \SpecialChar LaTeX
- code, using the \SpecialChar LaTeX
- package
-\family roman
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-setspace
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
-.
+]
+\begin_inset Newline newline
+\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
-Spellcheck
+Static
\end_layout
\end_inset
- [
+ just means a fixed margin.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Manual
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\begin_inset Flex Code
+ means that the left margin depends on the string entered in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
-\emph on
-1
+Settings
\end_layout
\end_inset
-] Allow spell-checking paragraphs of this style.
- Default is true.
+ dialog.
+ This is used to typeset nice lists without tabulators.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TextFont
+Dynamic
\end_layout
\end_inset
- The font used for the text body .
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+ 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
+\end_inset
+
+ plus the space) than
+\begin_inset Quotes eld
+\end_inset
+
+3.2 Very long headline
+\begin_inset Quotes erd
+\end_inset
+
+, even if standard
+\begin_inset Quotes eld
+\end_inset
+
+word processors
+\begin_inset Quotes erd
+\end_inset
+
+ are not able to do this.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TocLevel
+First_Dynamic
\end_layout
\end_inset
+ is similar, but only the very first row of the paragraph is dynamic, while
+ the others are static; this is used, for example, for descriptions.
+\end_layout
-\series medium
- [
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-int=3
+Right_Address_Box
\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.
-\change_inserted -712698321 1401363541
-
+ 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
-
-\change_inserted -712698321 1401363906
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1401363547
-ToggleIndent
+NeedProtect
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1401363664
-
\emph on
-default
-\change_unchanged
-
+0
\end_layout
\end_inset
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\emph default
-,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1401363669
-always
-\change_unchanged
-
+1
\end_layout
\end_inset
-,
+] Whether fragile commands in this style should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1401363675
-never
-\change_unchanged
-
+\backslash
+protect
\end_layout
\end_inset
-] This tag determines whether the first line indentation of this paragraph
- can be toggled via the Paragraph settings dialog.
- If
+'ed.
+ (Note: This is
\emph on
+not
+\emph default
+ whether this command should itself be protected.)
+\change_inserted -712698321 1523696949
+
+\end_layout
+
+\begin_layout Description
+\change_inserted -712698321 1552395557
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1401363761
+\change_inserted -712698321 1523696950
+NeedCProtect
+\change_unchanged
-\emph off
-default
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1523696950
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
-\emph default
- is set, indentation can be toggled if the document settings use
-\begin_inset Quotes eld
\end_inset
-indent
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\end_inset
- paragraph style, with
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1401363844
-always
+\change_inserted -712698321 1523696950
+1
+\change_unchanged
+
\end_layout
\end_inset
-, indentation can always be toggled, notwithstanding the document settings,
- with
+] This causes macros that contain this layout to be protected with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1401363901
-never
+\change_inserted -712698321 1523696950
+
+\backslash
+cprotect
+\change_unchanged
+
\end_layout
\end_inset
-, indentation can never be toggled.
-\change_unchanged
-
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1552395844
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TopSep
+
+\change_inserted -712698321 1552395561
+NeedMBoxProtect
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395557
-] 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
+\emph on
+0
+\change_unchanged
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:I18n"
+\end_layout
\end_inset
-Internationalization of Paragraph Styles
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-\SpecialChar LyX
- has long supported internationalization of layout information, but, until
- version 2.0, this applied only to the user interface and not to, say, PDF
- output.
- Thus, French authors were forced to resort to ugly hacks if they wanted
- `
-\lang french
-Théorème
-\lang english
- 1' instead of `Theorem 1'.
- Thanks to Georg Baum, that is no longer the case.
-\end_layout
-\begin_layout Standard
-If a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+
+\change_inserted -712698321 1552395557
+1
+\change_unchanged
+
\end_layout
\end_inset
- defines text that is to appear in the typeset document, it may use
+] Whether specific commands in this style (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
-\end_layout
-\end_inset
+\change_inserted -712698321 1552395655
- and
-\begin_inset Flex Code
-status collapsed
+\backslash
+cite
+\change_unchanged
-\begin_layout Plain Layout
-BabelPreamble
\end_layout
\end_inset
- to support non-English and even multi-language documents correctly.
- The following excerpt (from the
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
-\end_layout
-
-\end_inset
- file) shows how this works:
-\end_layout
-
-\begin_layout LyX-Code
-Preamble
-\begin_inset Separator parbreak
-\end_inset
+\change_inserted -712698321 1552395661
+\backslash
+ref
+\change_unchanged
\end_layout
-\begin_deeper
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
-\end_layout
+) should be protected in an
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
+\change_inserted -712698321 1552395631
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
\backslash
-claimname}{_(Claim)}
-\end_layout
+mbox
+\change_unchanged
-\begin_layout LyX-Code
-EndLangPreamble
\end_layout
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
-\end_layout
+.
+ This is particularly needed for styles that draw on
+\family sans
+ulem
+\family default
+ or
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
+\change_unchanged
-\begin_layout LyX-Code
-EndBabelPreamble
\end_layout
-\end_deeper
-\begin_layout Standard
-In principle, any legal \SpecialChar LaTeX
- may appear in the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Newline
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+0
\end_layout
\end_inset
- tags, but in practice they will typically look as they do here.
- The key to correct translation of the typeset text is the definition of
- the \SpecialChar LaTeX
- command
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-claimname
+\emph on
+1
\end_layout
\end_inset
- and its use in
+] Whether newlines are translated into \SpecialChar LaTeX
+ newlines (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-newtheorem
+
+\backslash
+
\end_layout
\end_inset
+) or not.
+ The translation can be switched off to allow more comfortable \SpecialChar LaTeX
+ editing
+ inside \SpecialChar LyX
.
-
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+NextNoIndent
\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
+0
\end_layout
\end_inset
- tag.
- What makes it special is the use of the
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
-function
-\begin_inset Quotes erd
-\end_inset
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+1
\end_layout
\end_inset
-, which will be replaced, when \SpecialChar LyX
- produces \SpecialChar LaTeX
- output, with the translation of
- its argument into the document language.
-\end_layout
-
-\begin_layout Standard
-The
+] If set to true, and if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+DefaultStyle
\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
+ (usually
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+Standard
\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
+) 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
-_()
+ObsoletedBy
\end_layout
\end_inset
- will be replaced with its translation into the language in question; the
- expression
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$$lang
+<name>
\end_layout
\end_inset
- is replaced by the language name (as used by the babel package).
+] Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
\end_layout
-\begin_layout Standard
-A German document that also included a French section would thus have the
- following in the preamble:
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
+ParagraphGroup
+\end_layout
-\backslash
-addto
-\backslash
-captionsfrench{
-\backslash
-renewcommand{
-\backslash
-claimname}{Affirmation}}
-\begin_inset Newline newline
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
-\backslash
-addto
-\backslash
-captionsngerman{
-\backslash
-renewcommand{
-\backslash
-claimname}{Behauptung}}
-\begin_inset Newline newline
\end_inset
+,
+\begin_inset space \thinspace{}
+\end_inset
-\backslash
-providecommand{
-\backslash
-claimname}{Behauptung}
-\end_layout
-\begin_layout Standard
-\SpecialChar LaTeX
- and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+1
\end_layout
\end_inset
- will then conspire to produce the correct text in the output.
-\end_layout
-
-\begin_layout Standard
-One important point to note here is that the translations are provided by
- \SpecialChar LyX
- itself, through the file
+] Determines whether consecutive paragraphs of the same type are treated
+ as belonging together.
+ This has the effect that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-layouttranslations
+GuiLabel
\end_layout
\end_inset
-.
- This means, in effect, that
+ is only printed once before such a group.
+ By default, this is true for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+LaTeXType
\end_layout
\end_inset
- and
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Environment
\end_layout
\end_inset
- are really only of use in layout files that are provided with \SpecialChar LyX
-, since text
- entered in user-created layout files will not be seen by \SpecialChar LyX
-'s internationalizatio
-n routines unless the
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-layouttranslations
+Bib_Environment
\end_layout
\end_inset
- file is modified accordingly.
- That said, however, any layout created with the intention that it will
- be included with \SpecialChar LyX
- should use these tags where appropriate.
- Please note that the paragraph style translations provided by \SpecialChar LyX
- will never
- change with a minor update (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-from version 2.1.x to 2.1.y).
- It is however quite likely that a major update (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-from 2.0.x to 2.1.y) will introduce new translations or corrections.
-\end_layout
-
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Floats"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-It is necessary to define the floats (
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-figure
+ and false for all other types.
\end_layout
-\end_inset
-
-,
-\begin_inset Flex MenuItem
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-table
+ParbreakIsNewline
\end_layout
\end_inset
-, \SpecialChar ldots
-) in the text class itself.
- Standard floats are included in the file
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdfloats.inc
-\end_layout
-
-\end_inset
-
-, so you may have to do no more than add
-\end_layout
-\begin_layout LyX-Code
-Input stdfloats.inc
+\emph on
+0
\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 \SpecialChar LyX
-), the information below will hopefully
- help you:
-\change_inserted -712698321 1432283506
+\end_inset
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Description
-\change_inserted -712698321 1432313622
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432283514
-AllowedPlacement
+1
\end_layout
\end_inset
- [
+] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
+ output,
+ but only by a line break; together with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432283507
-string
+PassThru 1
\end_layout
\end_inset
-=!htbpH] Allowed placement options for this float type.
- The value is a string of placement characters.
- Possible characters include:
-\emph on
-h
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-here if possible
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-t
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-top of page
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-b
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-bottom of page
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-p
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-page of floats
-\begin_inset Quotes erd
-\end_inset
-
-),
-\emph on
-H
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-here definitely
-\begin_inset Quotes erd
-\end_inset
-
-) and
-\emph on
-!
-\emph default
- (
-\begin_inset Quotes eld
-\end_inset
-
-ignore LaTeX rules
-\begin_inset Quotes erd
-\end_inset
-
-).
- The order of the characters in the string does not matter.
- If no placement options are allowed, use the string
-\emph on
-none
-\emph default
-.
+, this allows to emulate a plain text editor (like the ERT inset).
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1432313755
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313630
-AllowsSideways
+ParIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313646
-
-\emph off
-0
+string=""
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Newline newline
\end_inset
-\emph on
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313646
-
-\emph on
-1
+Parindent
\end_layout
\end_inset
-
-\emph default
-] Defines whether the float allows to be rotated via the rotfloat package
- (sidewaysfloat).
- Set to
+ 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
-
-\change_inserted -712698321 1432313721
-0
+NextNoIndent
\end_layout
\end_inset
- if the float does not support this feature.
+.
+ Also,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
\end_layout
-\begin_layout Description
+\end_inset
-\change_inserted -712698321 1432313802
+ style paragraphs inside environments use the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313759
-AllowsWide
+Parindent
\end_layout
\end_inset
- [
+ of the environment, not their native one.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313755
-
-\emph off
-0
+Standard
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
-\emph on
+ paragraphs inside an enumeration are not indented.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313755
-
-\emph on
-1
+ParSep
\end_layout
\end_inset
-
-\emph default
-] Defines whether the float has a starred variant that spans columns in
- a two column paragraph.
- Set to
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1432313755
-0
+float=0
\end_layout
\end_inset
- if the float does not support this feature.
-\change_unchanged
-
+] The vertical space between two paragraphs of this style.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Extension
+Parskip
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+float=0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+] \SpecialChar LyX
+ allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
+indent
\begin_inset Quotes erd
\end_inset
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- \SpecialChar LaTeX
- writes the captions to this file.
-\end_layout
+ or
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+skip
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-GuiName
-\end_layout
+ 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
-string
+Parskip
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ is ignored.
+ When
+\begin_inset Quotes eld
\end_inset
-
+skip
\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
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+ParIndent
\end_layout
\end_inset
- These tags control the XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+ is ignored and all paragraphs are separated by the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-IsPredefined
+Parskip
\end_layout
\end_inset
- [
-\emph on
-
+ argument.
+ The vertical space is calculated with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
-\end_layout
-
+Parskip
+\begin_inset space ~
\end_inset
+* DefaultHeight
+\end_layout
-\emph default
-,
-\begin_inset space \thinspace{}
\end_inset
-
+ where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+DefaultHeight
\end_layout
\end_inset
-] Indicates whether the float is already defined in the document class or
- if instead the \SpecialChar LaTeX
- package
+ is the height of a row with the normal font.
+ This way, the look stays the same with different screen fonts.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float
+PassThru
\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
-float
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
- is used.
- It should be set to
+
\begin_inset Flex Code
status collapsed
\end_inset
- if the float is already defined by the \SpecialChar LaTeX
- document class.
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ListCommand
+PassThruChars
\end_layout
\end_inset
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
+]
+\family typewriter
+
+\family default
+Defines individual characters that should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
+\end_layout
-] 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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+Preamble
\end_layout
\end_inset
- is false, since there is no standard way to generate this command.
- It is ignored if
+ Information to be included in the \SpecialChar 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
-UsesFloatPkg
+EndPreamble
\end_layout
\end_inset
- is true, since in that case there is a standard way to define the command.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ListName
+RefPrefix
\end_layout
\end_inset
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] A title for a list of floats of this kind (list of figures, tables, or
- whatever).
- It is used for the screen label within \SpecialChar LyX
-, it is used by \SpecialChar LaTeX
- for the title and
- it is used as the title in the XHTML output.
- It will be translated to the document language.
+] 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
status collapsed
\begin_layout Plain Layout
-NumberWithin
+Requires
\end_layout
\end_inset
\end_inset
-=
-\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
+] Whether the style requires the feature
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NumberWithin
+string
\end_layout
\end_inset
- is set to
-\begin_inset Quotes eld
-\end_inset
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
+\end_inset
+ for the list of features).
+ If you require a package with specific options, you can additionally use
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+PackageOptions
\end_layout
\end_inset
+ as a general text class parameter (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:General-text-class"
-\begin_inset Quotes erd
\end_inset
-, the floats will be numbered within chapters.
-
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Placement
+ResetArgs
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+1
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The default placement for the given class of floats.
- The string should be as in standard \SpecialChar LaTeX
-:
+] Resets the \SpecialChar LaTeX
+ arguments of this style (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-t
+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
-b
+CopyStyle
\end_layout
\end_inset
-,
+, but you do not want to inherit its (required and optional) arguments.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-p
+ResumeCounter
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-h
-\end_layout
-\end_inset
-
- 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
- \SpecialChar LaTeX
-.
+\emph on
+0
\end_layout
\end_inset
- On top of that there is a new type,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+1
\end_layout
\end_inset
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
-\end_inset
-
-here
-\begin_inset Quotes erd
-\end_inset
-
- and nowhere else.
- Note however that the
+] Resumes a counter that is usually reset at each new sequence of layouts.
+ This is currently only useful when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+LabelType
\end_layout
\end_inset
- specifier is special and, because of implementation details, cannot be
- used in non-built in float types.
- If you do not understand what this means, just use
-\begin_inset Quotes eld
-\end_inset
-
-
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tbp
+Enumerate
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
status collapsed
\begin_layout Plain Layout
-RefPrefix
+RightDelim
\end_layout
\end_inset
\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
+] 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
-RefPrefix
+<br/>
\end_layout
\end_inset
- set by a copied style by using the special value
-\begin_inset Quotes eld
-\end_inset
-
-OFF
-\begin_inset Quotes erd
-\end_inset
-
-, which must be all caps.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Style
+RightMargin
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+string=""
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The style used when defining the float using
+] Similar to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+LeftMargin
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Type
+Spacing
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+single
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+onehalf
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+double
+\end_layout
-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
+other
+\begin_inset space ~
+\end_inset
-\backslash
-newfloat
+<value>
\end_layout
\end_inset
-, commands such as
+] This defines what the default spacing should be in the style.
+ The arguments
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+single
\end_layout
\end_inset
- or
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{algorithm*}
+onehalf
\end_layout
\end_inset
- will be available.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+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
-0
+other
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\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
-
-\emph on
-1
+Spacing
\end_layout
\end_inset
-] Specifies whether this float is defined using the \SpecialChar LaTeX
+ implies the generation of specific \SpecialChar LaTeX
+ code, using the \SpecialChar LaTeX
package
+\family roman
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float
+setspace
\end_layout
\end_inset
-, either by the class file, another package or on-the-fly by \SpecialChar LyX
- itself.
+.
\end_layout
-\begin_layout Standard
-Note that defining a float with type
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+Spellcheck
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+0
\end_layout
\end_inset
-.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Flex-insets-and"
-\end_inset
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+\emph on
+1
\end_layout
-\begin_layout Standard
-Flex insets come in three different kinds:
+\end_inset
+
+] Allow spell-checking paragraphs of this style.
+ Default is true.
\end_layout
-\begin_layout Itemize
-character style (
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+StepMasterCounter
\end_layout
\end_inset
-): These define semantic markup corresponding to such \SpecialChar LaTeX
- commands as
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-noun
+\emph on
+0
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-code
+1
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Itemize
-user custom (
+] Steps the master counter of a given counter at the beginning of a new
+ sequence of layouts.
+ This is currently only useful when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Custom
+LabelType
\end_layout
\end_inset
-): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
- code,
- footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-endnote
+Enumerate
\end_layout
\end_inset
- module.
+.
\end_layout
-\begin_layout Itemize
-XML elements (
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Element
+TextFont
\end_layout
\end_inset
-): For use with DocBook classes.
+ The font used for the text body .
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-Flex insets are defined using the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+TocLevel
\end_layout
\end_inset
- tag, which shall be explained in a moment.
-\end_layout
-\begin_layout Standard
-The
+\series medium
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-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
-InsetLayout
+\series medium
+int=3
\end_layout
\end_inset
- can be used to customize the layout parameters for footnotes, marginal
- notes, note insets, \SpecialChar TeX
- code (ERT) insets, branches, listings, indexes, boxes,
- tables, algorithms, URLs, and captions, as well as to define Flex insets.
+]
+\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 Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+ToggleIndent
\end_layout
\end_inset
- definition must begin with a line of the form:
-\end_layout
-
-\begin_layout LyX-Code
-InsetLayout <type>
-\end_layout
+ [
+\emph on
-\begin_layout Standard
-Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+
+\emph on
+default
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are four
- cases.
-\end_layout
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
+\emph default
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+always
\end_layout
\end_inset
- any one of the following:
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+never
\end_layout
\end_inset
-,
+] This tag determines whether the first line indentation of this paragraph
+ can be toggled via the Paragraph settings dialog.
+ If
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+
+\emph off
+default
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Box
-\end_layout
+\emph default
+ is set, indentation can be toggled if the document settings use
+\begin_inset Quotes eld
+\end_inset
+indent
+\begin_inset Quotes erd
\end_inset
-,
+ paragraph style, with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+always
\end_layout
\end_inset
-,
+, indentation can always be toggled, notwithstanding the document settings,
+ with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Standard
+never
\end_layout
\end_inset
-,
+, indentation can never be toggled.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ERT
+TopSep
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Figure
+float=0
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Foot
+] 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
-\end_inset
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:I18n"
-,
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-Index
+Internationalization of Paragraph Styles
\end_layout
-\end_inset
+\begin_layout Standard
+\SpecialChar 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
-Info
+Style
\end_layout
\end_inset
-,
+ defines text that is to appear in the typeset document, it may use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:menu
+LangPreamble
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+BabelPreamble
\end_layout
\end_inset
-,
+ to support non-English and even multi-language documents correctly.
+ The following excerpt (from the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+theorems-ams.inc
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+ file) shows how this works:
+\end_layout
-\begin_layout Plain Layout
-Listings
+\begin_layout LyX-Code
+Preamble
\end_layout
-\end_inset
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
+\end_layout
-,
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
-\begin_layout Plain Layout
-Marginal
+\begin_layout LyX-Code
+EndPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
-,
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
-\begin_layout Plain Layout
-Note:Comment
+\begin_layout LyX-Code
+EndLangPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
-,
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
+
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+In principle, any legal \SpecialChar LaTeX
+ may appear in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+LangPreamble
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Greyedout
+BabelPreamble
\end_layout
\end_inset
-,
+ tags, but in practice they will typically look as they do here.
+ The key to correct translation of the typeset text is the definition of
+ the \SpecialChar LaTeX
+ command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Table
+
+\backslash
+claimname
\end_layout
\end_inset
-, or
+ and its use in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+
+\backslash
+newtheorem
\end_layout
\end_inset
.
+
\end_layout
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+LangPreamble
\end_layout
\end_inset
- must be of the form
-\begin_inset Quotes eld
-\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
-Flex:<name>
+Preamble
\end_layout
\end_inset
+ tag.
+ What makes it special is the use of the
+\begin_inset Quotes eld
+\end_inset
+function
\begin_inset Quotes erd
\end_inset
-, where
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-name
+_()
\end_layout
\end_inset
- may be be any valid identifier not used by a pre-existing Flex inset.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- Note that the definition of a flex inset
-\emph on
-must
-\emph default
-also include a
+, which will be replaced, when \SpecialChar LyX
+ produces \SpecialChar LaTeX
+ output, with the translation of
+ its argument into the document language.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+BabelPreamble
\end_layout
\end_inset
- entry, declaring which type of inset it defines.
-\end_layout
-
-\begin_layout Enumerate
-The layout for user specific branch is being defined.
- In this case,
+ 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
-<Type>
+babel
\end_layout
\end_inset
- must be of the form
-\begin_inset Quotes eld
-\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
-Branch:<name>
+_()
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-, where
+ will be replaced with its translation into the language in question; the
+ expression
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-name
+$$lang
\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 \SpecialChar LaTeX
- wrapping around specific
- branches as user needs.
+ is replaced by the language name (as used by the babel package).
\end_layout
-\begin_layout Enumerate
-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
-<Type>
+\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
- must be of the form
-\begin_inset Quotes eld
+
+\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
+\SpecialChar LaTeX
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:<name>
+babel
\end_layout
\end_inset
+ will then conspire to produce the correct text in the output.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-, where
+\begin_layout Standard
+One important point to note here is that the translations are provided by
+ \SpecialChar LyX
+ itself, through the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-name
+layouttranslations
\end_layout
\end_inset
- specifies the name of the caption as it appears in the menu.
- Have a look at the standard caption (
+.
+ This means, in effect, that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Standard
+LangPreamble
\end_layout
\end_inset
-), the specific captions of the KOMA-Script classes (
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Above
+BabelPreamble
\end_layout
\end_inset
-,
+ are really only of use in layout files that are provided with \SpecialChar LyX
+, since text
+ entered in user-created layout files will not be seen by \SpecialChar LyX
+'s internationalizatio
+n routines unless the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Caption:Below
+layouttranslations
\end_layout
\end_inset
-) or the module
-\family sans
-Multilingual
-\begin_inset space ~
+ file is modified accordingly.
+ That said, however, any layout created with the intention that it will
+ be included with \SpecialChar LyX
+ should use these tags where appropriate.
+ Please note that the paragraph style translations provided by \SpecialChar LyX
+ will never
+ change with a minor update (e.
+\begin_inset space \thinspace{}
\end_inset
-Captions
-\family default
-(
-\begin_inset Flex Code
-status collapsed
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Plain Layout
-Caption:Bicaption
-\end_layout
+from version 2.1.x to 2.1.y).
+ It is however quite likely that a major update (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-) for applications.
+from 2.0.x to 2.1.0) will introduce new translations or corrections.
\end_layout
-\begin_layout Standard
-The
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Floats"
\end_inset
- definition can contain the following entries:
+
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
+\begin_layout Standard
+It is necessary to define the floats (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Argument
+figure
\end_layout
\end_inset
- [
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-int
+table
\end_layout
\end_inset
-] Defines argument number of a command\SpecialChar breakableslash
-environment associated with the current
- layout.
- The definition must end with
+, \SpecialChar ldots
+) in the text class itself.
+ Standard floats are included in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndArgument
+stdfloats.inc
\end_layout
\end_inset
-.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
- for details.
+, so you may have to do no more than add
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-BabelPreamble
+\begin_layout LyX-Code
+Input stdfloats.inc
\end_layout
-\end_inset
-
- Preamble for changing language commands; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
-
-\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 \SpecialChar LyX
+), the information below will hopefully
+ help you:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-BgColor
+AllowedPlacement
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<name>
+string
\end_layout
\end_inset
-] The color for the inset's background.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:Names-of-colors"
-
+=!htbpH] Allowed placement options for this float type.
+ The value is a string of placement characters.
+ Possible characters include:
+\emph on
+h
+\emph default
+ (
+\begin_inset Quotes eld
\end_inset
- for a list of the available color names.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+here if possible
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-ContentAsLabel
-\end_layout
+),
+\emph on
+t
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+top of page
+\begin_inset Quotes erd
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+),
+\emph on
+b
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+bottom of page
+\begin_inset Quotes erd
+\end_inset
+),
\emph on
-0
-\end_layout
-
+p
+\emph default
+ (
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset space \thinspace{}
+page of floats
+\begin_inset Quotes erd
\end_inset
+),
+\emph on
+H
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
-\begin_inset Flex Code
-status collapsed
+here definitely
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-1
-\end_layout
+) and
+\emph on
+!
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+ignore LaTeX rules
+\begin_inset Quotes erd
\end_inset
-] Whether to use the content of the inset as the label, when the inset is
- closed.
- Default is false.
+).
+ The order of the characters in the string does not matter.
+ If no placement options are allowed, use the string
+\emph on
+none
+\emph default
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-CopyStyle
+AllowsSideways
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-<type>
-\end_layout
-
-\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
+\emph off
+0
+\end_layout
\end_inset
-.
- Note that you need to specify the complete type, e.
+,
\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space ~
+
+\emph on
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
\end_inset
+\emph default
+] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
+-package
+\family typewriter
+rotfloat
+\family default
+ (sidewaysfloat).
+ Set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle Flex:<name>
+0
\end_layout
\end_inset
-.
+ if the float does not support this feature.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-CustomPars
+AllowsWide
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
+\emph off
0
\end_layout
\end_inset
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
-\end_layout
-\begin_layout Description
+\emph default
+] Defines whether the float has a starred variant that spans columns in
+ a two column paragraph.
+ Set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+0
\end_layout
\end_inset
- can be
+ if the float does not support this feature.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+Extension
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+string
\end_layout
\end_inset
-, or
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Conglomerate
-\end_layout
+\begin_inset Quotes erd
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+] The file name extension of an auxiliary file for the list of figures (or
+ whatever).
+ \SpecialChar LaTeX
+ writes the captions to this file.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+GuiName
\end_layout
\end_inset
-, ERT insets generally
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+string
\end_layout
\end_inset
-, and character styles
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The string that will be used in the menus and also for the caption.
+ This is translated to the current language if babel is used.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+HTML*
\end_layout
+\end_inset
+
+ These tags control the XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+
\end_inset
.
status collapsed
\begin_layout Plain Layout
-Display
+IsPredefined
\end_layout
\end_inset
[
+\emph on
+
\begin_inset Flex Code
status collapsed
\end_inset
-,
-\emph on
+\emph default
+,
\begin_inset space \thinspace{}
\end_inset
-\emph default
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
1
\end_layout
\end_inset
-] Only useful if
+] Indicates whether the float is already defined in the document class or
+ if instead the \SpecialChar LaTeX
+ package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+float
\end_layout
\end_inset
- is
+ needs to be loaded to define it on-the-fly.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+0
\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 \SpecialChar LaTeX
- environment ignores white space
- (including one newline character) after the
+, which means:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}
+float
\end_layout
\end_inset
- and
+ is used.
+ It should be set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
-\end_layout
+1
+\end_layout
\end_inset
- tags.
- Default is true.
+ if the float is already defined by the \SpecialChar LaTeX
+ document class.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-End
+ListCommand
\end_layout
\end_inset
- Required at the end of the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+string
\end_layout
\end_inset
- declarations.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Font
-\end_layout
+\begin_inset Quotes erd
\end_inset
- The font used for both the text body
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' must be omitted.
+ This
\emph on
-and
+must
\emph default
- the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+UsesFloatPkg
\end_layout
\end_inset
- to the same value, so define this first and define
+ 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
-LabelFont
+UsesFloatPkg
\end_layout
\end_inset
- later if you want them to be different.
-\change_inserted -195340706 1421002157
-
+ is true, since in that case there is a standard way to define the command.
\end_layout
\begin_layout Description
-
-\change_inserted -195340706 1421002157
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1421002157
-FixedWidthPreambleEncoding
+ListName
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1421002157
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
\end_inset
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within \SpecialChar LyX
+, it is used by \SpecialChar 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
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1421002157
-1
+NumberWithin
\end_layout
\end_inset
-] Force a fixed width encoding for the translated contents of
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1421002157
-BabelPreamble
+string
\end_layout
\end_inset
- and
+=
+\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
+NumberWithin
+\end_layout
-\change_inserted -195340706 1421002157
-LangPreamble
+\end_inset
+
+ is set to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+chapter
\end_layout
\end_inset
- code generated by this layout.
- This is needed for special packages like the listings package that do not
- work with variable width encodings such as utf8.
- Default is false.
- This setting is ignored if fully unicode aware \SpecialChar LaTeX
- backends such as Xe\SpecialChar LaTeX
- are
- used.
-\change_unchanged
+\begin_inset Quotes erd
+\end_inset
+
+, the floats will be numbered within chapters.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ForceLocalFontSwitch
+Placement
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+=
+\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 \SpecialChar LaTeX
+:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+t
\end_layout
\end_inset
-] When using babel, always use a local font switch (
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-foreignlanguage
+b
\end_layout
\end_inset
-), never a global one (such as
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-selectlanguage
+p
\end_layout
\end_inset
-).
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+h
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
+\end_inset
+
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-ForceLTR
+Note that the order of these letters in the string is irrelevant, like in
+ \SpecialChar LaTeX
+.
\end_layout
\end_inset
- [
+ On top of that there is a new type,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+H
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
\end_inset
+here
+\begin_inset Quotes erd
+\end_inset
+ and nowhere else.
+ Note however that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+H
\end_layout
\end_inset
-] Force the
+ 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
-latex
-\begin_inset Quotes erd
-\end_inset
- language, leading to Left-to-Right (Latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tbp
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-in \SpecialChar TeX
- code or URL.
- A kludge.
-\change_inserted -712698321 1417441977
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1417442090
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417441983
-ForceOwnlines
+RefPrefix
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417441978
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+] The prefix to use when creating labels referring to floats of this type.
+ This allows the use of formatted references.
+ Note that you can remove any
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417441978
-1
+RefPrefix
\end_layout
\end_inset
-] Force a a line break in the \SpecialChar LaTeX
- output before the inset starts and after
- the inset ends.
- This assures the inset itself is output on its own lines, for parsing purposes.
+ set by a copied style by using the special value
+\begin_inset Quotes eld
+\end_inset
-\change_inserted 274215730 1419105878
- Default is false.
-\change_unchanged
+OFF
+\begin_inset Quotes erd
+\end_inset
+
+, which must be all caps.
+\change_inserted -712698321 1565605014
\end_layout
\begin_layout Description
+
+\change_inserted -712698321 1565605014
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+
+\change_inserted -712698321 1565605014
+Requires
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\end_layout
+\change_inserted -712698321 1565605014
+string
+\change_unchanged
+
+\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
\end_inset
+.
+\change_unchanged
+
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Style
\end_layout
\end_inset
-] Indicates whether the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PlainLayout
+string
\end_layout
\end_inset
- should be used or, instead, the user can change the paragraph style used
- in the inset.
- Default is false.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-FreeSpacing
-\end_layout
+\begin_inset Quotes erd
\end_inset
- [
+] The style used when defining the float using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+newfloat
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Type
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+string
\end_layout
\end_inset
- These tags control the XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
+=
+\begin_inset Quotes erd
+\end_inset
+
+\begin_inset Quotes erd
\end_inset
-.
-\end_layout
+] The
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
+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
-InToc
+
+\backslash
+newfloat
\end_layout
\end_inset
- [
+, commands such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+begin{program}
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\backslash
+end{algorithm*}
\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.
+ will be available.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+UsesFloatPkg
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex Code
status collapsed
\end_inset
-
-\emph default
,
\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+] Specifies whether this float is defined using the \SpecialChar LaTeX
+ package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+float
\end_layout
\end_inset
- The font used for the label.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
-
-\end_inset
+, either by the class file, another package or on-the-fly by \SpecialChar LyX
+ itself.
+\end_layout
-.
- Note that this definition can never appear before
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\emph on
+type
\end_layout
\end_inset
-, lest it be ineffective.
-\end_layout
-
-\begin_layout Description
+ automatically defines the corresponding counter with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\emph on
+type
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+.
\end_layout
-\end_inset
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Flex-insets-and"
-=
-\begin_inset Quotes erd
\end_inset
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-] What will be displayed on the button or elsewhere as the inset label.
- Some inset types (
+\begin_layout Standard
+Flex insets come in
+\change_deleted 5863208 1594239511
+three
+\change_inserted 5863208 1594239512
+two
+\change_unchanged
+ different kinds:
+\end_layout
+
+\begin_layout Itemize
+character style (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\SpecialChar TeX
- code
+CharStyle
\end_layout
\end_inset
- and
+): These define semantic markup corresponding to such \SpecialChar LaTeX
+ commands as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+
+\backslash
+noun
\end_layout
\end_inset
-) modify this label on the fly.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
-\end_layout
-
-\end_inset
- Language dependent preamble; see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:I18n"
+\backslash
+code
+\end_layout
\end_inset
.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+user custom (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Custom
\end_layout
\end_inset
- [
+): These can be used to define custom collapsible insets, similar to \SpecialChar 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
-<name>
+endnote
\end_layout
\end_inset
-] The name of the corresponding \SpecialChar LaTeX
- stuff.
- Either the environment or command name.
+ module.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+
+\change_deleted 5863208 1594239528
+XML elements (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+Element
\end_layout
\end_inset
- [
+): For use with DocBook classes.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<parameter>
+InsetLayout
\end_layout
\end_inset
-] The optional parameter for the corresponding
+ tag, which shall be explained in a moment.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+InsetLayout
\end_layout
\end_inset
- stuff, including possible bracket pairs like
+ tag also serves another function: It can be used to customize the general
+ layout of many different types of insets.
+ Currently,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+InsetLayout
\end_layout
\end_inset
-.
- This parameter cannot be changed from within \SpecialChar LyX
- (use
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, \SpecialChar TeX
+ code (ERT) insets, branches, listings, indexes, boxes,
+ tables, algorithms, URLs, and captions, as well as to define Flex insets.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+InsetLayout
\end_layout
\end_inset
- for customizable parameters).
- It will be output as is after all \SpecialChar LaTeX
-
+ definition must begin with a line of the form:
+\end_layout
+
+\begin_layout LyX-Code
+InsetLayout <type>
+\end_layout
+
+\begin_layout Standard
+Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+<Type>
\end_layout
\end_inset
-s.
+ indicates the inset whose layout is being defined, and here there are four
+ 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
-LatexType
+<Type>
\end_layout
\end_inset
- [
+ any one of the following:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command, Environment, None
+Algorithm
\end_layout
\end_inset
-] How the style should be translated into \SpecialChar LaTeX
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
-\end_layout
-
-\end_inset
-
- is perhaps a bit misleading, since these rules apply to SGML classes too.
- Visit the SGML class files for specific examples.
+Branch
\end_layout
\end_inset
-
-\begin_inset Separator parbreak
-\end_inset
-
-
-\end_layout
-
-\begin_deeper
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-None
+Box
\end_layout
\end_inset
- means nothing special
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+Box:shaded
\end_layout
\end_inset
- means
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar ldots
-}
+Caption:Standard
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+ERT
\end_layout
\end_inset
- means
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar ldots
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+Figure
\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Foot
\end_layout
-\begin_layout Standard
-Putting the last few things together, the \SpecialChar LaTeX
- output will be either:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
+,
+\begin_inset Flex Code
+status collapsed
-\backslash
-LatexName[LatexParam]{\SpecialChar ldots
-}
+\begin_layout Plain Layout
+Index
\end_layout
-\begin_layout Standard
-or:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
+,
+\begin_inset Flex Code
+status collapsed
-\backslash
-begin{LatexName}[LatexParam] \SpecialChar ldots
-
-\backslash
-end{LatexName}
+\begin_layout Plain Layout
+Info
\end_layout
-\begin_layout Standard
-depending upon the \SpecialChar LaTeX
- type.
-\end_layout
+\end_inset
-\end_deeper
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftDelim
+Info:menu
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Info:shortcut
\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
-<br/>
+Info:shortcuts
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyxType
+Listings
\end_layout
\end_inset
- Can be
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+Marginal
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-custom
+Note:Comment
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-element
+Note:Note
\end_layout
\end_inset
- or
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-end
+Note:Greyedout
\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
+Table
\end_layout
\end_inset
- to
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+URL
\end_layout
\end_inset
- will automatically set
+.
+\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
-MultiPar
+<Type>
\end_layout
\end_inset
- to false.
-
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+Flex:<name>
\end_layout
\end_inset
- can be set to true for
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+name
\end_layout
\end_inset
- insets by setting it
+ 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
-after
+must
\emph default
- you set the
+also include a
\begin_inset Flex Code
status collapsed
\end_inset
-.
+ entry, declaring which type of inset it defines.
\end_layout
-\begin_layout Description
+\begin_layout Enumerate
+The layout for user specific branch is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+<Type>
\end_layout
\end_inset
- [
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Branch:<name>
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
+\begin_inset Quotes erd
+\end_inset
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+name
\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
+ 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 \SpecialChar LaTeX
+ wrapping around specific
+ branches as user needs.
\end_layout
-\end_inset
-
- to the same value and
+\begin_layout Enumerate
+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
-ForcePlain
+<Type>
\end_layout
\end_inset
- to the opposite value.
- These can be reset to other values, if they are used
-\emph on
-after
-\emph default
-
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+Caption:<name>
\end_layout
\end_inset
-.
- Default is true.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+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
-
-\emph on
-0
+Caption:Standard
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+), the specific captions of the KOMA-Script classes (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Caption:Above
\end_layout
\end_inset
-] Whether fragile commands in this inset should be
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+Caption:Below
\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
-NoInsetLayout
-\end_layout
+) or the module
+\family sans
+Multilingual
+\begin_inset space ~
+\end_inset
+Captions
+\begin_inset Newline linebreak
\end_inset
- [
+
+\family default
+(
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<layout>
+Caption:Bicaption
\end_layout
\end_inset
-] Deletes an existing
+) for applications.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\end_inset
-.
-\change_inserted -712698321 1417953494
-
+ definition can contain the following entries:
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1417953559
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417953494
-ObsoletedBy
+AddToToc
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417953574
-<layout>
+string
\end_layout
\end_inset
-] Name of an
+=""] This inset will appear in the table of contents of the given type.
+ An empty string disables.
+ See also the OutlinerName and the IsTocCaption commands.
+ This is only implemented for Flex insets.
+ Default: disabled.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417953533
-InsetLayout
+Argument
\end_layout
\end_inset
- that has replaced this
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417953551
-InsetLayout
+int
\end_layout
\end_inset
-.
- This is used to rename an
+] Defines argument number of a command\SpecialChar breakableslash
+environment associated with the current
+ layout.
+ The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1417953559
-InsetLayout
+EndArgument
\end_layout
\end_inset
-, while keeping backward compatibility.
-\change_unchanged
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+ for details.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+BabelPreamble
\end_layout
\end_inset
- [
+ Preamble for changing language commands; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+BgColor
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+<name>
\end_layout
\end_inset
-] As with paragraph styles, see
+] The color for the inset's background.
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:Paragraph-Styles"
+reference "chap:Names-of-colors"
\end_inset
-.
- Default is false.
+ for a list of the available color names.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+ContentAsLabel
\end_layout
\end_inset
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
+] Whether to use the content of the inset as the label, when the inset is
+ closed.
Default is false.
\end_layout
status collapsed
\begin_layout Plain Layout
-Preamble
-\end_layout
-
-\end_inset
-
- As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-RefPrefix
+CopyStyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<type>
\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
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-Requires
-\end_layout
+.
+ 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
-string
+CopyStyle Flex:<name>
\end_layout
\end_inset
-] As with paragraph styles, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Paragraph-Styles"
-
-\end_inset
-
.
\end_layout
status collapsed
\begin_layout Plain Layout
-ResetArgs
+CustomPars
\end_layout
\end_inset
\end_inset
-] Resets the \SpecialChar LaTeX
- arguments of this layout (as defined via the
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Argument
+Decoration
\end_layout
\end_inset
- tag).
- This is useful if you have copied a style via
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+Classic
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
-\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
+Minimalistic
\end_layout
\end_inset
-,
-\begin_inset space \thinspace{}
-\end_inset
-
-
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Conglomerate
\end_layout
\end_inset
-] Whether this inset should use the font of its surrounding environment
- or uses its own.
- Default is false: use the font of the surrounding environment.
-\end_layout
-
-\begin_layout Description
+, 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
-RightDelim
+Classic
\end_layout
\end_inset
- [
+, ERT insets generally
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Minimalistic
\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
+, and character styles
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<br/>
+Conglomerate
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Spellcheck
+Display
\end_layout
\end_inset
\end_inset
,
+\emph on
+
\begin_inset space \thinspace{}
\end_inset
+\emph default
+
\begin_inset Flex Code
status collapsed
\end_inset
-] Allow spell-checking the contents of this inset.
- Default is true.
-\end_layout
+] Only useful if
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Counters"
+\begin_layout Plain Layout
+LatexType
+\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-It is necessary to define the counters (
-\begin_inset Flex MenuItem
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+Environment
\end_layout
\end_inset
-,
-\begin_inset Flex MenuItem
+.
+ 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 \SpecialChar LaTeX
+ environment ignores white space
+ (including one newline character) after the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-, \SpecialChar ldots
-) in the text class itself.
- The standard counters are defined in the file
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
+ tags.
+ Default is true.
+\change_inserted 731793113 1538674858
-\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:
+\begin_layout Description
+
+\change_inserted 731793113 1538674891
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+
+\change_inserted 731793113 1538674863
+EditExternal
+\change_unchanged
+
\end_layout
-\begin_layout LyX-Code
-Counter CounterName
+\end_inset
+
+ [
+\emph on
+0
+\emph default
+,1] Allow the contents of the inset to be edited externally (using whatever
+ editor is defined for the document's output format).
+\change_unchanged
+
\end_layout
-\begin_layout Standard
-where of course `
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+End
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
+ Required at the end of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
\end_inset
+ declarations.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+Font
\end_layout
\end_inset
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-\begin_inset Quotes erd
\end_inset
.
- The following parameters can also be used:
-\end_layout
-
-\begin_layout Description
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InitialValue
+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
-int=1
+LabelFont
\end_layout
\end_inset
-] Sets the initial value for the counter, to which it will be reset whenever
- that happens.
- Normally, one will want the default, 1.
+ later if you want them to be different.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+FixedWidthPreambleEncoding
\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
-
-] 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
+1
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
-\begin_inset Separator parbreak
-\end_inset
-
-
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+] Force a fixed width encoding for the translated contents of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+BabelPreamble
\end_layout
\end_inset
- will be replaced by the expansion of the
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+LangPreamble
\end_layout
\end_inset
- (or
+ code generated by this layout.
+ This is needed for special \SpecialChar LaTeX
+-packages like
+\family typewriter
+listings
+\family default
+ that do not work with variable width encodings such as
+\family sans
+utf8
+\family default
+.
+ This setting is ignored if fully Unicode aware \SpecialChar LaTeX
+ backends such as Xe\SpecialChar TeX
+ or
+ Lua\SpecialChar TeX
+ are used.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+ForceLocalFontSwitch
\end_layout
\end_inset
-) of the counter
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-counter
+
+\emph on
+0
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Itemize
-counter values can be expressed using \SpecialChar LaTeX
--like macros
-\begin_inset Newline newline
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+1
\end_layout
\end_inset
-, where
+] When using babel, always use a local font switch (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-numbertype
+\backslash
+foreignlanguage
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+), never a global one (such as
+\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.
+\backslash
+selectlanguage
\end_layout
\end_inset
-
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+ForceLTR
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar ldots
-;
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+
+\emph on
+0
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar ldots
-;
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+1
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar ldots
-;
+] Force the
+\begin_inset Quotes eld
+\end_inset
+
+latex
+\begin_inset Quotes erd
+\end_inset
+
+ language, leading to Left-to-Right (Latin) output, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+in \SpecialChar TeX
+ code or URL.
+ A kludge.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+ForceOwnlines
\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
+
+\emph on
+0
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar ldots
-;
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+1
\end_layout
\end_inset
- for hebrew numerals.
+] Force a a line break in the \SpecialChar LaTeX
+ output before the inset starts and after
+ the inset ends.
+ This assures the inset itself is output on its own lines, for parsing purposes.
\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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+ForcePlain
\end_layout
\end_inset
- (defined via
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+
+\emph on
+0
\end_layout
\end_inset
-), the string
-\begin_inset Newline newline
+,
+\begin_inset space \thinspace{}
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
+1
\end_layout
\end_inset
- is used; otherwise the string
+] Indicates whether the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
+PlainLayout
\end_layout
\end_inset
- is used.
+ should be used or, instead, the user can change the paragraph style used
+ in the inset.
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+FreeSpacing
\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
-
-] Same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
-, but for use in the Appendix.
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PrettyFormat
+HTML*
\end_layout
\end_inset
- [
+ These tags control the 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
-string
+InToc
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
+\emph on
+0
+\end_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
-Section 2.4
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\end_inset
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
-##
-\begin_inset Quotes erd
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane for all table of contents, regardless of the AddToToc
+ setting.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Within
+IsTocCaption
\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
-] 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,
+] If this is set to 1 and AddToToc is enabled, the inset adds a summary
+ of its contents in its item in the table of contents.
+ Otherwise, only the label appears.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+KeepEmpty
\end_layout
\end_inset
- is numbered inside
+ [
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
+0
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec: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_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-The following commands are available:
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+1
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\begin_layout Plain Layout
+\end_inset
-\emph on
-none
+.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+LabelFont
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-white
-\end_layout
+ The font used for the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
\end_inset
-,
+.
+ Note that this definition can never appear before
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+Font
\end_layout
\end_inset
-,
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+LabelString
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-blue
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-cyan
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] 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
-magenta
+\SpecialChar TeX
+ code
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
+Branch
\end_layout
\end_inset
-]
+) modify this label on the fly.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Family
+LangPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
+ Language dependent preamble; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
-\begin_layout Plain Layout
+\end_inset
-\emph on
-Roman
+.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sans
+LatexName
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+<name>
\end_layout
\end_inset
-]
+] The name of the corresponding \SpecialChar LaTeX
+ stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Misc
+LatexParam
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<parameter>
\end_layout
\end_inset
-] Valid arguments are:
+] The optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+LatexName
\end_layout
\end_inset
-,
+ stuff, including possible bracket pairs like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-noun
+[]
\end_layout
\end_inset
-,
+.
+ This parameter cannot be changed from within \SpecialChar LyX
+ (use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-strikeout
+Argument
\end_layout
\end_inset
-,
+ for customizable parameters).
+ It will be output as is after all \SpecialChar LaTeX
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-underbar
+Argument
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-uuline
+s.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uwave
+LatexType
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+Command, Environment, None
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+] How the style should be translated into \SpecialChar LaTeX
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-no_noun
-\end_layout
-
-\end_inset
-
-,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_strikeout
+LatexType
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-no_bar
+ 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
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-no_uuline
\end_layout
-\end_inset
-
- and
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uwave
+None
\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
+ means nothing special
\end_layout
-\end_inset
-
- turns on emphasis, and
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+Command
\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
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar ldots
+}
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Series
+Environment
\end_layout
\end_inset
- [
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+\backslash
+begin{
\emph on
-Medium
-\end_layout
+LatexName
+\emph default
+}\SpecialChar ldots
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Bold
\end_layout
-\end_inset
-
-]
+\begin_layout Standard
+Putting the last few things together, the \SpecialChar LaTeX
+ output will be either:
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-Shape
+\backslash
+LatexName[LatexParam]{\SpecialChar ldots
+}
\end_layout
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
+or:
+\end_layout
-\begin_layout Plain Layout
+\begin_layout LyX-Code
-\emph on
-Up
+\backslash
+begin{LatexName}[LatexParam] \SpecialChar ldots
+
+\backslash
+end{LatexName}
\end_layout
-\end_inset
+\begin_layout Standard
+depending upon the \SpecialChar LaTeX
+ type.
+\end_layout
-,
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Italic
+LeftDelim
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SmallCaps
+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
-Slanted
+<br/>
\end_layout
\end_inset
-]
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Size
+LyxType
\end_layout
\end_inset
- [
+ Can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tiny
+charstyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-small
+custom
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-normal
+element
\end_layout
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+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
-larger
+LyxType
\end_layout
\end_inset
-,
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+charstyle
\end_layout
\end_inset
-,
+ will automatically set
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-huge
+MultiPar
\end_layout
\end_inset
-,
+ to false and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
+ForcePlain
\end_layout
\end_inset
-]
-\end_layout
+ to true.
+
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Citation-format-description"
+\begin_layout Plain Layout
+MultiPar
+\end_layout
\end_inset
-Citation format description
-\end_layout
-
-\begin_layout Standard
-The
+ can be set to true, or
\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 \SpecialChar 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
+ to false, for
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- book ...
+\begin_layout Plain Layout
+charstyle
\end_layout
-\begin_layout LyX-Code
-End
-\end_layout
+\end_inset
-\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 Bib\SpecialChar TeX
- file.
- \SpecialChar LyX
- defines a default format in the source code that will be used if no specific
- definition has been given.
- \SpecialChar LyX
- predefines several formats in the file
+ insets by setting it
+\emph on
+after
+\emph default
+ you set the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+LyxType
\end_layout
\end_inset
-, which is included in most of \SpecialChar LyX
-'s document classes.
+.
+\change_inserted -712698321 1555575738
+
\end_layout
-\begin_layout Standard
-The definitions use a simple language that allows Bib\SpecialChar TeX
- keys to be replaced
- with their values.
- Keys should be enclosed in
+\begin_layout Description
+
+\change_inserted -712698321 1555575844
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+
+\change_inserted -712698321 1555575740
+MenuString
+\change_unchanged
+
\end_layout
\end_inset
- signs, e.g.:
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
-\end_layout
-\end_inset
+\change_inserted -712698321 1555575740
+[string]
+\change_unchanged
-.
- So a simple definition might look like this:
\end_layout
-\begin_layout LyX-Code
-misc %author%,
+\end_inset
+
+ A dedicated 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
-%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
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
-{%volume%[[vol.
-\begin_inset space ~
+g.
+\begin_inset space \space{}
\end_inset
-%volume%]]}
-\end_layout
+\begin_inset Quotes eld
\end_inset
-.
- This says: If the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
-\end_layout
-\end_inset
+\change_inserted -712698321 1555575781
+My Inset|M
+\change_unchanged
- key exists, then print
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-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
+).
+ This specification is optional.
+ If it is not given the inset name as specified in the type declaration
+ will be used instead for the menu.
+\change_unchanged
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%author%[[%author%]][[%editor%, ed.]]}
+MultiPar
\end_layout
\end_inset
-.
-\begin_inset Newline newline
-\end_inset
-
-Here, the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+
+\emph on
+0
\end_layout
\end_inset
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\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
-%
+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 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_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+ForcePlain
+\end_layout
- and
-\begin_inset Quotes eld
\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
-
-\begin_inset Quotes erd
-\end_inset
-
.
- There must be no space between any of these.
+ Default is true.
\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>!}
+NeedProtect
\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
+ [
+\begin_inset Flex Code
+status collapsed
-.
- 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_layout Plain Layout
-{!
-\begin_inset Quotes erd
-\end_inset
+\emph on
+0
+\end_layout
- and
-\begin_inset Quotes eld
\end_inset
-!}
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\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
+1
\end_layout
\end_inset
- block.
- An example of the first would be:
-\end_layout
+] Whether fragile commands in this inset should be
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-!quotetitle
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+
+\backslash
+protect
+\end_layout
-%title%
-\begin_inset Quotes erd
\end_inset
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.) Default is false.
+\change_inserted -712698321 1523633958
\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_layout Description
+
+\change_inserted -712698321 1552395786
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+
+\change_inserted -712698321 1523633961
+NeedCProtect
+\change_unchanged
+
\end_layout
\end_inset
-.
- \SpecialChar LyX
- will treat
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
-\end_layout
-\end_inset
+\change_inserted -712698321 1523633958
- exactly as it would treat its definition.
- So, let us issue the obvious
\emph on
-warning
-\emph default
-.
- Do not do this:
-\end_layout
+0
+\change_unchanged
-\begin_layout LyX-Code
-!funfun %funfun%
\end_layout
-\begin_layout Standard
-or anything like it.
- \SpecialChar LyX
- shouldn't go into an infinite loop, but it may go into a long one before
- it gives up.
-\end_layout
+\end_inset
-\begin_layout Standard
-The second sort of special definition might look like this:
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\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%
+
+\change_inserted -712698321 1523633958
+1
+\change_unchanged
+
\end_layout
\end_inset
-.
- Several of these are predefined in
+] This causes macros that contain this inset to be protected with
\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
+\change_inserted -712698321 1523634038
+\backslash
+cprotect
+\change_unchanged
\end_layout
-\begin_layout Standard
-\noindent
+\end_inset
-\family typewriter
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+ (cf.
+ package
+\family sans
+cprotect
+\family default
+) if necessary and thus allows (some) verbatim stuff in macros.
+ Default is false.
\end_layout
-\begin_layout Standard
-\begin_inset VSpace defskip
-\end_inset
+\begin_layout Description
-This defines a macro that prints the author, followed by a comma, if the
-
+\change_inserted -712698321 1555579651
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+
+\change_inserted -712698321 1552395787
+NeedMBoxProtect
+\change_unchanged
+
\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
+
+\change_inserted -712698321 1552395787
+
+\emph on
+0
+\change_unchanged
+
\end_layout
\end_inset
- or its translation (it is by default
-\begin_inset Quotes eld
+,
+\begin_inset space \thinspace{}
\end_inset
-ed.
-\begin_inset Quotes erd
-\end_inset
-), if the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-editor
+
+\change_inserted -712698321 1552395787
+1
+\change_unchanged
+
\end_layout
\end_inset
- key is defined.
- Note that this is in fact defined in
+] Whether specific commands in this inset (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+
+\change_inserted -712698321 1552395787
+
+\backslash
+cite
+\change_unchanged
+
\end_layout
\end_inset
-, so you can use it in your own definitions, or re-definitions, if you load
- that file first.
-\end_layout
+ and
+\begin_inset Flex Code
+status collapsed
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Tags-for-XHTML"
+\begin_layout Plain Layout
-\end_inset
+\change_inserted -712698321 1552395787
+
+\backslash
+ref
+\change_unchanged
-Tags for XHTML output
\end_layout
-\begin_layout Standard
-As with \SpecialChar LaTeX
- or DocBook, the format of \SpecialChar LyX
-'s XHTML output is also controlled by
- layout information.
- In general, \SpecialChar LyX
- provides sensible defaults and, as mentioned earlier, it will
- even construct default CSS style rules from the other layout tags.
- For example, \SpecialChar LyX
- will attempt to use the information provided in the
+\end_inset
+
+) should be protected in an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\change_inserted -712698321 1552395787
+
+\backslash
+mbox
+\change_unchanged
+
\end_layout
\end_inset
- declaration for the Chapter style to write CSS that will appropriately
+.
+ This is particularly needed for insets that draw on
+\family sans
+ulem
+\family default
+ or
+\family sans
+soul
+\family default
+ commands which parse their content in complex ways.
+ Default is false.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1555579742
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579658
+NewlineCmd
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579651
+[string]
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ Option to define a different command (from the default
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1555579742
+
+\backslash
+
+\backslash
+
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+) to be used for line breaks.
+ The initial backslash must not be specified.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NoInsetLayout
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<layout>
+\end_layout
+
+\end_inset
+
+] Deletes an existing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ObsoletedBy
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<layout>
+\end_layout
+
+\end_inset
+
+] Name of an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ that has replaced this
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+.
+ This is used to rename an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+, while keeping backward compatibility.
+\change_inserted -712698321 1559491850
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -712698321 1559492002
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491854
+ParbreakIgnored
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+
+\emph on
+0
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491850
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] If this is set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1559491881
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, paragraph breaks will be ignored in the output.
+ This might be useful for insets where the content should be alignable on
+ different lines only in the \SpecialChar LyX
+ workarea, without any effect in the output.
+\change_unchanged
+
+\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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec: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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec: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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec: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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ResetArgs
+\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
+
+] Resets the \SpecialChar LaTeX
+ arguments of this layout (as defined via the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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
+CopyStyle
+\end_layout
+
+\end_inset
+
+, but you do not want to inherit its (required and optional) arguments.
+\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
+
+\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
+
+]
+\change_inserted -712698321 1597733473
+If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597732178
+1
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, font changes are redone inside the respective inset (in the output) even
+ if the inset itself is in the context of this font changes (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733683
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{
+\backslash
+textbf{content}}\SpecialChar ldots
+}
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+ rather than
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733686
+
+\backslash
+textbf{Sourrounding text
+\backslash
+myinset{content}\SpecialChar ldots
+}
+\end_layout
+
+\end_inset
+
+.
+ Setting this makes sense for commands that internally reset font settings
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., footnotes).
+ Note that wrongly setting this might lead to unwanted result (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733688
+
+\backslash
+emph{Sourrounding text
+\backslash
+myinset{
+\backslash
+emph{content}}\SpecialChar ldots
+}
+\end_layout
+
+\end_inset
+
+, content is upright, as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733278
+
+\backslash
+emph
+\end_layout
+
+\end_inset
+
+ toggles.
+
+\change_deleted -712698321 1597733283
+Whether this inset should use the font of its surrounding environment or
+ uses its own.
+
+\change_unchanged
+Default is
+\change_deleted -712698321 1597733290
+false
+\change_inserted -712698321 1597733290
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1597733292
+0
+\end_layout
+
+\end_inset
+
+
+\change_unchanged
+:
+\change_deleted -712698321 1597733327
+use the font of the surrounding environment
+\change_inserted -712698321 1597733343
+font changes are not redone inside the inset
+\change_unchanged
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RightDelim
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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
+<br/>
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Spellcheck
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset 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 "subsec:Counters"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+chapter
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Noun
+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
+InitialValue
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=1
+\end_layout
+
+\end_inset
+
+] Sets the initial value for the counter, to which it will be reset whenever
+ that happens.
+ Normally, one will want the default, 1.
+\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 \SpecialChar 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 "subsec: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
+
+\family roman
+or
+\family default
+\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
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+brown
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+darkgray
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+gray
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lightgray
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lime
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+orange
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+olive
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+pink
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+purple
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+teal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+violet
+\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 "subsec:Citation-engine-description"
+
+\end_inset
+
+Cite engine description
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ blocks, as used mainly in cite engine files (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+), define the citation commands provided by a specific
+\begin_inset Quotes eld
+\end_inset
+
+cite engine
+\begin_inset Quotes erd
+\end_inset
+
+.
+ A cite engine, in \SpecialChar LyX
+ terms, is way specific way to format citations, using
+ numbers, author names and/or years.
+ Currently, \SpecialChar LyX
+ supports three such engine types, namely:
+\end_layout
+
+\begin_layout Enumerate
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+default
+\end_layout
+
+\end_inset
+
+: the default Bib\SpecialChar TeX
+ way to format citations, a simple numeric style (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+[1]
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Enumerate
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+authoryear
+\end_layout
+
+\end_inset
+
+: Harvard-styled citations using author names and publication year (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+Smith and Miller (2017b)
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Enumerate
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+numerical
+\end_layout
+
+\end_inset
+
+: extended numerical citations that also allow for author or title next
+ to the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+Smith and Miller [1]
+\begin_inset Quotes erd
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ blocks look like this:
+\end_layout
+
+\begin_layout LyX-Code
+CiteEngine default
+\end_layout
+
+\begin_layout LyX-Code
+ cite
+\end_layout
+
+\begin_layout LyX-Code
+ Citep*[][]
+\end_layout
+
+\begin_layout LyX-Code
+ citeyearpar[][]=parencite*
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+The tag following
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteEngine
+\end_layout
+
+\end_inset
+
+ denotes the engine.
+ The individual lines respectively define a cite command or cite command
+ paradigm supported by this engine.
+ The line can be as simple as a cite command that is used both to name the
+ respective \SpecialChar LyX
+ command and the \SpecialChar LaTeX
+ output or more complex in order to differentiate
+ things.
+ The full syntax is:
+\end_layout
+
+\begin_layout LyX-Code
+LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+: The name as used in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.lyx
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+For portability reasons, we try to use the same name for same-formatted
+ commands in different cite packages (thus many names stem from natbib,
+ and thus we need to differentiate a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ sometimes, if the \SpecialChar LaTeX
+ command names differ).
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alias
+\end_layout
+
+\end_inset
+
+: a (comma-separated) list of commands that fall back to the given
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+ in the current engine.
+ This eases the switch of citation packages and engines.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alias
+\end_layout
+
+\end_inset
+
+ can be compared to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ObsoletedBy
+\end_layout
+
+\end_inset
+
+ in layout definitions.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+: The actual \SpecialChar LaTeX
+ command that is output.
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alias
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ are optional.
+ If no
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latexcmd
+\end_layout
+
+\end_inset
+
+ is given, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXName
+\end_layout
+
+\end_inset
+
+ will be output to \SpecialChar LaTeX
+.
+\end_layout
+
+\begin_layout Standard
+Note further:
+\end_layout
+
+\begin_layout Itemize
+Capitalization indicates that the command also has a capitalized form (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+Latexcmd
+\end_layout
+
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
+\end_layout
+
+\end_inset
+
+).
+ These usually enforce up-casing of name prefixes (
+\emph on
+von Goethe
+\emph default
+
+\begin_inset Formula $\Rightarrow$
+\end_inset
+
+
+\emph on
+Von Goethe
+\emph default
+).
+\end_layout
+
+\begin_layout Itemize
+Brackets
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[]
+\end_layout
+
+\end_inset
+
+ indicate the number of optional arguments (there can be 0–2).
+\end_layout
+
+\begin_layout Itemize
+A star
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*
+\end_layout
+
+\end_inset
+
+ indicates there is a starred version of the command (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd*
+\end_layout
+
+\end_inset
+
+ vs.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+latexcmd
+\end_layout
+
+\end_inset
+
+).
+
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+By default, the starred version means: Output all authors even if it should
+ be shortened with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+ due to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ threshold.
+\end_layout
+
+\begin_layout Standard
+If the star has a different meaning for a given command, it can be specified
+ in angle brackets:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<!_stardesc!_stardesctooltip>
+\end_layout
+
+\end_inset
+
+.
+ Maximal two translatable macro keywords, marked by the prefix
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!_
+\end_layout
+
+\end_inset
+
+, can be given.
+ The first points to the string that replaces the
+\begin_inset Quotes eld
+\end_inset
+
+Full aut&hor list
+\begin_inset Quotes erd
+\end_inset
+
+ checkbox label in the citation dialog, the second one to an optional tool
+ tip for this checkbox.
+
+\end_layout
+
+\begin_layout Standard
+Note that these two macros have to be defined in a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ (see next section), dropping the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!
+\end_layout
+
+\end_inset
+
+ from the prefix, like this:
+\end_layout
+
+\begin_layout LyX-Code
+_stardesc Sta&rred command label
+\end_layout
+
+\begin_layout LyX-Code
+_stardesctooltip Tooltip for the starred command checkbox.
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+A dollar sign
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$
+\end_layout
+
+\end_inset
+
+ indicates that this command features
+\begin_inset Quotes eld
+\end_inset
+
+qualified citation lists
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This is a
+\family sans
+Biblatex
+\family default
+-specific feature for multi-reference citations where an individual pre-
+ and postnote can be given to each reference in the list.
+ Please refer to the
+\family sans
+Biblatex
+\family default
+ manual for details.
+\change_inserted -712698321 1526898670
+
+\end_layout
+
+\begin_layout Standard
+
+\change_inserted -712698321 1526899524
+If you want to add a cite command to a cite engine (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., add a specific command provided by a class), you can use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -712698321 1526898768
+AddToCiteEngine <engine type> \SpecialChar ldots
+ End
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+.
+ Note that only cite commands that do not exist yet are added.
+\change_unchanged
+
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-format-description"
+
+\end_inset
+
+Cite 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 \SpecialChar 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
+or
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\begin_layout LyX-Code
+ cite ...
+\end_layout
+
+\begin_layout LyX-Code
+ citet*[][] ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+In the first case, the individual lines define how the bibliographic information
+ associated with an article or book, respectively, is to be displayed, and
+ such a definition can be given for any
+\begin_inset Quotes els
+\end_inset
+
+entry type
+\begin_inset Quotes ers
+\end_inset
+
+ that might be present in a Bib\SpecialChar TeX
+ file.
+ \SpecialChar LyX
+ defines a default format in the source code that will be used if no specific
+ definition has been given.
+ \SpecialChar 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 \SpecialChar LyX
+'s document classes.
+\end_layout
+
+\begin_layout Standard
+In the second case, the lines define how a specific citation command (in
+ the example
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+cite
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+citet
+\end_layout
+
+\end_inset
+
+) is to be displayed on the citation inset label, in the citation dialog,
+ menu or XHTML output.
+ \SpecialChar LyX
+ defines such formats for the citation style variants it supports via
+\family sans
+Document\SpecialChar menuseparator
+Setting\SpecialChar menuseparator
+Bibliography\SpecialChar ldots
+
+\family default
+ in specific
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files that are shipped with \SpecialChar LyX
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Cite-Engine-Files"
+plural "false"
+caps "false"
+noprefix "false"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Standard
+The definitions use a simple language that allows Bib\SpecialChar TeX
+ 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
+Next to the entry keys, there are some special keys that can be used for
+ these conditionals:
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%dialog%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part for dialogs and menus, the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part for other contexts (workarea, export)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%export%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part for export and menus, the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part for other contexts (workarea, dialog)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%next%[[true]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if another item follows (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in a citation with multiple keys)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%second%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if this is the second of multiple items, else the
+\begin_inset Quotes eld
+\end_inset
+
+false
+\begin_inset Quotes erd
+\end_inset
+
+ part
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifstar%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part for starred citation commands (such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+cite*
+\end_layout
+
+\end_inset
+
+), the false part for unstarred
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:<type>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current entry type matches
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<type>
+\end_layout
+
+\end_inset
+
+, else the false part (e.g., in a citation definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifentrytype:book%[[this is a book]][[this is no book]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:<authortype>%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ if the current author type (author, editor etc.) has multiple authors, else
+ the false part (e.g., in a bibliography definition:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifmultiple:editor%[[eds.]][[ed.]]}
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%ifqualified%[[true]][[false]]}
+\end_layout
+
+\end_inset
+
+: process the
+\begin_inset Quotes eld
+\end_inset
+
+true
+\begin_inset Quotes erd
+\end_inset
+
+ part if the current citation is a qualified citation list (a specific
+\family sans
+Biblatex
+\family default
+ format for multi-reference citations), the false part if this is not the
+ case.
+\end_layout
+
+\begin_layout Standard
+We said that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+ prints the author key as it is recorded in the bibliography file.
+ This might not be what you want, since it will result in a string such
+ as
+\begin_inset Quotes eld
+\end_inset
+
+Miller, Peter and Smith, Mary and White, Jane
+\begin_inset Quotes erd
+\end_inset
+
+ (since
+\begin_inset Quotes eld
+\end_inset
+
+and
+\begin_inset Quotes erd
+\end_inset
+
+ is used by Bib\SpecialChar TeX
+ to delimit authors).
+ \SpecialChar LyX
+ therefore provides some methods to get properly formatted name lists (which
+ will also get translated).
+ The following keys are provided:
+\end_layout
+
+\begin_layout Enumerate
+For name lists with pre- and surname, suitable for the main authors/editors
+ of a bibliography item.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype>
+\end_layout
+
+\end_inset
+
+ part denotes the kind of list that is requested (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype:author>
+\end_layout
+
+\end_inset
+
+):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%forceabbrvnames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Alternative name lists with pre- and surname, if the order of pre- and surname
+ inside the bibliography item differs (as in:
+\begin_inset Quotes eld
+\end_inset
+
+Miller, John: Some text, in: Mary Smith, ed.: A volume
+\begin_inset Quotes erd
+\end_inset
+
+):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%forceabbrvbynames:<nametype>%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+And finally name lists which consist of family names only, as used in author-yea
+r citation labels.
+ These do not take a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<nametype>
+\end_layout
+
+\end_inset
+
+ part, but always return either an author list or, if this does not exist,
+ an editor list (as common in author-year labels):
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%abbrvciteauthor%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) when
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+ is reached.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%fullciteauthor%
+\end_layout
+
+\end_inset
+
+: Provides a full name list (never abbreviated with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%forceabbrvciteauthor%
+\end_layout
+
+\end_inset
+
+: Provides a name list which is always abbreviated (with
+\begin_inset Quotes eld
+\end_inset
+
+et al.
+\begin_inset Quotes erd
+\end_inset
+
+) irrespective of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MaxCiteNames
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+The order of pre- and surname in the former two lists can be adjusted by
+ these macros:
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!firstnameform %surname%, %prename%
+\end_layout
+
+\end_inset
+
+ (first author in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!othernameform %surname%, %prename%
+\end_layout
+
+\end_inset
+
+ (other authors in lists of type 1)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!firstbynameform %prename% %surname%
+\end_layout
+
+\end_inset
+
+ (first author in lists of type 2)
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+!otherbynameform %prename% %surname%
+\end_layout
+
+\end_inset
+
+ (other authors in lists of type 2)
+\end_layout
+
+\begin_layout Standard
+This allows you to configure namings like
+\begin_inset Quotes eld
+\end_inset
+
+Miller, Peter and Mary Smith: \SpecialChar ldots
+, in: John Doe and Pat Green, eds.:\SpecialChar ldots
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\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
+
+.
+ \SpecialChar 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.
+ \SpecialChar 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
+B_pptext pp.
+\end_layout
+
+\begin_layout Standard
+This defines a translatable piece of text, which allows relevant parts of
+ the bibliography or citation 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
+%B_pptext%
+\end_layout
+
+\end_inset
+
+.
+ Note that there are two different translation paths: All definitions starting
+ with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+B_
+\end_layout
+
+\end_inset
+
+, such as in the example above, will be translated to the currently active
+ buffer language (so the translation will match the generated document).
+ All definitions starting with underscore only will be translated to the
+ GUI language.
+ This is the proper translation for strings that only occur in the dialogs
+ or on buttons, such as this one:
+\end_layout
+
+\begin_layout LyX-Code
+_addtobib Add to bibliography only.
+\end_layout
+
+\begin_layout Standard
+Several of these translatable strings are predefined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+ and the diverse
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+*.citeengine
+\end_layout
+
+\end_inset
+
+ files.
+ 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 uses several of these features:
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
+
+\family sans
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_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
+B_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 \SpecialChar LaTeX
+ or DocBook, the format of \SpecialChar LyX
+'s XHTML output is also controlled by
+ layout information.
+ In general, \SpecialChar LyX
+ provides sensible defaults and, as mentioned earlier, it will
+ even construct default CSS style rules from the other layout tags.
+ For example, \SpecialChar 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 \SpecialChar LyX
- provides a number of layout tags that
- can be used to customize the XHTML and CSS that are generated.
+\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 \SpecialChar 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 "subsec:General-text-class"
+
+\end_inset
+
+ for details on these.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-XHTML"
+
+\end_inset
+
+Paragraph styles
+\end_layout
+
+\begin_layout Standard
+The sort of XHTML \SpecialChar 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
+\SpecialChar LaTeX
+Type
+\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
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+Contents of the paragraph.
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+</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
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<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
+
+\family sans
+<itemtag>Second paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+</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
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<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
+
+\family sans
+<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
+
+\family sans
+</tag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+
+\family sans
+<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
+
+\family sans
+<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
+
+\family sans
+</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, \SpecialChar 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, \SpecialChar 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 \SpecialChar 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 \SpecialChar 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 Newline newline
+\end_inset
+
+
+\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 Newline newline
+\end_inset
+
+
+\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.
+ Must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndHTMLStyle
+\end_layout
+
+\end_inset
+
+.
+\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, \SpecialChar 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 \SpecialChar 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, \SpecialChar 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 \SpecialChar 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 \SpecialChar 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 Newline newline
+\end_inset
+
+
+\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
-\begin_layout Standard
-Note that there are two tags,
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+string
\end_layout
\end_inset
- and
+] 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
-AddToHTMLPreamble
+class=`myfloat' onclick=`\SpecialChar ldots
+'
\end_layout
\end_inset
- that may appear outside style and inset declarations.
- See
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar 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 \SpecialChar LyX
+'s name for this type of float, as determined by the float declaration
+ (see
\begin_inset CommandInset ref
LatexCommand ref
-reference "subsec:General-text-class"
+reference "subsec:Floats"
\end_inset
- for details on these.
+), 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
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Paragraph-Style-XHTML"
+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
-Paragraph styles
+ blocks.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-format-description"
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Subsection
+\SpecialChar LyX
+-generated CSS
\end_layout
\begin_layout Standard
-The sort of XHTML \SpecialChar 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
+We have several times mentioned that \SpecialChar 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 \SpecialChar LyX
+ uses
+ and how.
+\end_layout
+
+\begin_layout Standard
+At present, \SpecialChar 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 "subsec: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
-\SpecialChar LaTeX
-Type
+Family Sans
\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
+ becomes
+\begin_inset Quotes eld
\end_inset
->
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+font-family: sans-serif;
\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
+.
+ The correspondence of \SpecialChar LyX
+ sizes and CSS sizes is a little less obvious but
+ nonetheless intuitive.
+ See the
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Contents of the paragraph.
+\begin_layout Plain Layout
+getSizeCSS()
\end_layout
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\end_inset
-\begin_layout Standard
-The label tags are of course omitted if the paragraph does not have a label.
-\end_layout
+ function in
+\begin_inset Flex URL
+status collapsed
-\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
+\begin_layout Plain Layout
+
+src/FontInfo.cpp
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ for the details.
+\change_inserted -970929547 1496610908
->
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Section
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1496610966
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-DocBook"
-value
-\begin_inset Quotes erd
\end_inset
->Environment Label</labeltag>First paragraph.</itemtag>
+Tags for DocBook output
\end_layout
-\begin_layout LyX-Code
-<itemtag>Second paragraph.</itemtag>
-\end_layout
+\begin_layout Standard
-\begin_layout LyX-Code
-</tag>
+\change_inserted -970929547 1496611615
+As with \SpecialChar LaTeX
+ or XHTML, the format of \SpecialChar LyX
+'s DocBook output is also controlled by
+ layout information.
+ In general, \SpecialChar LyX
+ provides sensible defaults; however, much of the styling is
+ lost during the conversion, as DocBook is strictly semantic and does not
+ allow formatting.
+ When possible, information from \SpecialChar LyX
+ will be rendered in
+\family typewriter
+role
+\family default
+ attributes.
+
\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.
-
+
+\change_inserted -970929547 1496612080
+In many cases, then, you may not have to do anything at all to get acceptable
+ DocBook output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so \SpecialChar LyX
+ provides a number of layout tags that
+ can be used to customize the DocBook that is generated.
\end_layout
\begin_layout Standard
-For a list, we have one of these forms:
+
+\change_inserted -970929547 1515109912
+Labels are rarely output, as they are redundant in DocBook: this information
+ is carried by the tags themselves, and whether labels appear in the final
+ documents (after processing of DocBook files) is controlled by the stylesheets.
+ However, sometimes, labels are not redundant content, such as definition
+ lists: in this case, the term being defined will be the label.
+
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+
+\change_inserted -970929547 1496610966
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-XHTML-1"
-value
-\begin_inset Quotes erd
\end_inset
->
+Paragraph styles
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
-value
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1496612059
+The sort of DocBook \SpecialChar 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
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-value
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1496610966
+\SpecialChar LaTeX
+Type
+\change_unchanged
->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
+ tag.
+
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
->List Label</labeltag>Second item.</itemtag>
+\change_inserted -970929547 1496612107
+For a command or normal paragraph, the output DocBook has the following
+ form:
\end_layout
\begin_layout LyX-Code
-</tag>
+
+\change_inserted -970929547 1515109666
+<tag attr>
\end_layout
\begin_layout LyX-Code
+\change_inserted -970929547 1496610966
+Contents of the paragraph.
\end_layout
\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
->
+\change_inserted -970929547 1496610966
+</tag>
\end_layout
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515109821
+For an environment that is not some sort of list, the generated DocBook
+ takes this form:
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->First item.</itemtag>
+\change_inserted -970929547 1515109671
+<tag attr>
\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
+\change_inserted -970929547 1496612114
+<itemtag>First paragraph.</itemtag>
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
->Second item.</itemtag>
+\change_inserted -970929547 1496610966
+<itemtag>Second paragraph.</itemtag>
\end_layout
\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
</tag>
\end_layout
\begin_layout Standard
-Note the different orders of
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-labeltag
+\change_inserted -970929547 1515109825
+For a list, the resulting DocBook takes this form:
\end_layout
-\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-itemtag
+\change_inserted -970929547 1515109672
+<tag attr>
\end_layout
-\end_inset
-
-.
- Which order we get depends upon the setting of
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
+\change_inserted -970929547 1515109676
+<itemtag attr>First item.</itemtag>
\end_layout
-\end_inset
-
-: If
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
+\change_inserted -970929547 1515109678
+<itemtag attr>Second item.</itemtag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- 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.
+\change_inserted -970929547 1496610966
+</tag>
\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, \SpecialChar 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
+\change_inserted -970929547 1496612243
+The specific tags and roles output for each paragraph type can be controlled
+ by means of the layout tags we are about to describe.
+ Please note that, due to the very nature of DocBook, no sensible defaults
+ really exist, and the values must always be carefully chosen.
+
\end_layout
-\end_inset
+\begin_layout Description
- [
+\change_inserted -970929547 1515110057
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\change_inserted -970929547 1515109656
+DocBookAttr
+\change_unchanged
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
+\end_layout
+\end_inset
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`mydiv'
-\end_layout
-\end_inset
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
+] Specifies attribute information to be output with the main tag, replacing
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`layoutname'
+
+\change_inserted -970929547 1515110057
+attr
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\change_unchanged
-\begin_layout Plain Layout
-layoutname
\end_layout
-\end_inset
+\begin_layout Description
- is the \SpecialChar LyX
- name of the layout, made lowercase, for example: chapter.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
+\change_inserted -970929547 1496612296
\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
+\change_inserted -970929547 1496612269
+DocBookTag
+\change_unchanged
-\begin_layout Plain Layout
-HTMLForceCSS
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Whether to output the default CSS information \SpecialChar LyX
- generates for this layout,
- even if additional information is explicitly provided via
+] The tag to be used for this inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1496612296
+tag
+\change_unchanged
+
\end_layout
\end_inset
-.
- Setting this to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
+\begin_inset Quotes erd
\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
+ in the example above.
+ The default is the name of the float and always needs to be changed, as
+ DocBook provides no generic tag.
+\change_unchanged
-\begin_layout Plain Layout
-0
\end_layout
-\end_inset
+\begin_layout Subsection
+
+\change_inserted -970929547 1515111533
+InsetLayout DocBook
+\change_unchanged
-.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
-\begin_layout Plain Layout
-HTMLItem
+\change_inserted -970929547 1496611894
+The DocBook output of insets can also be controlled by information in layout
+ files.
\end_layout
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
-\begin_layout Plain Layout
-string
+\change_inserted -970929547 1496612045
+The DocBook \SpecialChar LyX
+ outputs for an inset has the following form:
\end_layout
-\end_inset
-
-] The tag to be used for individual paragraphs of environments, replacing
-
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-itemtag
+\change_inserted -970929547 1515110861
+<wrappertag wrapperattr>
\end_layout
-\end_inset
-
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-div
+\change_inserted -970929547 1515110868
+ <tag attr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-.
+\change_inserted -970929547 1515110869
+ <innertag innerattr>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLItemAttr
+\change_inserted -970929547 1515110869
+ Contents of the inset.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515110870
+ </innertag>
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515110871
+ </tag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Attributes for the item tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -970929547 1515111172
+</wrappertag>
+\end_layout
+\begin_layout Standard
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111186
+For an itemising inset, it rather looks like this:
+\end_layout
-\begin_layout Plain Layout
-class=`layoutname_item'
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111186
+<wrappertag wrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515111186
+ <tag attr>
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111186
+ <innertag innerattr>
+\end_layout
-\begin_layout Plain Layout
-HTMLStyle
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111362
+ <itemwrappertag itemwrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- for that purpose.
+\change_inserted -970929547 1515111364
+ <itemlabeltag itemattr>
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabel
+\change_inserted -970929547 1515111367
+ Label of the first item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111362
+ </itemtag>
+\change_unchanged
-\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 LyX-Code
-\begin_layout Plain Layout
-labeltag
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- in the examples above.
- Defaults to
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111517
+ <itemtag itemattr>
+\change_unchanged
-\begin_layout Plain Layout
-span
\end_layout
-\end_inset
+\begin_layout LyX-Code
-, unless
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111516
+ Contents of the first item.
+\end_layout
+
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111514
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-LabelType
\end_layout
-\end_inset
+\begin_layout LyX-Code
- is either
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111247
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-Top_Environment
\end_layout
-\end_inset
+\begin_layout LyX-Code
- or
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\end_layout
-\begin_layout Plain Layout
-Centered_Top_Environment
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111370
+ <itemwrappertag itemwrapperattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111370
+ <itemlabeltag itemattr>
+\end_layout
-, in which case it defaults to
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-div
+\change_inserted -970929547 1515111372
+ Label of the second item.
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111370
+ </itemtag>
+\change_unchanged
-.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelAttr
+\change_inserted -970929547 1515111504
+ <itemtag itemattr>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111505
+ <itemtag itemattr>
+\change_unchanged
-\begin_layout Plain Layout
-string
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Attributes for the label tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
+\change_inserted -970929547 1515111507
+ Contents of the second item.
+\end_layout
+\begin_layout LyX-Code
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111509
+ </itemtag>
+\change_unchanged
-\begin_layout Plain Layout
-class=`layoutname_label'
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\change_inserted -970929547 1515111251
+ </itemtag>
+\change_unchanged
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-.
- This should
-\emph on
-not
-\emph default
- contain any style information.
- Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111221
+ </itemwrappertag>
+\change_unchanged
-\begin_layout Plain Layout
-HTMLStyle
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1515111219
+ ...
+\change_unchanged
- for that purpose.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-HTMLLabelFirst
+\change_inserted -970929547 1515111186
+ </innertag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- [
-\begin_inset Flex Code
-status collapsed
+\change_inserted -970929547 1515111186
+ </tag>
+\end_layout
-\begin_layout Plain Layout
+\begin_layout LyX-Code
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515111186
+</wrappertag>
\end_layout
-\end_inset
+\begin_layout Standard
-] 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
- `
+\change_inserted -970929547 1515111183
+If the inset permits multiple paragraphs—that is, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<dt>\SpecialChar ldots
-</dt><dd>\SpecialChar ldots
-</dd>
+
+\change_inserted -970929547 1496610966
+MultiPar
+\change_unchanged
+
\end_layout
\end_inset
-.
- Default is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
+ 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 inner tag is optional and, by default, does not appear.
\end_layout
-\end_inset
+\begin_layout Standard
-: The label tag is output inside the item tag.
+\change_inserted -970929547 1496610966
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110317
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\change_inserted -970929547 1515109695
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
- Information to be output in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<head>
+
+\change_inserted -970929547 1496611854
+string
+\change_unchanged
+
\end_layout
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+] Specifies attribute information to be output with the main tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+
+\change_inserted -970929547 1515110044
+attr
+\change_unchanged
+
\end_layout
\end_inset
- block defining an
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-onclick
-\end_layout
+\begin_inset Quotes erd
\end_inset
- handler.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110973
\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
+\change_inserted -970929547 1515110319
+DocBookInInfo
+\change_unchanged
-\begin_layout Plain Layout
-<style>
\end_layout
\end_inset
- block, so only the CSS itself need be included.
- Must end with
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndHTMLStyle
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110384
+never, always, maybe
+\change_unchanged
-.
\end_layout
-\begin_layout Description
+\end_inset
+
+] Specifies whether this tag goes into the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110412
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- [
+ tag at the beginning of the parent layout.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\change_inserted -970929547 1515110437
+never
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+ indicates that the tag never goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110497
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- Defaults to
+ (this is default value, and corresponds to usual content).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110517
+always
+\change_unchanged
-.
\end_layout
-\begin_layout Description
+\end_inset
+
+ indicates that the tag always goes into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTitle
+
+\change_inserted -970929547 1515110514
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- [
+ (this corresponds to usual metadata): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515110550
+<info>
+\change_unchanged
+
\end_layout
\end_inset
-] Marks this style as the one to be used to generate the
+ tag for the parent, one
+\series bold
+will
+\series default
+ be generated.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<title>
+
+\change_inserted -970929547 1515110540
+maybe
+\change_unchanged
+
\end_layout
\end_inset
- tag for the XHTML file.
- By default, it is false.
- The
+ indicates that the tag may go into
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdtitle.inc
+
+\change_inserted -970929547 1515110538
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- file sets it to true for the
+ (this is only the case for titles): if there is no
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-title
+
+\change_inserted -970929547 1515110585
+<info>
+\change_unchanged
+
\end_layout
\end_inset
- environment.
+ tag for the parent,
+\series bold
+none
+\series default
+ will be generated, the corresponding tag will be output directly as content.
\end_layout
-\begin_layout Subsection
-InsetLayout XHTML
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-The XHTML output of insets can also be controlled by information in layout
- files.
-\begin_inset Foot
+\change_inserted -970929547 1515111461
+\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
-\end_inset
-
-command
-\begin_inset Quotes erd
-\end_inset
+\change_inserted -970929547 1515110974
+DocBookItemAttr
+\change_unchanged
- insets (insets that are associated with dialog boxes).
\end_layout
\end_inset
- Here, too, \SpecialChar LyX
- tries to provide sensible defaults, and it constructs default
- CSS style rules.
- But everything can be customized.
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110973
+string
+\change_unchanged
-\begin_layout Standard
-The XHTML \SpecialChar 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
+] Specifies attribute information to be output with the item tag, replacing
+
+\begin_inset Quotes eld
\end_inset
->
-\end_layout
-\begin_layout LyX-Code
-<labeltag>Label</labeltag>
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110984
+itemattr
+\change_unchanged
+
\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>
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-If the inset permits multiple paragraphs—that is, if
+\change_inserted -970929547 1515111471
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -970929547 1515111465
+DocBookItemInnerAttr
+\change_unchanged
+
\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
+
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
+
\end_layout
\end_inset
-.
- The inner tag is optional and, by default, does not appear.
-\end_layout
+] Specifies attribute information to be output with the item inner tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
-\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
+
+\change_inserted -970929547 1515111476
+iteminnerattr
+\change_unchanged
+
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -970929547 1515111494
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\change_inserted -970929547 1515111467
+DocBookItemInnerTag
+\change_unchanged
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
+\end_layout
+\end_inset
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`myinset' onclick=`\SpecialChar ldots
-'
-\end_layout
-\end_inset
+\change_inserted -970929547 1515111461
+string
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
+] The tag to be used for the item inner tag within the inset, replacing
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`insetname'
+
+\change_inserted -970929547 1515111486
+iteminnertag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-insetname
+
+\change_inserted -970929547 1515111461
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- is the \SpecialChar LyX
- name of the inset, made lowercase and with non-alphanumeric characters
- converted to underscores, for example: footnote.
+, indicating that there is no item inner tag: content is directly output
+ without it for each itemised element.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111290
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+
+\change_inserted -970929547 1515111283
+DocBookItemLabelAttr
+\change_unchanged
+
\end_layout
\end_inset
\begin_layout Plain Layout
-\emph on
-0
-\emph default
-,1
+\change_inserted -970929547 1515111279
+string
+\change_unchanged
+
\end_layout
\end_inset
-] Whether to output the default CSS information \SpecialChar LyX
- generates for this layout,
- even if additional information is explicitly provided via
+] Specifies attribute information to be output with the item label tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515111304
+itemlabelattr
+\change_unchanged
+
\end_layout
\end_inset
-.
- Setting this to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
+\begin_inset Quotes erd
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is 0.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111337
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerAttr
+
+\change_inserted -970929547 1515111285
+DocBookItemLabelTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111279
string
+\change_unchanged
+
\end_layout
\end_inset
-] Attributes for the inner tag.
- Defaults to
+] The tag to be used for the item label tag within the inset, replacing
+
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`insetname_inner'
+
+\change_inserted -970929547 1515111311
+itemlabeltag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
+ in the example above.
+ This parameter only makes sense when itemising layouts are used with a
+ notion of labels, such as definition lists.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111124
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerTag
+
+\change_inserted -970929547 1515111060
+DocBookItemTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111060
string
+\change_unchanged
+
\end_layout
\end_inset
-] The inner tag, replacing
+] The tag to be used for the item tag within the inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-innertag
+
+\change_inserted -970929547 1515111060
+itemtag
+\change_unchanged
+
\end_layout
\end_inset
- in the examples above.
- By default, there is none.
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111060
+NONE
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+, indicating that there is no item tag.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111298
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLIsBlock
+
+\change_inserted -970929547 1515111124
+DocBookItemWrapperAttr
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0,
-\emph on
-1
+
+\change_inserted -970929547 1515111124
+string
+\change_unchanged
+
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the item wrapper tag,
+ replacing
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111150
+itemwrapperattr
+\change_unchanged
+
\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.
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515111113
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabel
+
+\change_inserted -970929547 1515111073
+DocBookItemWrapperTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515111073
string
+\change_unchanged
+
\end_layout
\end_inset
-] A label for this inset, possibly including a reference to a counter.
- For example, for footnote, it might be:
+] The tag to be used for the item wrapper tag within the inset, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-arabic{footnote}
+\change_inserted -970929547 1515111083
+itemwrappertag
+\change_unchanged
+
\end_layout
\end_inset
-.
- This is optional, and there is no default.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\change_inserted -970929547 1515111073
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- Information to be output in the
-\begin_inset Flex Code
-status collapsed
+, indicating that there is no item wrapper tag: tag and content are directly
+ output without it for each itemised element.
+ This parameter only makes sense when itemising layouts are used, such as
+ lists.
+
+\change_unchanged
-\begin_layout Plain Layout
-<head>
\end_layout
-\end_inset
+\begin_layout Description
- section when this style is used.
- This might, for example, be used to include a
+\change_inserted -970929547 1515110104
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+
+\change_inserted -970929547 1515110104
+DocBookInnerAttr
+\change_unchanged
+
\end_layout
\end_inset
- block defining an
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
+
+\change_inserted -970929547 1515110104
+string
+\change_unchanged
+
\end_layout
\end_inset
- handler.
-\end_layout
+] Specifies attribute information to be output with the inner tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+
+\change_inserted -970929547 1515110104
+innerattr
+\change_unchanged
+
\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
+\begin_inset Quotes erd
\end_inset
- block, so only the CSS itself need be included.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110906
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110104
+DocBookInnerTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110104
string
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+] The tag to be used for the inner tag within the inset, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110104
+innertag
+\change_unchanged
+
\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
+\begin_inset Quotes erd
\end_inset
-: If
+ in the example above.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\change_inserted -970929547 1515110791
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- is true, the default is
+, indicating that there is no inner tag: content is directly output without
+ it.
+\end_layout
+
+\begin_layout Description
+
+\change_inserted -970929547 1515110753
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110665
+DocBookSectionTag
+\change_unchanged
+
\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
+\change_inserted -970929547 1515110661
+string
+\change_unchanged
-\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
+] Specifies the tag that corresponds to this kind of section.
+ This parameter only makes sense for sectioning elements (part, chapter,
+ section, etc.).
+ The default value is
+\begin_inset Flex Code
+status collapsed
->
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-Contents of the float.
-\end_layout
+\change_inserted -970929547 1515110721
+section
+\change_unchanged
-\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_inset
+
+, and is only overridden when DocBook uses something else for sectioning
+ (parts and chapters of a book).
+\change_unchanged
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110811
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+
+\change_inserted -970929547 1496612023
+DocBookTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1496610966
string
+\change_unchanged
+
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
+] The tag to be used for this inset, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`myfloat' onclick=`\SpecialChar ldots
-'
+
+\change_inserted -970929547 1496612033
+tag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
- By default, \SpecialChar LyX
- will output
-\begin_inset Quotes eld
-\end_inset
+ in the example above.
+ The default is the name of the float and always needs to be changed, as
+ DocBook provides no generic inset tag.
+\end_layout
+\begin_layout Description
+\change_inserted -970929547 1515110832
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`float float-floattype'
-\end_layout
-\end_inset
+\change_inserted -970929547 1515110822
+DocBookWrapperAttr
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-floattype
+
+\change_inserted -970929547 1515110811
+string
+\change_unchanged
+
\end_layout
\end_inset
- is \SpecialChar LyX
-'s name for this type of float, as determined by the float declaration
- (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Floats"
-
+] Specifies attribute information to be output with the outer tag, replacing
+
+\begin_inset Quotes eld
\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
+
+\change_inserted -970929547 1515110845
+wrapperattr
+\change_unchanged
+
\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
+\begin_inset Quotes erd
\end_inset
- block, so only the CSS itself need be included.
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
\begin_layout Description
+
+\change_inserted -970929547 1515110917
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+
+\change_inserted -970929547 1515110826
+DocBookWrapperTag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\change_inserted -970929547 1515110811
string
+\change_unchanged
+
\end_layout
\end_inset
-] The tag to be used for this float, replacing
+] The tag to be used for the wrapper tag around the inset, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-tag
+
+\change_inserted -970929547 1515110842
+wrappertag
+\change_unchanged
+
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-div
+
+\change_inserted -970929547 1515110811
+NONE
+\change_unchanged
+
\end_layout
\end_inset
- and will rarely need changing.
+, indicating that there is no wrapper tag: tag and content are directly
+ output without it.
+\change_deleted -970929547 1515111523
+
\end_layout
\begin_layout Subsection
-Bibliography formatting
+
+\change_inserted -970929547 1515110040
+Float DocBook
\end_layout
\begin_layout Standard
-The bibliography can be formatted using
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-CiteFormat
+\change_inserted -970929547 1496611700
+The DocBook output for floats too can be controlled by layout information.
+ The output has the following form:
\end_layout
-\end_inset
+\begin_layout LyX-Code
- blocks.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Citation-format-description"
+\change_inserted -970929547 1515109700
+<tag attr>
+\end_layout
-\end_inset
+\begin_layout LyX-Code
- for the details.
+\change_inserted -970929547 1515110138
+ Contents of the float as DocBook.
\end_layout
-\begin_layout Subsection
-\SpecialChar LyX
--generated CSS
+\begin_layout LyX-Code
+
+\change_inserted -970929547 1496610966
+</tag>
\end_layout
\begin_layout Standard
-We have several times mentioned that \SpecialChar 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 \SpecialChar LyX
- uses
- and how.
+
+\change_inserted -970929547 1496611715
+The caption, if there is one, is a separate inset and will be output as
+ a title.
+
\end_layout
-\begin_layout Standard
-At present, \SpecialChar LyX
- auto-generates CSS only for font information, making use of
- the
+\begin_layout Description
+
+\change_inserted -970929547 1515110033
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+
+\change_inserted -970929547 1515109702
+DocBookAttr
+\change_unchanged
+
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+
\end_layout
\end_inset
-,
+] Specifies attribute information to be output with the main tag, replacing
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Shape
+
+\change_inserted -970929547 1515110035
+attr
+\change_unchanged
+
\end_layout
\end_inset
-, and
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Size
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ This information can be used in further processing of the DocBook files.
+
\end_layout
-\end_inset
+\begin_layout Description
- specified in the
+\change_inserted -970929547 1515110157
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
-\end_layout
-
-\end_inset
- declaration (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Font-description"
+\change_inserted -970929547 1496611782
+DocBookTag
+\change_unchanged
-\end_inset
+\end_layout
-).
- 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
+\change_inserted -970929547 1496610966
+string
+\change_unchanged
+\end_layout
-\begin_inset Quotes erd
\end_inset
- becomes
+] The tag to be used for this float, replacing
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-font-family: sans-serif;
+
+\change_inserted -970929547 1496610966
+tag
+\change_unchanged
+
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
- The correspondence of \SpecialChar 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()
+ in the example above.
+ The default is the name of the float and always needs to be changed, as
+ DocBook provides no generic float tag.
\end_layout
-\end_inset
-
- function in
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout Plain Layout
+\begin_layout Subsection
-src/FontInfo.cpp
+\change_inserted -970929547 1515110157
+Bibliography formatting
\end_layout
-\end_inset
+\begin_layout Standard
+
+\change_inserted -970929547 1515110187
+The bibliography cannot be formatted: all fields are always output in the
+ database-like DocBook format (equivalent to a BibTeX file).
+\change_unchanged
- for the details.
\end_layout
\begin_layout Chapter
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
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Section
-The external template configuration file
+The external template configuration files
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-LyXDir/lib/external_templates
+*.xtemplate
\end_layout
\end_inset
- file.
- You can place your own version in
+ files that are stored in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir/external_templates
+LyXDir/lib/xtemplates/
\end_layout
\end_inset
-.
+ directory.
+ Each template is defined in a file of its own.
+ You can place your own templates in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir/xtemplates/
+\end_layout
+
+\end_inset
+
+ or copy existing templates to that directory in order to modify them.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout LyX-Code
-Format \SpecialChar LaTeX
-
+Format LaTeX
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Format PDF\SpecialChar LaTeX
-
+Format PDFLaTeX
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
-Product "$$Contents(
-\backslash
-"$$AbsPath$$Basename.asc
-\backslash
-")"
-\end_layout
-
-\begin_layout LyX-Code
-UpdateFormat asciixfig
-\end_layout
-
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.asc"
+Product "[XFig: $$FName]"
\end_layout
\begin_layout LyX-Code
FormatEnd
\end_layout
-\begin_layout LyX-Code
-Product "[XFig: $$FName]"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
\begin_layout LyX-Code
TemplateEnd
\end_layout
\begin_inset space ~
\end_inset
-LaTeX|PDFLaTeX|PlainText|DocBook
+LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
\end_layout
\end_inset
The file format of the converted file.
This must be the name of a format that is known to \SpecialChar LyX
(see the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
The file extension (including the dot).
-\change_inserted -195340706 1437418878
-
\end_layout
\begin_layout Description
-
-\change_inserted -195340706 1437418878
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1437418878
$$pngOrjpg
\end_layout
.
This is useful to avoid uneeded conversions for output formats that support
both PNG and JPEG fomats.
- The predefined RasterImage template uses this macro for the PDFL
-\change_deleted -712698321 1437634446
-A
-\change_inserted -712698321 1437634446
-a
-\change_inserted -195340706 1437418878
-TeX output format.
-\change_unchanged
-
+ The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
+ output
+ format.
\end_layout
\begin_layout Description
\end_layout
\begin_layout Standard
-The colors listed here are the standard colors and the those that you can
- adjust in the \SpecialChar LyX
+The colors listed below are the standard colors and those that you can adjust
+ in the \SpecialChar LyX
preferences.
\end_layout
+\begin_layout Section
+Color functions
+\end_layout
+
+\begin_layout Standard
+The following are no real colors, but rather act on color definitions:
+\end_layout
+
+\begin_layout Description
+ignore The color is ignored
+\end_layout
+
+\begin_layout Description
+inherit The color is inherited
+\end_layout
+
\begin_layout Description
none
\family roman
No particular color – clear or default
\end_layout
+\begin_layout Section
+Static colors
+\end_layout
+
+\begin_layout Standard
+These are fixed colors that cannot be customized:
+\end_layout
+
\begin_layout Description
black
\end_layout
\end_layout
\begin_layout Description
-red
+blue
+\end_layout
+
+\begin_layout Description
+brown
+\end_layout
+
+\begin_layout Description
+cyan
+\end_layout
+
+\begin_layout Description
+darkgray
+\end_layout
+
+\begin_layout Description
+gray
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-blue
+lightgray
\end_layout
\begin_layout Description
-cyan
+lime
\end_layout
\begin_layout Description
magenta
\end_layout
+\begin_layout Description
+olive
+\end_layout
+
+\begin_layout Description
+orange
+\end_layout
+
+\begin_layout Description
+pink
+\end_layout
+
+\begin_layout Description
+purple
+\end_layout
+
+\begin_layout Description
+red
+\end_layout
+
+\begin_layout Description
+teal
+\end_layout
+
+\begin_layout Description
+violet
+\end_layout
+
\begin_layout Description
yellow
\end_layout
+\begin_layout Section
+Dynamic colors
+\end_layout
+
+\begin_layout Standard
+These are the colors allocated to specific elements in
+\begin_inset Info
+type "menu"
+arg "dialog-show prefs"
+\end_inset
+
+:
+\end_layout
+
\begin_layout Description
-added_space Added space marker color
+added_space Added space color
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-buttonbg Color used for bottom background
+buttonbg Color used for button background
\end_layout
\begin_layout Description
-buttonhoverbg Color used for button background under focus
+buttonframe Color for inset button frames
\end_layout
\begin_layout Description
-buttonframe Color for inset button frames
+buttonhoverbg Color used for button background under focus
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-collapsable_inset_frame Collapsable insets framecolor
+collapsible Collapsible insets text color
\end_layout
\begin_layout Description
-collapsable_inset_text Collapsable insets text color
+collapsibleframe Collapsible insets framecolor
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-comment color for comments
+comment Label color for comments
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-graphicsbg Graphics inset background color
+foreground Foreground color
\end_layout
\begin_layout Description
-greyedout Label color for greyedout insets
+graphicsbg Graphics inset background color
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-greyedouttext Color for greyedout inset text
-\end_layout
-
-\begin_layout Description
-indexlabel Label color for index insets
+greyedoutlabel Label color for greyedout insets
\end_layout
\begin_layout Description
-ignore The color is ignored
+greyedouttext Color for greyedout inset text
\end_layout
\begin_layout Description
-inherit The color is inherited
+indexlabel Label color for index insets
\end_layout
\begin_layout Description
\end_layout
\begin_layout Description
-notebg Background color of notes
+note Label color for notes
\end_layout
\begin_layout Description
-notelabel Label color for notes
+notebg Background color of notes
\end_layout
\begin_layout Description
regexpframe Color for regexp frame
\end_layout
+\begin_layout Description
+scroll Color that indicates when a row can be scrolled
+\end_layout
+
\begin_layout Description
selection Background color of selected text
\end_layout