#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 361
+\lyxformat 375
\begin_document
\begin_header
\textclass scrbook
\end_local_layout
\language english
\inputencoding auto
+\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\use_geometry false
\use_amsmath 0
\use_esint 0
+\use_mhchem 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
+\suppress_date false
\branch OutDated
\selected 0
+\filename_suffix 0
\color #f5fae7
\end_branch
+\index Index
+\shortcut idx
+\color #008000
+\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
-\defskip medskip
+\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes true
+\tracking_changes false
\output_changes false
-\author "Jean-Marc Lasgouttes"
-\author ""
+\html_use_mathml true
+\html_be_strict true
\end_header
\begin_body
\end_inset
in the subject header, and please cc the current maintainer of this file,
- Richard Heck <
-rgheck
-@
-comcast
-.net>.
+ Richard Heck <rgheck@comcast.net>.
\end_layout
\end_inset
This manual covers the customization features present in LyX.
In it, we discuss issues like keyboard shortcuts, screen previewing options,
printer options, sending commands to LyX via the LyX Server, internationalizati
-on, installing new
-LaTeX
- classes and LyX layouts, etc.
+on, installing new LaTeX classes and LyX layouts, etc.
We can't possibly hope to touch on everything you can change—our developers
add new features faster than we can document them—but we will explain the
most common customizations and hopefully point you in the right direction
\begin_layout Standard
Information from previous versions of this document that now seems to be
- outdated is contained in the
-OutDated
- branch of this document.
- By default, this information will not appear in the
-LaTeX
- output.
+ outdated is contained in the OutDated branch of this document.
+ By default, this information will not appear in the LaTeX output.
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-packages.
-lst
+packages.lst
\end_layout
\end_inset
\begin_layout Plain Layout
Help\SpecialChar \menuseparator
-
LaTeX
-
\begin_inset space ~
\end_inset
status collapsed
\begin_layout Plain Layout
-
-textclass
-.
-lst
+textclass.lst
\end_layout
\end_inset
\end_inset
- directories, along with the associated
-LaTeX
- document class and their description.
+ directories, along with the associated LaTeX document class and their descripti
+on.
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-
-lyxmodules
-.
-lst
+lyxmodules.lst
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-*files.
-lst
+*files.lst
\end_layout
\end_inset
- lists of various sorts of
-LaTeX
--related files found on your system
+ lists of various sorts of LaTeX-related files found on your system
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-doc/
-LaTeXConfig
-.lyx
+doc/LaTeXConfig.lyx
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-LaTeXConfig
-.lyx.in
+LaTeXConfig.lyx.in
\end_layout
\end_inset
.
- It contains information on your
-LaTeX
- configuration.
+ It contains information on your LaTeX configuration.
\end_layout
\begin_layout Subsection
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\end_inset
- that define the
-keybindings
- used in LyX.
+ that define the keybindings used in LyX.
If there exists an internationalized version of the bind file named
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-
-clipart
-/
+clipart/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-LaTeXConfig
-.lyx
+LaTeXConfig.lyx
\end_layout
\end_inset
deserves special attention, as noted above.
- The internationalized help docs are in
-subdirectories
-
+ The internationalized help docs are in subdirectories
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-
-kbd
-/
+kbd/
\end_layout
\end_inset
- contains keyboard
-keymapping
- files.
+ contains keyboard keymapping files.
See Chapter
\begin_inset space ~
\end_inset
status collapsed
\begin_layout Plain Layout
-
lyx2lyx
\end_layout
status collapsed
\begin_layout Plain Layout
-
lyx2lyx
\end_layout
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:Creating-Templates"
+reference "sub:Creating-Templates"
\end_inset
status collapsed
\begin_layout Plain Layout
-
-ui
-/
+ui/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-.
-ui
+.ui
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-chkconfig
-.
-ltx
+chkconfig.ltx
\end_layout
\end_inset
- this is a
-LaTeX
- script used during the configuration process.
+ this is a LaTeX script used during the configuration process.
Do not run directly.
\end_layout
status collapsed
\begin_layout Plain Layout
-configure.
-py
+configure.py
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
encodings
\end_layout
\end_inset
- this contains tables describing how different character
-encodings
- can be mapped to Unicode
+ this contains tables describing how different character encodings can be
+ mapped to Unicode
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-configure.
-py
+configure.py
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-UserDir
-/layouts
+UserDir/layouts
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-UserDir
-/doc/
+UserDir/doc/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
--
-userdir
+-userdir
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
--
-userdir
+-userdir
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LYX_
-USERDIR
-_
-VER
+LYX_USERDIR_VER
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-NewUserDir
-/layouts
+NewUserDir/layouts
\end_layout
\end_inset
which you want available from all your configurations, you must add it
to each directory separately.
You can avoid this with the following trick: after LyX creates the additional
- directory, most of the
-subdirectories
- (see above) are empty.
+ directory, most of the subdirectories (see above) are empty.
If you want the new configuration to mirror an existing one, replace the
- empty
-subdirectory
- with a symbolic link to the matching
-subdirectory
- in the existing configuration.
+ empty subdirectory with a symbolic link to the matching subdirectory in
+ the existing configuration.
Take care with the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-
-subdirectory
-, however, since it contains a file written by the configuration script
- (also accessible through
+ subdirectory, however, since it contains a file written by the configuration
+ script (also accessible through
\begin_inset Flex CharStyle:MenuItem
status collapsed
status collapsed
\begin_layout Plain Layout
-
Ghostview
\end_layout
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdflatex
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
status collapsed
\begin_layout Plain Layout
-
jpg
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdflatex
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
status collapsed
\begin_layout Plain Layout
-
jpg
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
\end_inset
- The `
-LaTeX
-
-name'
+ The `LaTeX name'
\end_layout
\begin_layout Standard
-The latter should be the
-filename
- as it would be used in a
-LaTeX's
-
+The latter should be the filename as it would be used in a LaTeX's
\series bold
\backslash
\begin_layout Standard
Copiers can be used to do almost anything with output files.
- For example, suppose you want generated
-pdf
- files to be copied to a special directory,
+ For example, suppose you want generated pdf files to be copied to a special
+ directory,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-/home/you/
-pdf
-/
+/home/you/pdf/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-/home/you/.lyx/scripts/
-pdfcopier
-.sh
+/home/you/.lyx/scripts/pdfcopier.sh
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-PDF
-(
-pdflatex
-)
+PDF(pdflatex)
\end_layout
\end_inset
- format—or one of the other
-pdf
- formats—and enter
+ format—or one of the other pdf formats—and enter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-pdfcopier
-.sh $$i $$o
+pdfcopier.sh $$i $$o
\end_layout
\end_inset
When these formats are exported, the copier sees that not just the main
HTML file but various associated files (style files, images, etc.) are also
copied.
- All these files are written to a
-subdirectory
- of the directory in which the original LyX file was found.
+ All these files are written to a subdirectory of the directory in which
+ the original LyX file was found.
\begin_inset Foot
status collapsed
status collapsed
\begin_layout Plain Layout
-
LyXconv
\end_layout
status collapsed
\begin_layout Plain Layout
-/path/to/
-filename
-.lyx
+/path/to/filename.lyx
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-/path/to/
-filename
-.
-html
-.
-LyXconv
+/path/to/filename.html.LyXconv
\end_layout
\end_inset
\end_inset
- The base
-filename
- of the input file (i.
+ The base filename of the input file (i.
\begin_inset space \thinspace{}
\end_inset
\end_inset
- This converter runs some form of
-LaTeX
-.
- This will make LyX's
-LaTeX
- error logs available.
+ This converter runs some form of LaTeX.
+ This will make LyX's LaTeX error logs available.
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-
needaux
\end_layout
\end_inset
- Needs the
-LaTeX
-
+ Needs the LaTeX
\begin_inset Flex CharStyle:MenuItem
status collapsed
status collapsed
\begin_layout Plain Layout
-
xml
\end_layout
status collapsed
\begin_layout Plain Layout
-
parselog
\end_layout
status collapsed
\begin_layout Plain Layout
-
-infile
-.out
+infile.out
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-script <
-infile
-.out >
-infile
-.log
+script < infile.out > infile.log
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
resultdir
\end_layout
\begin_inset Newline newline
\end_inset
-Note that
-resultdir
- and
-usetempdir
- make no sense together.
+Note that resultdir and usetempdir make no sense together.
The latter will be ignored if the former is given.
\end_layout
status collapsed
\begin_layout Plain Layout
-
resultfile
\end_layout
\end_inset
.
- Sensible only with
-resultdir
- and optional even then; if not given, it defaults to `
-index'
-.
+ Sensible only with resultdir and optional even then; if not given, it defaults
+ to `index'.
\end_layout
\begin_layout Standard
\begin_layout Standard
You do not have to define converters for all formats between which you want
to convert.
- For example, you will note that there is no `LyX to
-PostScript'
- converter, but LyX will export PostScript.
- It does so by first creating a
-LaTeX
- file (no converter needs to be defined for this) which is then converted
- to DVI using the `
-LaTeX
- to
-DVI'
- converter, and finally converting the resulting DVI file to PostScript.
- LyX finds such `
-chains'
- of converters automatically, and it will always choose the shortest possible
- chain.
+ For example, you will note that there is no `LyX to PostScript' converter,
+ but LyX will export PostScript.
+ It does so by first creating a LaTeX file (no converter needs to be defined
+ for this) which is then converted to DVI using the `LaTeX to DVI' converter,
+ and finally converting the resulting DVI file to PostScript.
+ LyX finds such `chains' of converters automatically, and it will always
+ choose the shortest possible chain.
You can, though, still define multiple conversion methods between file
formats.
For example, the standard LyX configuration provides three ways to convert
-
-LaTeX
- to
-PDF
-: Directly, using
+ LaTeX to PDF: Directly, using
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
pdflatex
\end_layout
status collapsed
\begin_layout Plain Layout
-
ps2pdf
\end_layout
status collapsed
\begin_layout Plain Layout
-
dvipdfm
\end_layout
.
To define such alternate chains, you must define multiple target `file
-
-formats'
-, as described in section
+ formats', as described in section
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdf2
\end_layout
status collapsed
\begin_layout Plain Layout
-
pdf3
\end_layout
status collapsed
\begin_layout Plain Layout
-.
-pdf
+.pdf
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
It is possible to do this just for yourself, but if you're going to do
it, you might as well share the results of your labors with the rest of
the LyX community.
- Send a message to the LyX
-developers'
- list for more information about how to proceed.
+ Send a message to the LyX developers' list for more information about how
+ to proceed.
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-**.
-po
+**.po
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-xx.
-po
+xx.po
\end_layout
\end_inset
\end_inset
- in that directory, or you can use an existing
-po
--file for some other language as a template).
+ in that directory, or you can use an existing po-file for some other language
+ as a template).
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-xx.
-po
+xx.po
\end_layout
\end_inset
\family typewriter
KBabel
\family default
- (for
-KDE
-).
+ (for KDE).
\family typewriter
Emacs
\family default
- contains a `
-mode'
- for editing
+ contains a `mode' for editing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
status collapsed
\begin_layout Plain Layout
-
-msgfmt
- -o xx.mo < xx.
-po
+msgfmt -o xx.mo < xx.po
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
-file could be added to the LyX distribution, so others can use it.
Adding it involves making additional changes to LyX.
- So send an email to the
-developers'
- mailing list if you're interested in doing that.
+ So send an email to the developers' mailing list if you're interested in
+ doing that.
\end_layout
\begin_layout Subsubsection
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
status collapsed
\begin_layout Plain Layout
-To[[as in
-'From
- format x to format
-y'
-]]
+To[[as in 'From format x to format y']]
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-To[[as in
-'From
- page x to page
-y'
-]].
+To[[as in 'From page x to page y']].
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
do right away:
\end_layout
-\begin_layout Itemize
-Read
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-DocStyle.lyx
-\end_layout
-
-\end_inset
-
-, the guide to writing LyX documentation.
- Pay special attention to the translator's section.
-\end_layout
-
\begin_layout Itemize
Check out the documentation translation web page at
\begin_inset CommandInset href
\begin_layout Plain Layout
Help\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ntroduction
+Introduction
\end_layout
\end_inset
In this chapter, we describe the procedures for creating and installing
new LyX layout and template files, as well as offer a refresher on correctly
installing new LaTeX document classes.
- Some definitions: a document class is a LaTeX file (usually ending in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-.cls
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-.sty
+
\end_layout
-\end_inset
-
-) that describes the format of a document such as an article, report, journal
- preprint, etc, and all the commands needed to realize that format.
- A layout file is a LyX file that corresponds to a LaTeX document class
- and that tells LyX how to
+\begin_layout Standard
+First, let us a say a few words about how one ought to think about the relation
+ between LyX and LaTeX.
+ The thing to understand is that, in a certain sense, LyX doesn't know anything
+ about LaTeX.
+ Indeed, from LyX's point of view, LaTeX is just one of several
\begin_inset Quotes eld
\end_inset
-draw
+backend formats
\begin_inset Quotes erd
\end_inset
- things on the screen to make the display look something like the final
- printed page.
- More precisely, a layout file describes a
-\begin_inset Quotes eld
-\end_inset
-
-text class
-\begin_inset Quotes erd
-\end_inset
+ in which it is capable of producing output.
+ Other such formats are DocBook, plaintext, and XHTML.
+ LaTeX is, of course, a particularly important format, but very little of
+ the information LyX has about LaTeX is actually contained in the program
+ itself.
+\begin_inset Foot
+status collapsed
- which is the internal construct LyX uses to render the screen display.
-
+\begin_layout Plain Layout
+Some commands are sufficiently complex that they are
\begin_inset Quotes eld
\end_inset
-Layout
+hardcoded
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+ into LyX.
+ But the developers generally regard this as a Bad Thing.
+\end_layout
-text class
-\begin_inset Quotes erd
\end_inset
- can be used somewhat interchangeably, but it is better to refer to the
- file as the layout, and the thing living in LyX's memory as the text class.
- A template file is simply a LyX document that contains a set of predefined
- entries for a given document class—entries that are generally required
- for that class.
- Templates are especially useful for things like journal manuscripts that
- are to be submitted electronically.
-\end_layout
+ Rather, that information, even for the standard classes like
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Section
-Installing a new LaTeX package
+\begin_layout Plain Layout
+article.cls
\end_layout
-\begin_layout Standard
-Some installations may not include a LaTeX package that you would like to
- use within LyX.
- For example, you might need FoilTeX, a package for preparing slides or
- viewgraphs for overhead projectors.
- Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
- a user interface for that.
- For example on MiKTeX you start its program
-\begin_inset Quotes eld
\end_inset
-Browse Packages
-\begin_inset Quotes erd
-\end_inset
+, is contained in layout files.
+ Similarly, LyX itself does not know much about DocBook or XHTML.
+\end_layout
- to get a list of available packages.
- To install one, right click on it or use the installing toolbar button.
- When the package you want to install is not in the list, but you have it
- in form of a
+\begin_layout Standard
+You can think of the layout file for a given document class as a translation
+ manual between LyX constructs---paragraphs with their corresponding styles,
+ certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
+ XHTML constructs.
+ Almost everything LyX knows about
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.cls
+article.cls
\end_layout
\end_inset
- or
+, for example, is contained in the file
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.sty
+article.layout
\end_layout
\end_inset
--file, then copy these files to a subfolder of your LaTeX distribution,
- for example to the folder
-\family sans
-~
-\backslash
-tex
-\backslash
-latex
-\family default
-.
- Then update the file name database of your LaTeX-distribution.
- For example on MiKTeX this is done by pressing the button
-\family sans
-Refresh
-\begin_inset space ~
-\end_inset
-
-FNDB
-\family default
- that you find in MiKTeX's
-\begin_inset Quotes eld
-\end_inset
-
-Settings
-\begin_inset Quotes erd
-\end_inset
-
- program.
- In both cases you need afterwards to reconfigure LyX using the menu
-\begin_inset Flex CharStyle:MenuItem
+ and in various other files it includes.
+ For this reason, anyone intending to write layout files should plan to
+ study the existing files.
+ A good place to start is with
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+stdsections.inc
\end_layout
\end_inset
- and then to restart LyX.
-\end_layout
+, which is included in
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-If your LaTeX distribution doesn't provide a user interface, then you can
- follow these steps by using a UNIX/Linux console.
+\begin_layout Plain Layout
+article.layout
\end_layout
-\begin_layout Enumerate
-Get the package from
-\begin_inset CommandInset href
-LatexCommand href
-name "CTAN"
-target "http://www.ctan.org/"
-
\end_inset
- or wherever.
-\end_layout
-
-\begin_layout Enumerate
-You can install this package in several different places.
- If you want it to be available for all users on your system, then you should
- install it in your `local' TeX tree; if you want (or need) it to be available
- just for you, then you can install it in your own `user' TeX tree.
- Where these should be created, if they do not already exist, depends upon
- the details of your system.
- To find out, look in the file
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-texmf.cnf
+book.layout
\end_layout
\end_inset
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-This usually lives in the directory
+, and many of the other layout files for document classes.
+ This file is where sections and the like are defined:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$TEXMF/web2c
+stdsections.inc
\end_layout
\end_inset
-, though you can run
+ tells LyX how paragraphs that are marked with the Section, Subsection,
+ etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
+ commands and tags.
+ The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article.layout
+\end_layout
+
+\end_inset
+
+ file basically just includes several of these
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+std*.inc
+\end_layout
+
+\end_inset
+
+ files.
+\end_layout
+
+\begin_layout Standard
+Defining the LyX--LaTeX correspondence is not the only thing layout files
+ do, though.
+ Their other job is to define how the LyX constructs themselves will appear
+ on-screen.
+ The fact that layout files have these two jobs is often a source of confusion,
+ because they are completely separate.
+ Telling LyX how to translate a certain paragraph style into LaTeX does
+ not tell LyX how to display it; conversely, telling LyX how to display
+ a certain paragraph style does not tell LyX how to translate it into LaTeX
+ (let alone tell LaTeX how to display it).
+ So, in general, when you define a new LyX construct, you must always do
+ two quite separate things: (i)
+\begin_inset space ~
+\end_inset
+
+tell LyX how to translate it into LaTeX and (ii)
+\begin_inset space ~
+\end_inset
+
+tell LyX how to display it.
+\end_layout
+
+\begin_layout Standard
+Much the same is true, of course, as regards LyX's other backend formats,
+ though XHTML is in some ways different, because in that case LyX
+\emph on
+is
+\emph default
+ able, to some extent, to use information about how it should display a
+ paragraph on the screen to output information (in the form of CSS) about
+ how the paragraph should be displayed in a browser.
+ Even in this case, however, the distinction between what LyX does internally
+ and how things are rendered externally remains in force, and the two can
+ be controlled separately.
+ See
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sec:Tags-for-XHTML"
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Section
+Installing new LaTeX files
+\end_layout
+
+\begin_layout Standard
+Some installations may not include a LaTeX package or class file that you
+ would like to use within LyX.
+ For example, you might need FoilTeX, a package for preparing slides for
+ overhead projectors.
+ Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
+ a user interface for installing such packages.
+ For example, with MiKTeX, you start the program
+\begin_inset Quotes eld
+\end_inset
+
+Browse Packages
+\begin_inset Quotes erd
+\end_inset
+
+ to get a list of available packages.
+ To install one, right click on it or use the toolbar button to install
+ it.
+
+\end_layout
+
+\begin_layout Standard
+If your LaTeX distribution doesn't provide such a `package manager', or
+ if the file is not available from your distribution, then you can follow
+ these steps to install it manually.
+\end_layout
+
+\begin_layout Enumerate
+Get the package from
+\begin_inset CommandInset href
+LatexCommand href
+name "CTAN"
+target "http://www.ctan.org/"
+
+\end_inset
+
+ or wherever.
+\end_layout
+
+\begin_layout Enumerate
+You can install the package in several different places.
+ If you want it to be available for all users on your system, then you should
+ install it in your `local' TeX tree; if you want (or need) it to be available
+ just for you, then you can install it in your own `user' TeX tree.
+ Where these trees should be created, if they do not already exist, depends
+ upon the details of your system.
+ To find out where they are, look in the file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+texmf.cnf
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This usually lives in the directory
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$TEXMF/web2c
+\end_layout
+
+\end_inset
+
+, though you can run
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- The location of the `local' TeX tree is defined by
+ The location of the `local' TeX tree is defined by the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-; this is usually somewhere like
-\begin_inset Flex CharStyle:Code
+ variable; this is usually somewhere like
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
+
/usr/local/share/texmf/
\end_layout
\end_inset
.
- The `user' TeX tree is defined by
+ The location of the `user' TeX tree is defined by
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- and is commonly at
+ and is commonly
\begin_inset Flex CharStyle:Code
status collapsed
.
(If these variables are not predefined, you can define them.) You'll probably
- need root permissions to create or modify the `local' tree; but your `user'
+ need root permissions to create or modify the `local' tree, but your `user'
tree shouldn't have such limitations.
\end_layout
\begin_inset Newline newline
\end_inset
-But, again, most of this will
-\begin_inset Quotes eld
-\end_inset
-
-just work
-\begin_inset Quotes erd
-\end_inset
-
-.
+It probably does.
\end_layout
\begin_layout Enumerate
-Create your local
-\begin_inset Foot
+Your local and user trees
+\emph on
+must
+\emph default
+ have the same sort of directory structure as your main existing
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-We'll assume henceforth that you're defining `local' TeX tree.
- If you're defining a user tree, just adjust as necessary.
+texmf
\end_layout
\end_inset
- TeX tree.
- You must follow the directory structure of your existing
+ directory, which will be found at
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-texmf
+TEXMFMAIN
\end_layout
\end_inset
- directory, which will be found at
+ (commonly,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TEXMFMAIN
+/usr/share/texmf/
\end_layout
\end_inset
-.
- For example, latex packages should go under
+.) For example, latex packages should go under
\begin_inset Flex CharStyle:Code
status collapsed
$TEXMFLOCAL/tex/latex/
\end_layout
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$TEXMFHOME/tex/latex/
+\end_layout
+
\end_inset
.
+ If you do not put them here, they probably will not work.
\end_layout
\begin_layout Enumerate
-Install the package.
- For example, you would unpack the FoilTeX tarball and copy it to
+Once your tree is properly set up, you can install the package into an appropria
+te location.
+ If you are lucky, your package will have been provided as a so-called `TDS'
+ (TeX Directory Structure) zip file.
+ To install it, you want to unzip it from the top of your tree.
+ So, for example, you can copy the file
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$TEXMFLOCAL/tex/latex/foiltex
+newpkg.zip
\end_layout
\end_inset
-.
- The
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+/home/yourname/texmf/
+\end_layout
+
+\end_inset
+
+ and then, from inside that directory, just run:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-foiltex
+unzip newpkg.zip
+\end_layout
+
+\end_inset
+
+.
+ This will extract the needed files and copy them where they need to be.
+\begin_inset Newline newline
+\end_inset
+
+If you do not have a TDS file, then you have to do this manually.
+ For example, you might install the FoilTeX files into
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+$TEXMFLOCAL/tex/latex/contrib/foiltex
+\end_layout
+
+\end_inset
+
+.
+ Why there? The CTAN download directories are themselves organized much
+ like a TeX tree, and it isn't a bad idea to follow its structure when you
+ install your own files.
+ FoilTeX, as it happens, is found at
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://ctan.org/texarchive/macros/latex/contrib/foiltex/
\end_layout
\end_inset
- directory contains various files.
+.
+
\end_layout
\begin_layout Enumerate
-Run:
+Finally, you must update the database TeX uses to find files.
+ On MiKTeX, this is done by pressing the button
+\family sans
+Refresh
+\begin_inset space ~
+\end_inset
+
+FNDB
+\family default
+ that you find in MiKTeX's
+\begin_inset Quotes eld
+\end_inset
+
+Settings
+\begin_inset Quotes erd
+\end_inset
+
+ program.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-texhash
+$TEXMFLOCAL/tex/latex/
\end_layout
\end_inset
.
- This should create
+ Under TeXLive and the like, you should run
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$TEXMFLOCAL/ls-R
+texhash
\end_layout
\end_inset
- amongst others.
+ from a terminal, with root permissions if necessary.
+
\end_layout
\begin_layout Standard
Your package is now installed and available to LaTeX.
- To make it available to LyX, you need to create a Layout file, if one is
- not already available.
- (See the next section.) Once you have a layout file, you need only reconfigure
- (
-\begin_inset Flex CharStyle:MenuItem
+ You can verify this from a terminal by typing `
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+kpsewhich yourfile.ext
\end_layout
\end_inset
-) and then restart LyX.
- You should then see your new package—for example
+'.
+ To make LyX aware of it, however, you will need to reconfigure (
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-slides (FoilTeX)
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
-—under
+) and then restart LyX.
+ If the new package was a document class, such as FoilTeX again, you will
+ now see it available under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Document Class
\end_layout
\end_inset
- in the
+, in this case as
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Document Class
+slides (FoilTeX)
\end_layout
\end_inset
- drop box.
-
+.
+\end_layout
+
+\begin_layout Standard
+What if there isn't a layout file is available for your new document class?
+ Then, unfortunately, LyX will know nothing about it until you create a
+ layout file yourself (or get someone else to do it).
+ That is the topic of the next section.
\end_layout
\begin_layout Section
-Layouts
+Types of layout files
\end_layout
\begin_layout Standard
-This section describes how to write and install your own LyX layout files
- and walks through the
-\begin_inset Flex CharStyle:Code
-status collapsed
+This section describes the various sorts of LyX files that contain layout
+ information.
+ These files describe various paragraph and character styles, determining
+ how LyX should display them and how they should be translated into LaTeX,
+ DocBook, XHTML, or whatever output format is being used.
+
+\end_layout
-\begin_layout Plain Layout
-article
+\begin_layout Standard
+We shall try to provide a thorough description of the process of writing
+ layout files here.
+ However, there are so many different types of documents supported even
+ by just LaTeX that we can't hope to cover every different possibility or
+ problem you might encounter.
+ The LyX users' list is frequented by people with lots of experience with
+ layout design who are willing to share what they've learned, so please
+ feel free to ask questions there.
\end_layout
+\begin_layout Standard
+As you prepare to write a new layout, it is extremely helpful to look at
+ the layouts distributed with LyX.
+ If you write a LyX layout for a LaTeX document class that might also be
+ used by others, or write a module that might be useful to others, then
+ you should consider posting your layout to the
+\begin_inset CommandInset href
+LatexCommand href
+name "layout section on the LyX wiki"
+target "http://wiki.lyx.org/Layouts/Layouts"
+
\end_inset
- text class format as an example.
- The
-\begin_inset Flex CharStyle:Code
+ or even to the LyX developers' list, so that it might be included in LyX
+ itself.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-.layout
+Note that LyX is licensed under the General Public License, so any material
+ that is contribued to LyX must be similarly licensed.
\end_layout
\end_inset
- files describe what paragraph and character styles are available for a
- given document class and how LyX should display them.
- We try to provide a thorough description of the process here; however,
- there are so many different types of documents supported by LaTeX classes
- that we can't hope to cover every different possibility or problem you
- might encounter.
- (The LyX users' list is frequented by people with lots of experience with
- layout design who are willing to share what they've learned.)
+
\end_layout
-\begin_layout Standard
-As you prepare to write a new layout, it is extremely helpful to look at
- the example layouts distributed with LyX.
- If you use a nice LaTeX document class that might be of interest for others,
- too, and have a nice corresponding LyX layout, feel free to contribute
- the stuff to us, so we may put it into the distribution.
- There is also a
-\begin_inset CommandInset href
-LatexCommand href
-name "section on the LyX wiki"
-target "http://wiki.lyx.org/Layouts/Layouts"
+\begin_layout Subsection
+Layout modules
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Layout-modules"
\end_inset
- for this kind of material.
+
\end_layout
\begin_layout Standard
-All the tags described in this chapter are case-insensitive; this means
- that
+We have spoken to this point about `layout files'.
+ But there are different sorts of files that contain layout information.
+ Layout files, strictly so called, have the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Style
+.layout
\end_layout
\end_inset
-,
+ extension and provide LyX with information about document classes.
+ As of LyX 1.6, however, layout information can also be contained in layout
+
+\emph on
+modules
+\emph default
+, which have the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-style
+.module
\end_layout
\end_inset
- and
+ extension.
+ Modules are to LaTeX packages much as layouts are to LaTeX classes, and
+ some modules—such as the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-StYlE
+endnotes
\end_layout
\end_inset
- are really the same command.
- The possible values are printed in brackets after the feature's name.
- The default value if a feature isn't specified inside a text class-description
- is typeset
-\begin_inset Flex CharStyle:Code
+ module—specifcally provide support for one package.
+ In a sense, layout modules are similar to included
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
+These can have any extension, but by convention have the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\emph on
-emphasized
+\begin_layout Plain Layout
+.inc
\end_layout
\end_inset
-.
- If the argument has a data type like
-\begin_inset Quotes eld
-\end_inset
-
-string
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
+ extension.
+\end_layout
-float
-\begin_inset Quotes erd
\end_inset
-, the default is shown like this:
+ files—files like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=
-\emph on
-default
-\end_layout
-
-\end_inset
-
-.
+stdsections.inc
\end_layout
-\begin_layout Subsection
-Layout modules
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Layout-modules"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Similar to layout files, and new with LyX 1.6, are layout
-\emph on
-modules
-\emph default
-.
- Modules are to LaTeX packages much as layouts are to LaTeX classes, and
- some modules—such as the endnotes module—provide support for just such
- a package.
- In a sense, layout modules are similar to included files—files like
+—in that modules are not specific to a given document class but may be used
+ with many different classes.
+ The difference is that using an included file with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-stdsections.inc
+article.cls
\end_layout
\end_inset
-—in that modules are not specific to a given document layout but may be
- used with many different layouts.
- The difference is that using a layout module does not require editing the
- layout file.
- Rather, modules are selected in the
+ requires editing that file.
+ Modules, by contrast, are selected in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Standard
Building modules is the easiest way to get started with layout editing,
- since it can be as simple as adding a single new paragraph or flex inset.
+ since it can be as simple as adding a single new paragraph style or flex
+ inset.
But modules may, in principle, contain anything a layout file can contain.
\end_layout
\begin_layout Standard
-A module must begin with a line like the following:
-\end_layout
-
-\begin_layout LyX-Code
-#
-\backslash
-DeclareLyXModule[endnotes.sty]{Endnotes}
-\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 CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
-\end_layout
-
-\end_inset
-
-.
-
-\change_inserted 0 1243500588
-
-\end_layout
-
-\begin_layout Standard
-The argument in square brackets is optional: It declares any LaTeX packages
- on which the module depends.
- Please note that only packages about which LyX knows should be listed in
- the square brackets.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The list of such packages is documented only in the source code.
-\end_layout
-
-\end_inset
-
- LyX will not check for arbitrary packages.
-
-\change_inserted 0 1243500694
- It is also possible to use the form
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted 0 1243500706
-from->to
-\end_layout
-
-\end_inset
-
-, which declares that the module can only be used when there exists a conversion
- chain between formats `from' and `to'.
-\change_unchanged
-
-\end_layout
-
-\begin_layout Standard
-The module declaration should then be followed by lines like the following:
-\end_layout
-
-\begin_layout LyX-Code
-#DescriptionBegin
-\end_layout
-
-\begin_layout LyX-Code
-#Adds an endnote command, in addition to footnotes.
-
-\end_layout
-
-\begin_layout LyX-Code
-#You will need to add
-\backslash
-theendnotes in TeX code where you
-\end_layout
-
-\begin_layout LyX-Code
-#want the endnotes to appear.
-
-\end_layout
-
-\begin_layout LyX-Code
-#DescriptionEnd
-\end_layout
-
-\begin_layout LyX-Code
-#Requires: somemodule | othermodule
-\end_layout
-
-\begin_layout LyX-Code
-#Excludes: badmodule
-\end_layout
-
-\begin_layout Standard
-The description is used in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
-\end_layout
-
-\end_inset
-
- to provide the user with information about what the module does.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Requires
-\end_layout
-
-\end_inset
-
- line is used to identify other modules with which this one must be used;
- the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Excludes
-\end_layout
-
-\end_inset
-
- line is used to identify modules with which this one may not be used.
- Both are optional, and, as shown, multiple modules should be separated
- with the pipe symbol: |.
- Note that the required modules are treated disjunctively:
-\emph on
-at least one
-\emph default
- of the required modules must be used.
- Similarly,
-\emph on
-no
-\emph default
- excluded module may be used.
- Note that modules are identified here by their
-\emph on
-filenames
-\emph default
- without the .module extension.
- So
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-somemodule
-\end_layout
-
-\end_inset
-
- is really
+After creating a new module and copying it to the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-somemodule.module
+layout/
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Standard
-After creating a new module, you will need to reconfigure and then restart
- LyX for the module to appear in the menu.
+ folder, you will need to reconfigure and then restart LyX for the module
+ to appear in the menu.
However, changes you make to the module will be seen immediately, if you
open
\begin_inset Flex CharStyle:MenuItem
.
\emph on
-It is strongly recommended that you save your work before doing so
+It is strongly recommended that you save your work before doing this
\emph default
.
In fact,
\emph on
it is strongly recommended that you not attempt to edit modules while simultaneo
-usly working on documents
+usly working on actual documents
\emph default
.
Though of course the developers strive to keep LyX stable in such situations,
\end_layout
\begin_layout Subsection
-Supporting new document classes
+Layout for
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+.sty
+\end_layout
+
+\end_inset
+
+ files
\end_layout
\begin_layout Standard
) files.
Supporting a style file is usually fairly easy.
- Supporting a new document class is a bit harder.
+ 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.
\end_layout
-\begin_layout Subsection
-A layout for a
+\begin_layout Standard
+The easier case is the one in which your new document class is provided
+ as a style file that is to be used in conjunction with an already supported
+ document class.
+ For the sake of the example, we'll assume that the style file is called
+
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-sty
+myclass.sty
\end_layout
\end_inset
- file
-\end_layout
-
-\begin_layout Standard
-If your new document class is provided as a style file that is used in conjuncti
-on with an existing, supported document class—for the sake of the example,
- we'll assume that the style file is called
+ and that it is meant to be used with
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-myclass.sty
+report.cls
\end_layout
\end_inset
- and it is meant to be used with
-\begin_inset Flex CharStyle:MenuItem
+, which is a standard class.
+
+\end_layout
+
+\begin_layout Standard
+Start by copying the existing class's layout file into your local directory:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-report.cls
+Of course, which directory is your local directory will vary by platform,
+ and LyX allows you to specify your local directory on startup, too, using
+ the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-userdir
+\end_layout
+
+\end_inset
+
+ option.
\end_layout
\end_inset
-, which is a standard class—start by copying the existing class's layout
- file into your local directory:
+
\end_layout
\begin_layout LyX-Code
in this example—so you can fiddle around with the settings for the different
sections if you wish.
-\end_layout
-
-\begin_layout Subsection
-Layout for a
-\begin_inset Flex CharStyle:MenuItem
+ The layout information for sections is contained in
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-cls
+stdsections.inc
\end_layout
\end_inset
- file
-\end_layout
-
-\begin_layout Standard
-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 CharStyle:MenuItem
+, but you do not need to copy and change this file.
+ Instead, you can simply add your changes to your layout file, after the
+ line
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-book.cls
+Input stdclass.inc
\end_layout
\end_inset
-.
- To see whether yours is, look for a line like
-\end_layout
+, which itself includes
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+stdsections.inc
+\end_layout
+
+\end_inset
+
+.
+ For example, you might add these lines:
+\end_layout
\begin_layout LyX-Code
+Style Chapter
+\end_layout
-\backslash
-LoadClass{book}
+\begin_layout LyX-Code
+ Font
+\end_layout
+
+\begin_layout LyX-Code
+ Family Sans
+\end_layout
+
+\begin_layout LyX-Code
+ EndFont
+\end_layout
+
+\begin_layout LyX-Code
+End
\end_layout
\begin_layout Standard
-in the file.
- If so, then you may proceed largely as in the previous section, though
- the DeclareLaTeXClass line will be different.
- If your new class is thesis, and it is based upon book, then the line should
- read:
-\begin_inset Foot
-status collapsed
+to change the font for chapter headings to sans-serif.
+ This will override (or, in this case, add to) the existing declaration
+ for the Chapter style.
+
+\end_layout
-\begin_layout Plain Layout
-And it will be easiest if you save the file to
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Your new package may also provide commands or environments not present in
+ the base class.
+ In this case, you will want to add these to the layout file.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:TextClass"
+
+\end_inset
+
+ for information on how to do so.
+\end_layout
+
+\begin_layout Standard
+If
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-thesis.layout
+myclass.sty
\end_layout
\end_inset
-: LyX assumes that the document class has the same name as the layout file.
-
+ can be used with several different document classes, and even if it cannot,
+ you might find it easiest just to write a module that you can load with
+ the base class.
+ The simplest possible such module would be:
\end_layout
-\end_inset
+\begin_layout LyX-Code
+#
+\backslash
+DeclareLyXModule{My Package}
+\end_layout
+\begin_layout LyX-Code
+#DescriptionBegin
+\end_layout
+\begin_layout LyX-Code
+#Support for mypkg.sty.
\end_layout
\begin_layout LyX-Code
+#DescriptionEnd
+\begin_inset Newline newline
+\end_inset
+
-\backslash
-DeclareLaTeXClass[thesis,book]{thesis}
\end_layout
-\begin_layout Standard
-If, on the other hand, the new class is not based upon an existing class,
- you will probably have to
-\begin_inset Quotes eld
+\begin_layout LyX-Code
+Format 20
+\begin_inset Newline newline
\end_inset
-roll your own
-\begin_inset Quotes erd
-\end_inset
- layout.
- We strongly suggest copying an existing layout file which uses a similar
- LaTeX class and then modifying it, if you can do so.
- At least use an existing file as a starting point so you can find out what
- items you need to worry about.
- Again, the specifics are covered below.
\end_layout
-\begin_layout Section
-Declaring a new text class
-\end_layout
+\begin_layout LyX-Code
+Preamble
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-When it's finally time to get your hands dirty and create or edit your own
- layout file, the following sections describe what you're up against.
- Our advice is to go slowly, save and test often, listen to soothing music,
- and enjoy one or two of your favorite adult beverages; more if you are
- getting particularly stuck.
- It's really not that hard, except that the multitude of options can become
- overwhelming if you try to do to much in one sitting.
- Go have another adult beverage, just for good measure.
+
+\backslash
+usepackage{mypkg}
+\begin_inset Newline newline
+\end_inset
+
+EndPreamble
\end_layout
\begin_layout Standard
-Here we go!
+A more complex module might modify the behavior of some existing constructs
+ or define some new ones.
+ Again, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:TextClass"
+
+\end_inset
+
+ for discussion.
\end_layout
-\begin_layout Standard
-Lines in a layout file which begin with a
-\begin_inset Flex CharStyle:Code
+\begin_layout Subsection
+Layout for
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-#
+.cls
\end_layout
\end_inset
- are comments.
- There is one exception to this rule: all layouts should begin with lines
- like:
+ files
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+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 CharStyle:MenuItem
+status collapsed
-\size small
-#% Do not delete the line below; configure depends on this
+\begin_layout Plain Layout
+book.cls
+\end_layout
+
+\end_inset
+
+.
+ To see whether yours is, look for a line like
\end_layout
\begin_layout LyX-Code
-\size small
-#
\backslash
-DeclareLaTeXClass{article}
+LoadClass{book}
\end_layout
\begin_layout Standard
-The second line is used when you configure LyX.
- The layout file is read by the LaTeX script
+in the file.
+ If so, then you may proceed largely as in the previous section, though
+ the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chkconfig.ltx
+DeclareLaTeXClass
\end_layout
\end_inset
-, in a special mode where
+ line will be different.
+ If your new class is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-#
+thesis
\end_layout
\end_inset
- is ignored.
- The first line is just a LaTeX comment, and the second one contains the
- declaration of the text class.
- If these lines appear in a file named
+ and it is based upon
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-article.layout
+book
\end_layout
\end_inset
-, then they define a text class of name
+, then the line should read:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+And it will be easiest if you save the file to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-article
+thesis.layout
\end_layout
\end_inset
- (the name of the layout file) which uses the LaTeX document class
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-article.cls
+: LyX assumes that the document class has the same name as the layout file.
+
\end_layout
\end_inset
- (the default is to use the same name as the layout).
- The string
+
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+DeclareLaTeXClass[thesis,book]{thesis}
+\end_layout
+
+\begin_layout Standard
+If, on the other hand, the new class is not based upon an existing class,
+ you will probably have to
\begin_inset Quotes eld
\end_inset
-article
+roll your own
\begin_inset Quotes erd
\end_inset
- that appears above is used as a description of the text class in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+ layout.
+ We strongly suggest copying an existing layout file which uses a similar
+ LaTeX class and then modifying it, if you can do so.
+ At least use an existing file as a starting point so you can find out what
+ items you need to worry about.
+ Again, the specifics are covered below.
\end_layout
+\begin_layout Subsection
+Creating templates
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Creating-Templates"
+
\end_inset
- dialog.
+
\end_layout
\begin_layout Standard
-Let's assume that you wrote your own text class that uses the
+Once you have written a layout file for a new document class, you might
+ want to consider writing a
+\emph on
+template
+\emph default
+ for it, too.
+ A template acts as a kind of tutorial for your layout, showing how it might
+ be used, though containing dummy content.
+ You can of course look at the various templates included with LyX for ideas.
+\end_layout
+
+\begin_layout Standard
+Templates are created just like usual documents: using LyX.
+ The only difference is that usual documents contain all possible settings,
+ including the font scheme and the paper size.
+ Usually a user doesn't want a template to overwrite his preferred settings
+ for such parameters.
+ For that reason, the designer of a template should remove the corresponding
+ commands like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-article.cls
+
+\backslash
+font_roman
\end_layout
\end_inset
- document class, but where you changed the appearance of the section headings.
- If you put it in a file
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myarticle.layout
+
+\backslash
+papersize
\end_layout
\end_inset
-, the header of this file should be:
+ from the template LyX file.
+ This can be done with any simple text-editor, for example
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+vi
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\size small
-#% Do not delete the line below; configure depends on this
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+notepad
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\size small
-#
-\backslash
-DeclareLaTeXClass[article]{article (with my own headings)}
+.
+
\end_layout
\begin_layout Standard
-This declares a text class
+Put the edited template files you create in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myarticle
+UserDir/templates/
\end_layout
\end_inset
-, associated with the LaTeX document class
+, copy the ones you use from the global template directory in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-article.cls
+LyXDir/templates/
\end_layout
\end_inset
- and described as
-\begin_inset Quotes eld
-\end_inset
+ to the same place, and redefine the template path in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-article (with my own headings)
-\begin_inset Quotes erd
-\end_inset
-
-.
- If your text class depends on several packages, you can declare it as:
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
-\end_layout
-
-\begin_layout Standard
-This indicates that your text class uses the foo.sty package.
- Finally, it is also possible to declare classes for DocBook code.
- Typical declarations will look like
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareDocBookClass[article]{SGML (DocBook article)}
-\end_layout
-
-\begin_layout Standard
-Note that these declarations can also be given an optional parameter declaring
- the name of the document class (but not a list).
-\end_layout
-
-\begin_layout Standard
-So, to be as explicit as possible, the form of the layout declaration is:
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[class,package.sty]{layout description}
-\end_layout
+\end_inset
-\begin_layout Standard
-The class need only be specified if the name of the LaTeX class file and
- the name of the layout file are different; if the name of the class file
- is not specified, then LyX will simply assume that it is the same as the
- name of the layout file.
+ dialog.
\end_layout
\begin_layout Standard
-When the text class has been modified to your taste, all you have to do
- is to copy it either to
+Note, by the way, that there is a template which has a particular meaning:
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/layouts/
+defaults.lyx
\end_layout
\end_inset
- or to
-\begin_inset Flex CharStyle:Code
+.
+ This template is loaded every time you create a new document with
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-UserDir/layouts
+File\SpecialChar \menuseparator
+New
\end_layout
\end_inset
-, run
+ in order to provide useful defaults.
+ To create this template from inside LyX, all you have to do is to open
+ a document with the correct settings, and use the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+Save as Document Defaults
\end_layout
\end_inset
-, exit LyX and restart it.
- Then your new text class should be available along with the others.
+ button.
+\end_layout
+
+\begin_layout Subsection
+Upgrading old layout files
\end_layout
\begin_layout Standard
-In versions of LyX prior to 1.6, you had to restart LyX to see any changes
- you made to your layout files.
- As a result, editing layout files could be very time consuming.
- Beginning with 1.6, however, you can force a reload of the layout currently
- in use by using the LyX function
-\begin_inset Flex CharStyle:MenuItem
+The format of layout files changes with each LyX release, so old layout
+ files need to be converted to the new format.
+ This process has been automated since LyX 1.4: If LyX reads a layout file
+ in an older format, it automatically calls the script
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-layout-reload
+layout2layout.py
\end_layout
\end_inset
-.
- There is no default binding for this function—though, of course, you can
- bind it to a key yourself.
- If you want to use this function, then, you should simply enter it in the
- mini-buffer.
-
-\emph on
-Warning
-\emph default
-: This is very much an `advanced feature'.
- It is
-\emph on
-strongly
-\emph default
- recommended that you save your work before using this function.
- In fact, it is
-\emph on
-strongly
-\emph default
- recommended that you not attempt to edit your layout while simultaneously
- working on a document that you care about.
- Use a test document.
- Syntax errors and the like in your layout file could cause peculiar behavior.
- In particular, such errors could cause LyX to regard the current layout
- as invalid and to attempt to switch to some other layout.
- The LyX team strives to keep LyX stable in such situations, but safe is
- better than sorry.
+ to convert it to a temporary file in current format.
+ The original file is left untouched.
+ If you use the layout file often, then, you may want to convert it permanently,
+ so that LyX does not have to do so itself every time.
+ To do this, you can call the converter manually:
\end_layout
-\begin_layout Subsection
-File format
+\begin_layout LyX-Code
+mv myclass.layout myclass.old
\end_layout
-\begin_layout Standard
-The first non-comment line must contain the file format number:
+\begin_layout LyX-Code
+python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
\end_layout
-\begin_layout Description
+\begin_layout Standard
+You need to replace
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Format
+LyXDir
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
+ with the name of your LyX system directory, of course.
+\end_layout
-\begin_layout Plain Layout
-int
+\begin_layout Standard
+Note that manual conversion does not affect included files, so these will
+ have to be converted separately.
\end_layout
-\end_inset
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:TextClass"
-] This tag was introduced with LyX 1.4.0 (layout files of LyX 1.3.x and earlier
- don't have an explicit file format).
- The file format that is documented here is format 14.
-\end_layout
+\end_inset
-\begin_layout Subsection
-General text class parameters
+The layout file format
\end_layout
\begin_layout Standard
-These are the general parameters which describe the form of the entire document:
+When it's finally time to get your hands dirty and create or edit your own
+ layout file, the following sections describe what you're up against.
+ Our advice is to go slowly, save and test often, listen to soothing music,
+ and enjoy one or two of your favorite adult beverages; more if you are
+ getting particularly stuck.
+ It's really not that hard, except that the multitude of options can become
+ overwhelming if you try to do too much in one sitting.
+ Go have another adult beverage, just for good measure.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Note that all the tags used in layout files are case-insensitive.
+ This means that
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+Style
\end_layout
\end_inset
- Adds information to the document preamble.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+style
\end_layout
\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+StYlE
\end_layout
-\begin_layout Description
+\end_inset
+
+ are really the same tag.
+ The possible values are printed in brackets after the feature's name.
+ The default value if a feature isn't specified inside a text class-description
+ is typeset
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+
+\emph on
+emphasized
\end_layout
\end_inset
- Describes various global options supported by the document class.
- See Section
-\begin_inset space ~
+.
+ If the argument has a data type like
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:ClassOptions"
-
+string
+\begin_inset Quotes erd
\end_inset
- for a description.
- Must end with
+ or
\begin_inset Quotes eld
\end_inset
+float
+\begin_inset Quotes erd
+\end_inset
+, the default is shown like this:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+float=
+\emph on
+default
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
-\begin_layout Description
+\begin_layout Subsection
+The Document Class Declaration
+\end_layout
+
+\begin_layout Standard
+Lines in a layout file which begin with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Columns
+#
\end_layout
\end_inset
- [
+ are comments.
+ There is one exception to this rule.
+ All
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+*.layout
\end_layout
\end_inset
-,
+ files should begin with a line like:
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#
+\backslash
+DeclareLaTeXClass{article}
+\end_layout
+
+\begin_layout Standard
+The second line is used when you (re)configure LyX.
+ The layout file is read by the LaTeX script
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-2
+chkconfig.ltx
\end_layout
\end_inset
-] Whether the class should default to having one or two columns.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
+, in a special mode where
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+#
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Description
+ is ignored.
+ The first line is just a LaTeX comment, and the second one contains the
+ declaration of the text class.
+ If these lines appear in a file named
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Counter
+article.layout
\end_layout
\end_inset
- This sequence defines a new counter.
+, then they define a text class of name
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article
+\end_layout
+
+\end_inset
+
+ (the name of the layout file) which uses the LaTeX document class
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article.cls
+\end_layout
+
+\end_inset
+
+ (the default is to use the same name as the layout).
+ The string
+\begin_inset Quotes eld
+\end_inset
+
+article
+\begin_inset Quotes erd
+\end_inset
+
+ that appears above is used as a description of the text class in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ dialog.
+\end_layout
+
+\begin_layout Standard
+Let's assume that you wrote your own text class that uses the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article.cls
+\end_layout
+
+\end_inset
+
+ document class, but where you changed the appearance of the section headings.
+ If you put it in a file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+myarticle.layout
+\end_layout
+
+\end_inset
+
+, the header of this file should be:
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#
+\backslash
+DeclareLaTeXClass[article]{article (with my own headings)}
+\end_layout
+
+\begin_layout Standard
+This declares a text class
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+myarticle
+\end_layout
+
+\end_inset
+
+, associated with the LaTeX document class
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article.cls
+\end_layout
+
+\end_inset
+
+ and described as
+\begin_inset Quotes eld
+\end_inset
+
+article (with my own headings)
+\begin_inset Quotes erd
+\end_inset
+
+.
+ If your text class depends on several packages, you can declare it as:
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#
+\backslash
+DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
+\end_layout
+
+\begin_layout Standard
+This indicates that your text class uses the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+foo.sty
+\end_layout
+
+\end_inset
+
+ package.
+ Finally, it is also possible to declare classes for DocBook code.
+ Typical declarations will look like:
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#
+\backslash
+DeclareDocBookClass[article]{SGML (DocBook article)}
+\end_layout
+
+\begin_layout Standard
+Note that these declarations can also be given an optional parameter declaring
+ the name of the document class (but not a list).
+\end_layout
+
+\begin_layout Standard
+So, to be as explicit as possible, the form of the layout declaration is:
+\end_layout
+
+\begin_layout LyX-Code
+
+\size small
+#
+\backslash
+DeclareLaTeXClass[class,package.sty]{layout description}
+\end_layout
+
+\begin_layout Standard
+The class need only be specified if the name of the LaTeX class file and
+ the name of the layout file are different; if the name of the class file
+ is not specified, then LyX will simply assume that it is the same as the
+ name of the layout file.
+\end_layout
+
+\begin_layout Standard
+When the text class has been modified to your taste, all you have to do
+ is to copy it either to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir/layouts/
+\end_layout
+
+\end_inset
+
+ or to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir/layouts
+\end_layout
+
+\end_inset
+
+, run
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Reconfigure
+\end_layout
+
+\end_inset
+
+, exit LyX and restart.
+ Then your new text class should be available along with the others.
+\end_layout
+
+\begin_layout Standard
+Once the layout file is installed, you can edit it and see your changes
+ without having to reconfigure or to restart LyX.
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In versions of LyX prior to 1.6, this was not true.
+ As a result, editing layout files was very time consuming, since you had
+ constantly to restart LyX to see changes.
+\end_layout
+
+\end_inset
+
+ You can force a reload of the current layout by using the LyX function
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+layout-reload
+\end_layout
+
+\end_inset
+
+.
+ There is no default binding for this function—though, of course, you can
+ bind it to a key yourself.
+ But you will normally use this function simply by entering it in the mini-buffe
+r.
+
+\end_layout
+
+\begin_layout Standard
+
+\emph on
+Warning
+\emph default
+:
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+layout-reload
+\end_layout
+
+\end_inset
+
+ is very much an `advanced feature'.
+ It is
+\emph on
+strongly
+\emph default
+ recommended that you save your work before using this function.
+ In fact, it is
+\emph on
+strongly
+\emph default
+ recommended that you not attempt to edit layout information while simultaneousl
+y working on a document that you care about.
+ Use a test document.
+ Syntax errors and the like in your layout file could cause peculiar behavior.
+ In particular, such errors could cause LyX to regard the current layout
+ as invalid and to attempt to switch to some other layout.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Really bad syntax errors may even caused LyX to exit.
+ This is because certain sorts of errors may make LyX unable to read
+\emph on
+any
+\emph default
+ layout information.
+ Please be careful.
+\end_layout
+
+\end_inset
+
+ The LyX team strives to keep LyX stable in such situations, but safe is
+ better than sorry.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+While we're giving advice: make regular backups.
+ And be nice to your mother.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+The Module Declaration
+\end_layout
+
+\begin_layout Standard
+A module must begin with a line like the following:
+\end_layout
+
+\begin_layout LyX-Code
+#
+\backslash
+DeclareLyXModule[endnotes.sty]{Endnotes}
+\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 CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+.
+ The argument in square brackets is optional: It declares any LaTeX packages
+ on which the module depends.
+ Please note that only packages about which LyX knows should be listed in
+ the square brackets.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The list of such packages is documented only in the source code.
+\end_layout
+
+\end_inset
+
+ LyX will not check for arbitrary packages.
+ It is also possible to use the form
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+from->to
+\end_layout
+
+\end_inset
+
+ as an optional argument, which declares that the module can only be used
+ when there exists a conversion chain between the formats `
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+from
+\end_layout
+
+\end_inset
+
+' and `
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+to
+\end_layout
+
+\end_inset
+
+'.
+\end_layout
+
+\begin_layout Standard
+The module declaration should then be followed by lines like the following:
+\end_layout
+
+\begin_layout LyX-Code
+#DescriptionBegin
+\end_layout
+
+\begin_layout LyX-Code
+#Adds an endnote command, in addition to footnotes.
+
+\end_layout
+
+\begin_layout LyX-Code
+#You will need to add
+\backslash
+theendnotes in TeX code where you
+\end_layout
+
+\begin_layout LyX-Code
+#want the endnotes to appear.
+
+\end_layout
+
+\begin_layout LyX-Code
+#DescriptionEnd
+\end_layout
+
+\begin_layout LyX-Code
+#Requires: somemodule | othermodule
+\end_layout
+
+\begin_layout LyX-Code
+#Excludes: badmodule
+\end_layout
+
+\begin_layout Standard
+The description is used in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ to provide the user with information about what the module does.
+ The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Requires
+\end_layout
+
+\end_inset
+
+ line is used to identify other modules with which this one must be used;
+ the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Excludes
+\end_layout
+
+\end_inset
+
+ line is used to identify modules with which this one may not be used.
+ Both are optional, and, as shown, multiple modules should be separated
+ with the pipe symbol: |.
+ Note that the required modules are treated disjunctively:
+\emph on
+at least one
+\emph default
+ of the required modules must be used.
+ Similarly,
+\emph on
+no
+\emph default
+ excluded module may be used.
+ Note that modules are identified here by their
+\emph on
+filenames
+\emph default
+ without the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
+\end_inset
+
+ extension.
+ So
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+somemodule
+\end_layout
+
+\end_inset
+
+ is really
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+somemodule.module
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+File format
+\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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+int
+\end_layout
+
+\end_inset
+
+] The format of the layout file.
+\end_layout
+
+\begin_layout Standard
+This tag was introduced with LyX 1.4.0.
+ Layout files from LyX 1.3.x and earlier don't have an explicit file format
+ and are considered to be of format 1.
+ The format for the present version of LyX is format 20.
+ But each version of LyX is capable of reading earlier versions' layout
+ files, just as they are capable of reading files produced by earlier versions
+ of LyX.
+ There is, however, no provision for converting to earlier formats.
+ So LyX 1.6.x will not read layout files in format 20 but only files in format
+ 11 or earlier.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:General-text-class"
+
+\end_inset
+
+General text class parameters
+\end_layout
+
+\begin_layout Standard
+These are general parameters that govern the behavior of an entire document
+ class.
+ (This does
+\emph on
+not
+\emph default
+ mean that they must appear in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.layout
+\end_layout
+
+\end_inset
+
+ files rather than in modules.
+ A module can contain any layout tag.)
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\end_layout
+
+\end_inset
+
+ Adds information that will be output in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ block when this document class 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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToPreamble
+\end_layout
+
+\end_inset
+
+ Adds information to the document preamble.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+ClassOptions
+\end_layout
+
+\end_inset
+
+ Describes various global options supported by the document class.
+ See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:ClassOptions"
+
+\end_inset
+
+ for a description.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Columns
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+2
+\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 CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Counter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\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.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+ for details on counters.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultFont
+\end_layout
+
+\end_inset
+
+ Sets the default font used to display the document.
+ See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+ for how to declare fonts.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+EndFont
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultModule
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string]
+\end_layout
+
+\end_inset
+
+ Specifies a module to be included by default with this document class.
+ The module should be specified by filename without the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\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.)
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] This is the style that will be assigned to new paragraphs, usually
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\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
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+ExcludesModule
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] This tag indicates that the module in question—which should be specified
+ by filename without the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
+\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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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 "sub:Layout-modules"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Float
+\end_layout
+
+\end_inset
+
+ Defines a new float.
See Section
\begin_inset space ~
\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Floats"
+
+\end_inset
+
+ for details.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Sets the information that will be output in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ block when this document class is output to XHTML.
+ Note that this will completely override any prior
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\end_layout
+
+\end_inset
+
+ declarations.
+ (Use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+IfCounter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Modifies the properties of the given counter.
+ If the counter does not exist, the section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+ for details on counters.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+IfStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Modifies the properties of the given paragraph style.
+ If the style does not exist, the section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Input
+\end_layout
+
+\end_inset
+
+ As its name implies, this command 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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+stdclass.inc
+\end_layout
+
+\end_inset
+
+, which contains most of the basic layouts.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Flex-insets-and"
+
+\end_inset
+
+ for more information.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LeftMargin
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\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
+
+MMMMM
+\begin_inset Quotes erd
+\end_inset
+
+.
+ (Note that this is not a `length', like
+\begin_inset Quotes eld
+\end_inset
+
+2ex
+\begin_inset Quotes erd
+\end_inset
+
+.)
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+NoFloat
+\end_layout
+
+\end_inset
+
+ This command 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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+NoStyle
+\end_layout
+
+\end_inset
+
+ This command deletes an existing style.
+ This is particularly useful when you want to suppress a style that has
+ be defined in an input file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputFormat
+\end_layout
+
+\end_inset
+
+ A string indicating the file format (as defined in the Preferences dialog)
+ produced by this class.
+ It is mainly useful when
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputType
+\end_layout
+
+\end_inset
+
+ is `literate' and one wants to define a new type of literate document.
+ This string is reset to `docbook', `latex', or `literate' when the correspondin
+g
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputType
+\end_layout
+
+\end_inset
+
+ parameter is encountered.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+OutputType
+\end_layout
+
+\end_inset
+
+ A string indicating what sort of output documents using this class will
+ produce.
+ At present, the options are: `docbook', `latex', and `literate'.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+PageStyle
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+plain
+\end_layout
+
+\end_inset
+
+
+\emph default
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+empty
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+headings
+\end_layout
+
+\end_inset
+
+] The default pagestyle.
+ Can be changed in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
+
+\end_inset
+
+ Sets the preamble for the LaTeX document.
+ Note that this will completely override any prior
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToPreamble
+\end_layout
+
+\end_inset
+
+ declarations.
+ (Use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Provides
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether the class already provides the feature
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+.
+ A feature is in general the name of a package (
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+amsmath
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+makeidx
+\end_layout
+
+\end_inset
+
+, \SpecialChar \ldots{}
+) or a macro (
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+url
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+boldsymbol
+\end_layout
+
+\end_inset
+
+,\SpecialChar \ldots{}
+); the complete list of supported features is unfortunately not documented
+ outside the LyX source code—but see
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LaTeXFeatures.cpp
+\end_layout
+
+\end_inset
+
+ if you're interested.
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Help\SpecialChar \menuseparator
+LaTeX Configuration
+\end_layout
+
+\end_inset
+
+ also gives an overview of the supported packages.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+ProvidesModule
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Indicates that this layout provides the functionality of the module mentioned,
+ which should be specified by the filename without the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
+\end_inset
+
+ extension.
+ This will typically be used if the layout includes the module directly,
+ rather than using the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+DefaultModule
+\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.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Requires
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Whether the class requires the feature
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+.
+ Multiple features must be separated by commas.
+ Note that you can only request supported features.
+ (Again, see
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LaTeXFeatures.cpp
+\end_layout
+
+\end_inset
+
+ for a list of these.)
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+RightMargin
+\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
+
+MMMMM
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SecNumDepth
+\end_layout
+
+\end_inset
+
+ Sets which divisions get numbered.
+ Corresponds to the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+secnumdepth
+\end_layout
+
+\end_inset
+
+ counter in LaTeX.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Sides
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+
+\emph default
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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 CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Style
+\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
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Styles"
+
+\end_inset
+
+ for details on paragraph styles.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string="maketitle"
+\end_layout
+
+\end_inset
+
+] The name of the command or environment to be used with
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+CommandAfter
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Environment
+\end_layout
+
+\end_inset
+
+] Indicates what kind of markup is used to define the title of a document.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+CommandAfter
+\end_layout
+
+\end_inset
+
+ means that the macro with name
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\end_layout
+
+\end_inset
+
+ will be inserted after the last layout which has
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+InTitle 1
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Environment
+\end_layout
+
+\end_inset
+
+ corresponds to the case where the block of paragraphs which have
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+InTitle 1
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ should be enclosed into the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\end_layout
+
+\end_inset
+
+ environment.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TocDepth
+\end_layout
+
+\end_inset
+
+ Sets which divisions are included in the table of contents.
+ Corresponds to the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+tocdepth
+\end_layout
+
+\end_inset
+
+ counter in LaTeX.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+ClassOptions
+\end_layout
+
+\end_inset
+
+ section
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:ClassOptions"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+ClassOptions
+\end_layout
+
+\end_inset
+
+ section can contain the following entries:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+FontSize
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string="10|11|12"
+\end_layout
+
+\end_inset
+
+] The list of available font sizes for the document's main font, separated
+ by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+|
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Header
+\end_layout
+
+\end_inset
+
+ Used to set the DTD line with XML-based output classes.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.: PUBLIC
+\begin_inset Quotes eld
+\end_inset
+
+-//OASIS//DTD DocBook V4.2//EN
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+PageStyle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string="empty|plain|headings|fancy"
+\end_layout
+
+\end_inset
+
+] The list of available page styles, separated by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+|
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Other
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
+\end_layout
+
+\end_inset
+
+] Some document class options, separated by a comma, that will be added
+ to the optional part of the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+documentclass
+\end_layout
+
+\end_inset
+
+ command.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+ClassOptions
+\end_layout
+
+\end_inset
+
+ section must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Paragraph Styles
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Paragraph-Styles"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A paragraph style description looks like this:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this will either define a new layout or modify an existing one.
+\end_layout
+
+\end_inset
+
+
+\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
+
+\begin_layout Standard
+where the following commands are allowed:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Align
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+block
+\emph default
+, left, right, center
+\end_layout
+
+\end_inset
+
+] Paragraph alignment.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AlignPossible
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+block
+\emph default
+, left, right, center
+\end_layout
+
+\end_inset
+
+] A comma separated list of permitted alignments.
+ (Some 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
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
\end_inset
- for details.
+ Language dependent information to be included in the LaTeX preamble when
+ this style is used.
+ Note that this will completely override any prior
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ declarations.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+EndBabelPreamble
\end_layout
\end_inset
\end_inset
.
+ The contents of this tag will occur once in the LaTeX preamble for each
+ language used by the document.
+ Each time, the following substitutions are made:
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DefaultFont
+$$lang
\end_layout
\end_inset
- Sets the default font used to display the document.
- See Section
-\begin_inset space ~
+ is replaced by the language name (as used by the babel package).
+\end_layout
+
+\begin_layout Itemize
+The
+\begin_inset Quotes eld
+\end_inset
+
+Function
+\begin_inset Quotes erd
\end_inset
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+_()
+\end_layout
\end_inset
- for how to declare fonts.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+ replaces its argument by the translation of the argument to the current
+ language.
+\end_layout
+\begin_layout Standard
+This preamble snippet will only be used if the document contains more than
+ one language and the babel package is used.
+\end_layout
+\end_deeper
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndFont
+BottomSep
\end_layout
\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+]
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that a `float' here is a real number, such as: 1.5.
+\end_layout
+
+\end_inset
+
+ The vertical space with which the last of a chain of paragraphs with this
+ layout is separated from the following paragraph.
+ If the next paragraph has another layout, the separations are not simply
+ added, but the maximum is taken.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-DefaultModule
+Category
\end_layout
\end_inset
- [
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string]
+[string]
\end_layout
\end_inset
- Specifies a module to be included by default with this document class,
- which should be specified by filename without the
+ The category for this style.
+ This is used to group related styles in the Layout combobox on the toolbar.
+ Any string can be used, but you may want to use existing categories with
+ your own styles.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.module
+CommandDepth
\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.)
+ Depth of XML command.
+ Used only with XML-type formats.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+CopyStyle
\end_layout
\end_inset
- [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:CopyStyle"
+
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+[string]
\end_layout
\end_inset
-] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex CharStyle:MenuItem
+ Copies all the features of an existing style into the current one.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Standard
+DependsOn
\end_layout
\end_inset
-.
- This will default to the first defined style if not given, but you are
- highly encouraged to use this directive.
+ 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
+Note that, besides that functionality, there is no way to ensure any ordering
+ of preambles.
+ The ordering that you see in a given version of LyX may change without
+ warning in later versions.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ExcludesModule
+EndLabeltype
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+No_Label
+\emph default
+, Box, Filled_Box, Static
\end_layout
\end_inset
-] Indicates that the module in question—which should be specified by filename
- without the
+] The type of label that stands at the end of the paragraph (or sequence
+ of paragraphs if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.module
+LatexType
\end_layout
\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
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-theorems-sec
+Environment
\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 "sub:Layout-modules"
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Item_Environment
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+List_Environment
+\end_layout
\end_inset
).
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+No_Label
\end_layout
-\begin_layout Description
+\end_inset
+
+ means
+\begin_inset Quotes eld
+\end_inset
+
+nothing
+\begin_inset Quotes erd
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Float
+Box
+\end_layout
+
+\end_inset
+
+ (resp.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset space ~
+\end_inset
+
+Filled_Box
\end_layout
\end_inset
- Defines a new float.
- See Section
+) is a white (resp.
\begin_inset space ~
\end_inset
+black) square suitable for end of proof markers,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Floats"
-
-\end_inset
+\begin_layout Plain Layout
+Static
+\end_layout
- for details.
- Must end with
-\begin_inset Quotes eld
\end_inset
+ is an explicit text string.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+EndLabelString
\end_layout
\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+string=""
\end_layout
-\begin_layout Description
+\end_inset
+
+] The string used for a label with a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Input
+Static
\end_layout
\end_inset
- As its name implies, this command 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-stdclass.inc
+EndLabelType
\end_layout
\end_inset
-, which contains most of the basic layouts.
+.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InsetLayout
+Fill_Bottom
\end_layout
\end_inset
- This section (re-)defines the layout of an inset.
- It can be applied to an existing inset of to a new, user-defined inset,
- e.
-\begin_inset space \thinspace{}
-\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Plain Layout
-a new character style.
- See Section
-\begin_inset space ~
-\end_inset
+\emph on
+0
+\emph default
+,1
+\end_layout
+\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Flex-insets-and"
+] Similar to
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+Fill_Top
+\end_layout
- for more information.
- Must end with
-\begin_inset Quotes eld
\end_inset
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+Fill_Top
\end_layout
\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-.
+\emph on
+0
+\emph default
+,1
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+] With this parameter the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Fill
\end_layout
\end_inset
- A string that indicates the width of the left margin on the screen, for
- example,
+ value of the
\begin_inset Quotes eld
\end_inset
-MMMMM
+Vertical space above
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ list of the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-NoFloat
-\end_layout
-
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
- This command deletes an existing float.
- This is particularly useful when you want to suppress a float that has
- be defined in an input file.
+Settings
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ dialog can be set when initializing a paragraph with this style.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-NoStyle
+
+\emph on
+Note from Jean-Marc:
+\emph default
+ I'm not sure that this setting has much use, and it should probably be
+ removed in later versions.
\end_layout
\end_inset
- This command deletes an existing style.
- This is particularly useful when you want to suppress a style that has
- be defined in an input file.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-OutputType
+Font
\end_layout
\end_inset
- A string indicating what sort of output documents using this class will
- produce.
- At present, the options are: `docbook', `latex', and `literate'.
-\change_inserted 0 1243500198
-
-\end_layout
-
-\begin_layout Description
-
-\change_inserted 0 1243500505
-\begin_inset Flex CharStyle:Code
-status collapsed
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-\change_inserted 0 1243500208
-OutputFormat
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
- A string indicating the file format (as defined in the Preferences dialog)
- produced by this class.
- It is mainly useful when
+.
+ Note that defining this font automatically defines the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 0 1243500394
-OutputType
+LabelFont
\end_layout
\end_inset
- is `literate' and one wants to define a new type of literate document.
- This string is reset to `docbook', `latex', or `literate' when the correspondin
-g
+ to the same value.
+ So you should define this one first if you also want to define
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 0 1243500473
-OutputType
+LabelFont
\end_layout
\end_inset
- parameter is encountered.
-\change_unchanged
-
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-
-\series medium
-PageStyle
+FreeSpacing
\end_layout
\end_inset
- [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:FreeSpacing"
+
+\end_inset
+
+[
\emph on
\begin_inset Flex CharStyle:Code
\begin_layout Plain Layout
\emph on
-plain
+0
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-empty
+1
\end_layout
\end_inset
-,
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-headings
-\end_layout
-
-\end_inset
-
-] The class default pagestyle.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+FreeSpacing
\end_layout
\end_inset
- dialog.
+ can be enabled.
+ Note that LyX will create protected blanks for the additional blanks when
+ in another mode than LaTeX-mode.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Preamble
+HTML*
\end_layout
\end_inset
- Sets the preamble for the LaTeX document.
- Note that this will completely override any prior
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Preamble
-\end_layout
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Paragraph-Style-XHTML"
\end_inset
- or
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+InnerTag
\end_layout
\end_inset
- declarations.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
+ [[FIXME]] (Used only with XML-type formats.)
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+InPreamble
\end_layout
\end_inset
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+[1, 0]
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+ If 1, marks the layout as to be included in the document preamble rather
+ than in the document body.
+ This is useful for document classes that want such information as the title
+ and author to appear in the preamble.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Provides
+InTitle
\end_layout
\end_inset
- [
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+[1, 0]
\end_layout
\end_inset
-] [
+ If 1, marks the layout as being part of a title block (see also the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+TitleLatexType
\end_layout
\end_inset
-,
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+TitleLatexName
\end_layout
\end_inset
-] Whether the class already provides the feature
+ global entries).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+ItemSep
\end_layout
\end_inset
-.
- A feature is in general the name of a package (
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-amsmath
+float=0
\end_layout
\end_inset
-,
+] This provides extra space between paragraphs that have the same layout.
+ If you put other layouts into an environment, each is separated with the
+ environment's
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-makeidx
+Parsep
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) or a macro (
+.
+ But the whole items of the environment are additionally separated with
+ this
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-url
+Itemsep
\end_layout
\end_inset
-,
+.
+ Note that this is a
+\emph on
+ multiplier.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-boldsymbol
+ItemTag
\end_layout
\end_inset
-,\SpecialChar \ldots{}
-); the complete list of supported features is unfortunately not documented
- outside the LyX source code—but see
+ [[FIXME]] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LaTeXFeatures.cpp
+KeepEmpty
\end_layout
\end_inset
- if you're interested.
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset CommandInset label
+LatexCommand label
+name "des:KeepEmpty"
+
+\end_inset
+
+[
+\emph on
+
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX Configuration
+
+\emph on
+0
\end_layout
\end_inset
- also gives an overview of the supported packages.
-\end_layout
-\begin_layout Description
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ProvidesModule
+1
\end_layout
\end_inset
- [
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a layout can be used
+ as some kind of break, which does not contain actual text.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LabelBottomsep
\end_layout
\end_inset
-] Indicates that this layout provides the functionality of the module mentioned,
- which should be specified by the filename without the
+ [float=0] The vertical space between the label and the text body.
+ Only used for labels that are above the text body (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.module
+Top_Environment
\end_layout
\end_inset
- extension.
- This will typically be used if the layout includes the module directly,
- rather than using the
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DefaultModule
+Centered_Top_Environment
\end_layout
\end_inset
- tag to indicate that it ought to be used.
- It could 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
-Requires
+LabelCounter
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+string=""
\end_layout
\end_inset
-] Whether the class requires the feature
+]
+\begin_inset Newline newline
+\end_inset
+
+The name of the counter for automatic numbering.
+
+\begin_inset Newline newline
+\end_inset
+
+This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LabelType
\end_layout
\end_inset
-.
- Multiple features must be separated by commas.
- Note that you can only request supported features.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+Counter
\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
-
-MMMMM
-\begin_inset Quotes erd
\end_inset
.
-\end_layout
+ In that case, the counter will be stepped each time the layout appears.
+
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+This
+\emph on
+may
+\emph default
+ also be given if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-SecNumDepth
+LabelType
\end_layout
\end_inset
- Sets which divisions get numbered.
- Corresponds to the
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-secnumdepth
+Enumerate
\end_layout
\end_inset
- counter in LaTeX.
-\end_layout
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sides
+LabelCounter myenum
\end_layout
\end_inset
- [
-\emph on
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Then the actual counters used are
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+myenumi
\end_layout
\end_inset
-
-\emph default
,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-2
+myenumii
\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 CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+myenumiii
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Description
+, and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Style
+myenumiv
\end_layout
\end_inset
- This sequence defines a new paragraph style.
- If the style already exists, it will redefine some of its parameters instead.
- See Section
-\begin_inset space ~
+, much as in LaTeX.
+ These counters must all be declared separately.
+\begin_inset Newline newline
\end_inset
-
+See Section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Paragraph-Styles"
-
-\end_inset
+reference "sub:Counters"
- for details.
- Must end with
-\begin_inset Quotes eld
\end_inset
+ for details on counters.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+LabelFont
\end_layout
\end_inset
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
-\begin_inset Quotes erd
\end_inset
.
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+LabelIndent
\end_layout
\end_inset
- [
+ Text that indicates how far a label should be indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+Labelsep
\end_layout
\end_inset
-] The name of the command or environment to be used with
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+string=""
\end_layout
\end_inset
-.
+] The horizontal space between the label and the text body.
+ Only used for labels that are not above the text body.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TitleLatexType
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-CommandAfter
+LabelString
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+string=""
\end_layout
\end_inset
-] Indicates what kind of markup is used to define the title of a document.
-
+] The string used for a label with a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CommandAfter
+Static
\end_layout
\end_inset
- means that the macro with name
+ labeltype.
+ When
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+LabelCounter
\end_layout
\end_inset
- will be inserted after the last layout which has
-\begin_inset Quotes eld
+ is set, this string can be contain the special formatting commands described
+ in Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
\end_inset
+.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+For the sake of backwards compatibility, the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InTitle 1
+@
+\emph on
+style-name
+\emph default
+@
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-
+ will be replaced by the expanded
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelString
\end_layout
\end_inset
- corresponds to the case where the block of paragraphs which have
-\begin_inset Quotes eld
-\end_inset
-
-
+ of style
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InTitle 1
+
+\emph on
+style-name
\end_layout
\end_inset
+.
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-\begin_inset Quotes erd
\end_inset
- should be enclosed into the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-TitleLatexName
+.
\end_layout
\end_inset
- environment.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TocDepth
+LabelStringAppendix
\end_layout
\end_inset
- Sets which divisions are included in the table of contents.
- Corresponds to the
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tocdepth
+string=""
\end_layout
\end_inset
- counter in LaTeX.
-\end_layout
-
-\begin_layout Subsection
+] This is used inside the appendix instead of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+LabelString
\end_layout
\end_inset
- section
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:ClassOptions"
-
-\end_inset
-
+.
+ Note that every
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout Standard
-The
+\end_inset
+
+ statement resets
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+LabelStringAppendix
\end_layout
\end_inset
- section can contain the following entries:
+ too.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-FontSize
+LabelTag
\end_layout
\end_inset
- [
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string="10|11|12"
+LabelType
\end_layout
\end_inset
-] The list of available font sizes for the document's main font, separated
- by
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-|
-\end_layout
-
-\end_inset
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
+ Enumerate, Itemize, Bibliography
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+]
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Header
+Manual
\end_layout
\end_inset
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.: PUBLIC
-\begin_inset Quotes eld
-\end_inset
-
--//OASIS//DTD DocBook V4.2//EN
-\begin_inset Quotes erd
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces (like
+\begin_inset space ~
\end_inset
-.
+that one) if you want more than one word as the label.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-PageStyle
+Static
\end_layout
\end_inset
- [
+ means the label is simply whatever
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string="empty|plain|headings|fancy"
+LabelString
\end_layout
\end_inset
-] The list of available page styles, separated by
-\begin_inset Quotes eld
-\end_inset
-
+ declares it to be.
+ Note that this really is `static'.
+\end_layout
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-|
+Top_Environment
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Other
+Centered_Top_Environment
\end_layout
\end_inset
- [
+ are special cases of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+Static
\end_layout
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
-\begin_inset Flex CharStyle:Code
+.
+ The label will be printed above the paragraph, but only at the top of an
+ environment or the top of a chain of paragraphs with this layout.
+ This might be used with the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\backslash
-documentclass
+Abstract
\end_layout
\end_inset
- command.
+ layout, for example.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+Sensitive
\end_layout
\end_inset
- section must end with
+ 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
+Table
+\begin_inset Quotes erd
+\end_inset
+.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+Sensitive
\end_layout
\end_inset
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
-.
+\begin_layout Plain Layout
+Counter
\end_layout
-\begin_layout Subsection
-Paragraph Styles
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Paragraph-Styles"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-A paragraph style description looks like this:
-\begin_inset Foot
+ label type defines automatically numbered labels.
+ The
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new layout or modify an existing one.
+LabelString
\end_layout
\end_inset
+ will be expanded to resolve any counter references it contains: For example,
+ it might be
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout LyX-Code
-Style
-\family roman
-\emph on
-name
-\end_layout
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
- ...
+\begin_layout Plain Layout
+Section
+\backslash
+thechapter.
+\backslash
+thesection
\end_layout
-\begin_layout LyX-Code
-End
-\end_layout
+\end_inset
-\begin_layout Standard
-where the following commands are allowed:
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+ for more information on counters.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Align
+Enumerate
\end_layout
\end_inset
- [
+ produces the usual sort of enumeration labels.
+ At present, it is hardcoded to use Arabic numerals, lowercase letters,
+ small Roman numerals, and uppercase letters for the four possible depths.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-block
-\emph default
-, left, right, center
+Itemize
\end_layout
\end_inset
-] Paragraph alignment.
+ produces various bullets at the different levels.
+ It is also hardcoded.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-AlignPossible
+Bibliography
\end_layout
\end_inset
- [
+ is used internally by LyX and should be used only with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-block
-\emph default
-, left, right, center
+LatexType BibEnvironment
\end_layout
\end_inset
-] A comma separated list of permitted alignments.
- (Some LaTeX styles prohibit certain alignments, since those wouldn't make
- sense.
- For example a right-aligned or centered enumeration isn't possible.)
+.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BottomSep
+LangPreamble
\end_layout
\end_inset
- [
+ Like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+BabelPreamble
\end_layout
\end_inset
-]
-\begin_inset Foot
+, but this preamble snippet occurs independently from the babel package,
+ and only for the document language.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+EndLangPreamble
\end_layout
\end_inset
- The vertical space with which the last of a chain of paragraphs with this
- layout is separated from the following paragraph.
- If the next paragraph has another layout, the separations are not simply
- added, but the maximum is taken.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Standard
+If the style defines text that appears in the typeset document, it may use
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Category
+LangPreamble
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-[string]
+BabelPreamble
\end_layout
\end_inset
- The category for this style.
- This is used to group related styles in the Layout 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
+ to support non-english and even multilanguage documents correctly.
+ The following excerpt (from the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CommandDepth
+theorems-ams.inc
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
+ file) shows how this works:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+Preamble
+\end_layout
-\begin_layout Plain Layout
-CopyStyle
+\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
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:CopyStyle"
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
-\end_inset
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-[string]
\end_layout
-\end_inset
-
- Copies all the features of an existing style into the current one.
-
+\begin_layout LyX-Code
+EndLangPreamble
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
-\begin_layout Plain Layout
-DependsOn
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
- The name of a style whose preamble should be output
-\emph on
-before
-\emph default
- this one.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another.
-\begin_inset Foot
+\begin_layout Standard
+The key to correct translation of the user visible text is the definition
+ of the command
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note that, besides that functionality, there is no way to ensure any ordering
- of preambles.
- The ordering that you see in a given version of LyX may change without
- warning in later versions.
+
+\backslash
+claimname
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Description
+ in the language preamble.
+ This command holds the name of the theorem that will appear in the output.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+BabelPreamble
\end_layout
\end_inset
- [
+ then uses the commands offered by the babel package to redefine
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\emph on
-No_Label
-\emph default
-, Box, Filled_Box, Static
+\backslash
+claimname
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+ for each used language in multilanguage documents.
+\end_layout
+
+\end_deeper
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexType
+LatexName
\end_layout
\end_inset
- is
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+LatexParam
\end_layout
\end_inset
-,
+ An optional parameter for the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+LatexName
\end_layout
\end_inset
- or
+ stuff.
+ This parameter cannot be changed from within LyX.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+LatexType
\end_layout
\end_inset
-).
+\begin_inset CommandInset label
+LatexCommand label
+name "des:LatexType"
+
+\end_inset
+
+[
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-No_Label
-\end_layout
-
-\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
+\end_layout
-nothing
-\begin_inset Quotes erd
\end_inset
-,
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Box
+List_Environment, Bib_Environment
\end_layout
\end_inset
- (resp.
+] How the layout should be translated into LaTeX.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\begin_inset space ~
+LatexType
+\end_layout
+
\end_inset
-Filled_Box
+ 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
-) is a white (resp.
-\begin_inset space ~
-\end_inset
-black) square suitable for end of proof markers,
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+Paragraph
\end_layout
\end_inset
- is an explicit text string.
+ means nothing special.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+Command
\end_layout
\end_inset
- [
+ means
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
-] The string used for a label with a
+.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+Environment
\end_layout
\end_inset
-
+ means
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Fill_Bottom
+Item_Environment
\end_layout
\end_inset
- [
+ is the same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+Environment
\end_layout
\end_inset
-] Similar to
+, except that an
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Fill_Top
+
+\backslash
+item
\end_layout
\end_inset
-.
+ is generated for each paragraph of this environment.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Fill_Top
+List_Environment
\end_layout
\end_inset
- [
+ is the same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+Item_Environment
\end_layout
\end_inset
-] With this parameter the
-\begin_inset Flex CharStyle:MenuItem
+, except that
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Fill
+LabelWidthString
\end_layout
\end_inset
- value of the
-\begin_inset Quotes eld
-\end_inset
+ is passed as an argument to the environment.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelWidthString
+\end_layout
-Vertical space above
-\begin_inset Quotes erd
\end_inset
- list of the
+ can be defined in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-Settings
+\bar under
+L
+\bar default
+ayout\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+aragraph
\end_layout
\end_inset
- dialog can be set when initializing a paragraph with this style.
-\begin_inset Foot
-status collapsed
+ dialog.
+
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
-\emph on
-Note from Jean-Marc:
-\emph default
- I'm not sure that this setting has much use, and it should probably be
- removed in later versions.
+\begin_layout LyX-Code
+
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
\end_layout
-\end_inset
+\begin_layout Standard
+or:
+\end_layout
+\begin_layout LyX-Code
+
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+\backslash
+end{latexname}.
+\end_layout
+
+\begin_layout Standard
+depending upon the LaTeX type.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Font
+LeftMargin
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
-\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+string=""
+\end_layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\end_inset
+] If you put layouts into environments, the leftmargins are not simply added,
+ but added with a factor
+\begin_inset Formula $\frac{4}{depth+4}$
\end_inset
.
- Note that defining this font automatically defines the
+ Note that this parameter is also used when the margin is defined as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Manual
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Dynamic
\end_layout
\end_inset
.
-\end_layout
+ Then it is added to the manual or dynamic margin.
+
+\begin_inset Newline newline
+\end_inset
+
+The argument is passed as a string.
+ For example
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+MM
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
+\begin_inset Quotes erd
+\end_inset
+
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\end_inset
-[
-\emph on
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+MM
+\end_layout
-\emph on
-0
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the normal font.
+ You can get a negative width by prefixing the string with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-
\end_layout
\end_inset
-\emph default
-,
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Margin
\end_layout
\end_inset
-] Usually LyX doesn't allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example, when typing
- program code or plain LaTeX code.
- For this reason,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
-\end_layout
+]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+The kind of margin that the layout has on the left side.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Static
\end_layout
\end_inset
- Language dependent information to be included in the LaTeX preamble when
- this style is used.
- Note that this will completely override any prior
+ just means a fixed margin.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+Manual
\end_layout
\end_inset
- declarations.
- Must end with
-\begin_inset Quotes eld
+ means that the left margin depends on the string entered in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
+Settings
+\end_layout
+
+\end_inset
+ dialog.
+ This is used to typeset nice lists without tabulators.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+Dynamic
\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
-.
- The contents of this tag will occur once in the LaTeX preamble for each
- language used by the document.
- Each time, the following substitutions are made:
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
-status collapsed
+ must have a wider left margin (as wide as
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-$$lang
-\end_layout
+5.4.3.2.1
+\begin_inset Quotes erd
+\end_inset
+ plus the space) than
+\begin_inset Quotes eld
\end_inset
- is replaced by the language name (as used by the babel package).
-\end_layout
+3.2 Very long headline
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-The
+, even if standard
\begin_inset Quotes eld
\end_inset
-Function
+word processors
\begin_inset Quotes erd
\end_inset
+ are not able to do this.
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-_()
+First_Dynamic
\end_layout
\end_inset
- replaces its argument by the translation of the argument to the current
- language.
+ is similar, but only the very first row of the paragraph is dynamic, while
+ the others are static; this is used, for example, for descriptions.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Right_Address_Box
\end_layout
-\begin_layout Standard
-This preamble snippet will only be used if the document contains more than
- one language and the babel package is used.
+\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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+NeedProtect
\end_layout
\end_inset
- Like
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
-\end_layout
-\end_inset
+\emph on
+0
+\end_layout
-, but this preamble snippet occurs independently from the babel package,
- and only for the document language.
- Must end with
-\begin_inset Quotes eld
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+1
\end_layout
\end_inset
+] Whether fragile commands in this layout should be
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+protect
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether this command should itself be protected.)
\end_layout
-\begin_deeper
-\begin_layout Standard
-If the style defines text that appears in the typeset document, it may use
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Newline
\end_layout
\end_inset
- and
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+0
\end_layout
\end_inset
- to support non-english and even multilanguage documents correctly.
- The following excerpt (from the
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+
+\emph on
+1
\end_layout
\end_inset
- file) shows how this works:
-\end_layout
+] Whether newlines are translated into LaTeX newlines (
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Preamble
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-
\backslash
-theoremstyle{remark}
-\end_layout
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
\backslash
-protect
-\backslash
-claimname}
-\end_layout
-\begin_layout LyX-Code
-EndPreamble
\end_layout
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
+) or not.
+ The translation can be switched off to allow more comfortable LaTeX editing
+ inside LyX.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+NextNoIndent
\end_layout
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
+\begin_layout Plain Layout
+1
\end_layout
-\begin_layout LyX-Code
-EndBabelPreamble
-\end_layout
+\end_inset
-\begin_layout Standard
-The key to correct translation of the user visible text is the definition
- of the command
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\backslash
-claimname
+\emph on
+0
\end_layout
\end_inset
- in the language preamble.
- This command holds the name of the theorem that will appear in the output.
- The
+] Whether the following Paragraph is allowed to indent its very first row.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+1
\end_layout
\end_inset
- then uses the commands offered by the babel package to redefine
+ means that it is not allowed to do so;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+0
\end_layout
\end_inset
- for each used language in multilanguage documents.
+ means it could do so if it wants to.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InnerTag
+ObsoletedBy
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
+ Name of a layout that has replaced this layout.
+ This is used to rename a layout, while keeping backward compatibility.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InTitle
+OptionalArgs
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-[1, 0]
+int=0
\end_layout
\end_inset
- If 1, marks the layout as being part of a title block (see also the
+] The number of optional arguments that can be used with this layout.
+ This is useful for things like section headings, and only makes sense with
+ LaTeX.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+ParIndent
\end_layout
\end_inset
- and
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+string=""
\end_layout
\end_inset
- global entries).
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Parindent
\end_layout
-\begin_layout Description
+\end_inset
+
+ will be fixed for a certain layout.
+ The exception is Standard layout, since the indentation of a Standard layout
+ paragraph can be prohibited with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ItemSep
+NextNoIndent
\end_layout
\end_inset
- [
+.
+ Also, Standard layout paragraphs inside environments use the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+Parindent
\end_layout
\end_inset
-] This provides extra space between paragraphs that have the same layout.
- If you put other layouts into an environment, each is separated with the
- environment's
+ of the environment, not their native one.
+ For example, Standard paragraphs inside an enumeration are not indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+float=0
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
+] The vertical space between two paragraphs of this layout.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemTag
+Parskip
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+float=0
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
+] LyX allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
+indent
+\begin_inset Quotes erd
\end_inset
-[
-\emph on
+ or
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ to typeset a document.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen, this value is completely ignored.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen, the parindent of a LaTeXtype
+\begin_inset Quotes eld
+\end_inset
+
+Paragraph
+\begin_inset Quotes erd
+\end_inset
+ layout is ignored and all paragraphs are separated by this parskip argument.
+ The vertical space is calculated with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+value
+\begin_inset space ~
+\end_inset
-\emph on
-0
+* DefaultHeight
\end_layout
\end_inset
-
-\emph default
-,
+ where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+DefaultHeight
\end_layout
\end_inset
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a layout can be used
- as some kind of break, which does not contain actual text.
+ is the height of a row with the normal font.
+ This way, the look stays the same with different screen fonts.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+PassThru
\end_layout
\end_inset
- [float=0] The vertical space between the label and the text body.
- Only used for labels that are above the text body (
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:PathThru"
+
+\end_inset
+
+[
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+
+\emph on
+0
\end_layout
\end_inset
+
+\emph default
,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+1
\end_layout
\end_inset
-).
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that LaTeX would require.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelCounter
+Preamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-string=""
-\end_layout
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Preamble"
\end_inset
-]
-\begin_inset Newline newline
+Information to be included in the LaTeX preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-The name of the counter for automatic numbering (see Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
- for details).
- This must be given if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Labeltype
+EndPreamble
\end_layout
\end_inset
- is
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Counter
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
status collapsed
\begin_layout Plain Layout
-LabelFont
+Requires
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+[
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelIndent
+string
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
-\end_layout
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Requires"
-\begin_layout Description
+\end_inset
+
+Whether the layout requires the feature
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Labelsep
+string
\end_layout
\end_inset
- [
+.
+ See the description of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+Provides
\end_layout
\end_inset
-] The horizontal space between the label and the text body.
- Only used for labels that are not above the text body.
+ above (page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+
+) for information on `features'.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+RightMargin
\end_layout
\end_inset
\end_inset
-] The string used for a label with a
+] Similar to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+LeftMargin
\end_layout
\end_inset
- labeltype.
- When
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+Spacing
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-@
+
\emph on
-style-name
+single
\emph default
-@
+, onehalf, double, other
\end_layout
\end_inset
- will be replaced by the expanded
+
+\emph on
+value
+\emph default
+] This defines what the default spacing should be in the layout.
+ The arguments
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+single
\end_layout
\end_inset
- of style
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
+onehalf
\end_layout
\end_inset
-.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-.
+\begin_layout Plain Layout
+double
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Description
+ correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ If you specify the argument
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+other
\end_layout
\end_inset
- [
+, then you should also provide a numerical argument which will be the actual
+ multiplier value.
+ Note that, contrary to other parameters,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+Spacing
\end_layout
\end_inset
-] This is used inside the appendix instead of
+ implies the generation of specific LaTeX code, using the package
+\family roman
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+setspace.sty
\end_layout
\end_inset
.
- Note that every
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+TextFont
\end_layout
\end_inset
- statement resets
+ The font used for the text body .
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+TocLevel
\end_layout
\end_inset
- too.
-\end_layout
-\begin_layout Description
+\series medium
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelTag
+
+\series medium
+[int]
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+
+\series default
+ The level of the style in the table of contents.
+ This is used for automatic numbering of section headings.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Labeltype
+TopSep
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+float=0
+\end_layout
-\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment,
-\begin_inset Newline newline
\end_inset
-Centered_Top_Environment, Sensitive, Counter
+] The vertical space with which the very first of a chain of paragraphs
+ with this layout is separated from the previous paragraph.
+ If the previous paragraph has another layout, the separations are not simply
+ added, but the maximum is taken.
\end_layout
-\end_inset
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Floats"
-]
-\begin_inset Newline newline
\end_inset
-\begin_inset Flex CharStyle:Code
+\end_layout
+
+\begin_layout Standard
+Since version 1.3.0 of LyX, it is has been both possible and necessary to
+ define the floats (
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Manual
+figure
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
-\begin_inset Foot
+,
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Use protected spaces if you want more than one word as the label.
+table
\end_layout
\end_inset
-
+, \SpecialChar \ldots{}
+) in the text class itself.
+ Standard floats are included in the file
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+stdfloats.inc
\end_layout
\end_inset
- means it is defined in the layout (see
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdfloats.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file.
+ If you want to implement a text class that proposes some other float types
+ (like the AGU class bundled with LyX), the information below will hopefully
+ help you:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Extension
\end_layout
\end_inset
-).
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+string
\end_layout
\end_inset
- and
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The file name extension of an auxiliary file for the list of figures (or
+ whatever).
+ LaTeX writes the captions to this file.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+GuiName
\end_layout
\end_inset
- are special cases of
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+string
\end_layout
\end_inset
-.
- The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this layout.
- Usage is for example the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Abstract
-\end_layout
+\begin_inset Quotes erd
\end_inset
- layout or the
-\begin_inset Flex CharStyle:MenuItem
+] 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+HTML*
\end_layout
\end_inset
- layout.
- This is also the case for
+ These are used for XHTML output.
+ See
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+LaTeXBuiltin
\end_layout
\end_inset
- labels with latex type
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\emph on
+0
\end_layout
\end_inset
-, in order to make layouts for theorems work correctly.
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+1
\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
+] Set to
+\begin_inset Flex CharStyle:Code
+status collapsed
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+1
+\end_layout
-Table
-\begin_inset Quotes erd
\end_inset
-.
-
+ if the float is already defined by the LaTeX document class.
+ If this is set to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+0
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float.
- The
+, the float will be defined using the LaTeX package
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Counter
+float
\end_layout
-\end_inset
-
- label type defines automatically numbered labels.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
\end_inset
.
status collapsed
\begin_layout Plain Layout
-LatexName
+ListName
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+string
\end_layout
\end_inset
- An optional parameter for the corresponding
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The heading used for the list of floats.
+ This is translated to the document language.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+NumberWithin
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within LyX.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexType
+string
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:LatexType"
+=
+\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 within is equal to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
+chapter
\end_layout
\end_inset
+, the floats will be numbered within chapters.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+Placement
\end_layout
\end_inset
-] How the layout should be translated into LaTeX.
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+string
\end_layout
\end_inset
- means nothing special.
-
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The default placement for the given class of floats.
+ The string should be as in standard LaTeX:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Command
+t
\end_layout
\end_inset
- means
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
+b
\end_layout
\end_inset
- and
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+p
\end_layout
\end_inset
- means
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+h
\end_layout
\end_inset
-.
-
-\begin_inset Flex CharStyle:Code
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Note that the order of these letters in the string is irrelevant, like in
+ LaTeX.
\end_layout
\end_inset
- is the same as
+ On top of that there is a new type,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+H
\end_layout
\end_inset
-, except that a
+, 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+H
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+ specifier is special and, because of implementation details, cannot be
+ used in non-built in float types.
+ If you do not understand what this means, just use
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+tbp
\end_layout
\end_inset
- is the same as
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Style
\end_layout
\end_inset
-, except that
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+string
\end_layout
\end_inset
- is passed as an argument to the environment.
-
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The style used when defining the float using
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+
+\backslash
+newfloat
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex CharStyle:MenuItem
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
+Type
\end_layout
\end_inset
- dialog.
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-LatexType
+string
\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
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
-\end_layout
-\begin_layout LyX-Code
+\begin_inset Quotes erd
+\end_inset
-\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
-\end_layout
+] The
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-or:
-\end_layout
+type
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+ of the new class of floats, like program or algorithm.
+ After the appropriate
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
-
-\backslash
-end{latexname}.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-depending upon the LaTeX type.
+\backslash
+newfloat
\end_layout
-\begin_layout Description
+\end_inset
+
+, commands such as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+
+\backslash
+begin{program}
\end_layout
\end_inset
- [
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\backslash
+end{algorithm*}
\end_layout
\end_inset
-] If you put layouts into environments, the leftmargins are not simply added,
- but added with a factor
-\begin_inset Formula $\frac{4}{depth+4}$
-\end_inset
+ will be available.
+\end_layout
-.
- Note that this parameter is also used when the margin is defined as
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+
+\emph on
+type
\end_layout
\end_inset
- or
+ automatically defines the corresponding counter with name
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+
+\emph on
+type
\end_layout
\end_inset
.
- Then it is added to the manual or dynamic margin.
-
-\begin_inset Newline newline
-\end_inset
-
-The argument is passed as a string.
- For example
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-MM
\end_layout
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Flex-insets-and"
+
\end_inset
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+LyX has supported character styles since version 1.4.0; as of version 1.6.0,
+ these are called Flex insets.
+
+\end_layout
+\begin_layout Standard
+Flex insets come in three different kinds:
+\end_layout
+\begin_layout Itemize
+character style (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-MM
+CharStyle
\end_layout
\end_inset
+): These define semantic markup corresponding to such LaTeX commands as
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
-\end_inset
+\backslash
+noun
+\end_layout
+\end_inset
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
--
-\end_layout
-
-\end_inset
+\backslash
+code
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
- This way was chosen so that the look is the same with each used screen
- font.
-
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+user custom (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Margin
+Custom
\end_layout
\end_inset
- [
+): These can be used to define custom collapsible insets, similar to TeX
+ code, footnote, and the like.
+ An obvious example is an endnote inset, which is defined in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+endnote
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
+ module.
+\end_layout
-The kind of margin that the layout has on the left side.
-
+\begin_layout Itemize
+XML elements (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+Element
\end_layout
\end_inset
- just means a fixed margin.
-
+): For use with DocBook classes.
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+InsetLayout
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex CharStyle:MenuItem
+ tag, which shall be explained in a moment.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+InsetLayout
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-
+ tag also serves another function: It can be used to customize the general
+ layout of many different types of insets.
+ Currently,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+InsetLayout
\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
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
+ boxes, tables, algorithms, URLs, and optional arguments, as well as to
+ define Flex insets.
+\end_layout
-5.4.3.2.1
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
-3.2 Very long headline
-\begin_inset Quotes erd
\end_inset
-, even if standard
-\begin_inset Quotes eld
-\end_inset
+ definition must begin with a line of the form:
+\end_layout
-word processors
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+InsetLayout <Type>
+\end_layout
- are not able to do this.
-
+\begin_layout Standard
+Here
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+<Type>
\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.
-
+ indicates the inset whose layout is being defined, and here there are two
+ cases.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a pre-existing inset is being modified.
+ In this case, can be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+<Type>
\end_layout
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
-\end_layout
-
-\begin_layout Description
+ any one of the following:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Algorithm
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Branch
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Box
\end_layout
\end_inset
-] Whether fragile commands in this layout should be
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+Box:shaded
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether this command should itself be protected.)
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Newline
+ERT
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-0
+Figure
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Foot
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+Index
+\end_layout
-\backslash
+\end_inset
-\backslash
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Info
\end_layout
\end_inset
-) or not.
- The translation can be switched off to allow more comfortable LaTeX editing
- inside LyX.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+Info:menu
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Info:shortcut
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Info:shortcuts
\end_layout
\end_inset
-] Whether the following Paragraph is allowed to indent its very first row.
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Listings
\end_layout
\end_inset
- means that it is not allowed to do so;
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-0
+Marginal
\end_layout
\end_inset
- means it could do so if it wants to.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+Note:Comment
\end_layout
\end_inset
- Name of a layout that has replaced this layout.
- This is used to rename a layout, while keeping backward compatibility.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+Note:Note
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-int=0
+Note:GreyedOut
\end_layout
\end_inset
-] The number of optional arguments that can be used with this layout.
- This is useful for things like section headings, and only makes sense with
- LaTeX.
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+OptArg
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ParIndent
+Table
\end_layout
\end_inset
- [
+, or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+URL
\end_layout
\end_inset
-] The indent of the very first line of a paragraph.
- The
+.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a Flex inset is being defined.
+ In this case,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Parindent
+<Type>
\end_layout
\end_inset
- will be fixed for a certain layout.
- The exception is Standard layout, since the indentation of a Standard layout
- paragraph can be prohibited with
+ can be any valid identifier not used by a pre-existing inset.
+ Note that the definition of a flex inset
+\emph on
+must
+\emph default
+also include a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LyXType
\end_layout
\end_inset
-.
- Also, Standard layout paragraphs inside environments use the
+ entry, declaring which type of inset this is.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Parindent
+InsetLayout
\end_layout
\end_inset
- of the environment, not their native one.
- For example, Standard paragraphs inside an enumeration are not indented.
+ definition can contain the following entries:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Parsep
+BgColor
\end_layout
\end_inset
- [
+ The color for the inset's background.
+ The valid colors are defined in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+src/ColorCode.h
\end_layout
\end_inset
-] The vertical space between two paragraphs of this layout.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Parskip
+ContentAsLabel
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+
+\emph on
+0
\end_layout
\end_inset
-] LyX allows the user to choose either
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-indent
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+1
+\end_layout
- or
-\begin_inset Quotes eld
\end_inset
-skip
-\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.
+\end_layout
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-indent
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+CopyStyle
+\end_layout
- is chosen, this value is completely ignored.
- When
-\begin_inset Quotes eld
\end_inset
-skip
-\begin_inset Quotes erd
-\end_inset
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "des:CopyStyle"
- is chosen, the parindent of a LaTeXtype
-\begin_inset Quotes eld
\end_inset
-Paragraph
-\begin_inset Quotes erd
-\end_inset
+).
+\end_layout
- layout is ignored and all paragraphs are separated by this parskip argument.
- The vertical space is calculated with
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-value
-\begin_inset space ~
+CustomPars
+\end_layout
+
\end_inset
-* DefaultHeight
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
- where
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+1
\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.
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+Decoration
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:PathThru"
-
-\end_inset
-
-[
-\emph on
-
+ can be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Classic
\end_layout
\end_inset
-
-\emph default
,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Minimalistic
\end_layout
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
+, or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Conglomerate
\end_layout
-\begin_layout Description
+\end_inset
+
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Preamble
+Classic
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Preamble"
+, ERT insets generally
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+Minimalistic
+\end_layout
-Information to be included in the LaTeX preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
-\begin_inset Quotes eld
\end_inset
-
+, and character styles
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+Conglomerate
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
status collapsed
\begin_layout Plain Layout
-Requires
+End
\end_layout
\end_inset
-[
+ Required at the end of the InsetLayout declarations.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+Font
\end_layout
\end_inset
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
-Whether the layout requires the feature
+.
+ Note that defining this font automatically defines the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LabelFont
\end_layout
\end_inset
-.
- See the description of
+ to the same value, so define this first and define
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Provides
+LabelFont
\end_layout
\end_inset
- above (page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
-
-\end_inset
-
-) for information on `features'.
-
+ later if you want them to be different.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RightMargin
+ForceLTR
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-string=""
-\end_layout
-
+ Force the
+\begin_inset Quotes eld
\end_inset
-] Similar to
-\begin_inset Flex CharStyle:Code
-status collapsed
+latex
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-LeftMargin
-\end_layout
+ language, leading to Left-to-Right (latin) output, e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-.
+in TeX code or URL.
+ A kludge.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spacing
+ForcePlain
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-single
-\emph default
-, onehalf, double, other
+0
\end_layout
\end_inset
-
-\emph on
-value
-\emph default
-] This defines what the default spacing should be in the layout.
- The arguments
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-single
+1
\end_layout
\end_inset
-,
+] Indicates whether the PlainLayout 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-onehalf
+FreeSpacing
\end_layout
\end_inset
- and
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+
+).
+ Default is false.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-double
+HTML*
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
+ These tags control XHTML output.
+ See
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-other
+InToc
\end_layout
\end_inset
-, then you should also provide a numerical argument which will be the actual
- multiplier value.
- Note that, contrary to other parameters,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Spacing
+
+\emph on
+0
\end_layout
\end_inset
- implies the generation of specific LaTeX code, using the package
-\family roman
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-setspace.sty
+1
\end_layout
\end_inset
-.
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TextFont
+KeepEmpty
\end_layout
\end_inset
- The font used for the text body .
- See section
+ As with paragraph styles (see page
\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+LatexCommand pageref
+reference "des:KeepEmpty"
\end_inset
-.
+).
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-
-\series medium
-TocLevel [int]
+LabelFont
\end_layout
\end_inset
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
-\end_layout
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Description
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that this definition can never appear before
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TopSep
+Font
\end_layout
\end_inset
- [
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+LabelString
\end_layout
\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this layout is separated from the previous paragraph.
- If the previous paragraph has another layout, the separations are not simply
- added, but the maximum is taken.
+ What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (TeX code and Branch) modify this label on the fly.
\end_layout
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Floats"
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+LatexName
+\end_layout
+\end_inset
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is has been both possible and necessary to
- define the floats (
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-figure
+LatexParam
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+ The optional parameter for the corresponding
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-table
+LatexName
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- Standard floats are included in the file
+ stuff, including possible bracket pairs like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-stdfloats.inc
+[]
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
-
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
-
-\begin_layout Standard
-to your layout file.
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with LyX), the information below will hopefully
- help you:
+.
+ This parameter cannot be changed from within LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Extension
+LatexType
\end_layout
\end_inset
- [
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:LatexType"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LyxType
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ Can be
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+charstyle
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- LaTeX writes the captions to this file.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-GuiName
+custom
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+element
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+, or
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+end
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The string that will be used in the menus and also for the caption.
+ (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.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LaTeXBuiltin
+MultiPar
\end_layout
\end_inset
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-] Set to
+] Whether multiple paragraphs are permitted in this inset.
+ This will also set
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+CustomPars
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
- If this is set to
+ to the same value and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-0
+ForcePlain
\end_layout
\end_inset
-, the float will be defined using the LaTeX package
+ to the opposite value.
+ These can be reset to other values, if they are used
+\emph on
+after
+\emph default
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float
+MultiPar
\end_layout
\end_inset
.
+ Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ListName
+NeedProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
\end_inset
+] Whether fragile commands in this layout should be
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+protect
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The heading used for the list of floats.
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.) Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NumberWithin
+PassThru
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
\end_inset
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:PathThru"
-\begin_inset Quotes erd
\end_inset
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if within is equal to
+).
+ Default is false.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chapter
+Preamble
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Preamble"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Placement
+Requires
\end_layout
\end_inset
\end_inset
-=
-\begin_inset Quotes erd
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Requires"
+
\end_inset
+).
+\end_layout
+
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Counters"
-\begin_inset Quotes erd
\end_inset
-] The default placement for the given class of floats.
- The string should be as in standard LaTeX:
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-t
\end_layout
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Since version 1.3.0 of LyX, it is both possible and necessary to define the
+ counters (
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-b
+chapter
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-p
+figure
\end_layout
\end_inset
- and
+, \SpecialChar \ldots{}
+) in the text class itself.
+ The standard counters are defined in the file
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-h
+stdcounters.inc
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
-status collapsed
+, so you may have to do no more than add
+\end_layout
-\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+\begin_layout LyX-Code
+Input stdcounters.inc
\end_layout
-\end_inset
+\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
- On top of that there is a new type,
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
+
+\begin_layout Standard
+where of course `
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-H
+CounterName
\end_layout
\end_inset
-, which does not really correspond to a float, since it means: put it
+' is replaced by the name of the counter.
+ And it must end with
\begin_inset Quotes eld
\end_inset
-here
-\begin_inset Quotes erd
-\end_inset
- and nowhere else.
- Note however that the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-H
+End
\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
+
+\begin_inset Quotes erd
\end_inset
+.
+ The following parameters can also be used:
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tbp
+LabelString [string=""]
\end_layout
\end_inset
+ when this is defined, this string defines how the counter is displayed.
+ Setting this value sets
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+ to the same value.
+ The following special constructs can be used in the string:
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Style
+
+\backslash
+thecounter
\end_layout
\end_inset
- [
+ will be replaced by the expansion of the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LabelString
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ (or
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The style used when defining the float using
+) of the counter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+counter
\end_layout
\end_inset
.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+counter values can be expressed using LaTeX-like macros
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Type
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
- [
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\emph on
+numbertype
+\end_layout
-=
-\begin_inset Quotes erd
\end_inset
+ can be:
+\begin_inset Foot
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-] The
-\begin_inset Quotes eld
-\end_inset
+\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
-type
-\begin_inset Quotes erd
\end_inset
- of the new class of floats, like program or algorithm.
- After the appropriate
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+arabic
\end_layout
\end_inset
-, commands such as
+: 1, 2, 3,\SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+alph
\end_layout
\end_inset
- or
+ for lower-case letters: a, b, c, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{algorithm*}
+Alph
\end_layout
\end_inset
- will be available.
-\end_layout
-
-\begin_layout Standard
-Note that defining a float with type
+ for upper-case letters: A, B, C, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+roman
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+Roman
\end_layout
\end_inset
-.
-\end_layout
+ for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
+;
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Flex-insets-and"
+\begin_layout Plain Layout
+hebrew
+\end_layout
\end_inset
-
+ for hebrew numerals.
\end_layout
+\end_deeper
\begin_layout Standard
-LyX has supported character styles since version 1.4.0; as of version 1.6.0,
- these are called Flex insets.
-
-\end_layout
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-Flex insets come in three different kinds:
+\begin_layout Plain Layout
+master
\end_layout
-\begin_layout Itemize
-character style (
+\end_inset
+
+ (defined via
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+Within
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
+), the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\backslash
-noun
+themaster.
+\backslash
+arabic{counter}
\end_layout
\end_inset
- and
+ is used; otherwise the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\backslash
-code
+arabic{counter}
\end_layout
\end_inset
-.
+ is used.
\end_layout
-\begin_layout Itemize
-user custom (
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Custom
+LabelStringAppendix [string=""]
\end_layout
\end_inset
-): These can be used to define custom collapsible insets, similar to TeX
- code, footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
+ Same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-endnote
+LabelString
\end_layout
\end_inset
- module.
+, but for use in the Appendix.
\end_layout
-\begin_layout Itemize
-XML elements (
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Element
+Within
\end_layout
\end_inset
-): For use with DocBook classes.
-\end_layout
-
-\begin_layout Standard
-Flex insets are defined using the
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+string
\end_layout
\end_inset
- tag, which shall be explained in a moment.
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-The
+
+\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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+subsection
\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,
+ is numbered inside
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+section
\end_layout
\end_inset
- can be used to customize the layout parameters for footnotes, marginal
- notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
- boxes, tables, algorithms, URLs, and optional arguments, as well as to
- define Flex insets.
+.
\end_layout
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Font-description"
\end_inset
- definition must begin with a line of the form:
-\end_layout
-\begin_layout LyX-Code
-InsetLayout <Type>
\end_layout
\begin_layout Standard
-Here
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-<Type>
+A font description looks like this:
\end_layout
-\end_inset
-
- indicates the inset whose layout is being defined, and here there are two
- cases.
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
\end_layout
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+ ...
+\end_layout
-\begin_layout Plain Layout
-<Type>
+\begin_layout LyX-Code
+EndFont
\end_layout
-\end_inset
+\begin_layout Standard
+The following commands are available:
+\end_layout
- any one of the following:
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+Color
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Branch
+
+\emph on
+none
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Box
+black
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Box:shaded
+white
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-ERT
+red
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Figure
+green
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Foot
+blue
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Index
+cyan
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Info
+magenta
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Info:menu
+yellow
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Info:shortcut
+]
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+Family
\end_layout
\end_inset
-,
+ [
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Listings
+
+\emph on
+Roman
\end_layout
\end_inset
+
+\emph default
,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Marginal
+Sans
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Note:Comment
+Typewriter
\end_layout
\end_inset
-,
+]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+Misc
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note:GreyedOut
+string
\end_layout
\end_inset
-,
+] Valid arguments are:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-OptArg
+emph
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Table
+noun
\end_layout
\end_inset
-, or
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-URL
+underbar
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<Type>
+no_emph
\end_layout
\end_inset
- can be any valid identifier not used by a pre-existing inset.
- Note that the definition of a flex inset must
-\emph on
- als
-\emph default
-o include a
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXType
+no_noun
\end_layout
\end_inset
- entry.
-\end_layout
-
-\begin_layout Standard
-The
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+no_bar
\end_layout
\end_inset
- definition can contain the following entries:
-\end_layout
-
-\begin_layout Description
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BgColor
+emph
\end_layout
\end_inset
- The color for the inset's background.
- The valid colors are defined in
+ turns on emphasis, and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-src/ColorCode.h
+no_emph
\end_layout
\end_inset
-.
-\end_layout
+ turns it off.
+
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+no_emph
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
-
-\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
-CustomPars
+Series
\end_layout
\end_inset
[
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\emph on
-0
+Medium
\end_layout
\end_inset
-,
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Bold
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Decoration
+Shape
\end_layout
\end_inset
- can be
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Classic
-\end_layout
-
-\end_inset
+ [
+\emph on
-,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
-\end_layout
-
-\end_inset
-
-, or
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-Conglomerate
+\emph on
+Up
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Classic
+Italic
\end_layout
\end_inset
-, ERT insets generally
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+SmallCaps
\end_layout
\end_inset
-, and character styles
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+Slanted
\end_layout
\end_inset
-.
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-End
+Size
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Font
+tiny
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+small
\end_layout
\end_inset
- to the same value, so define this first and define
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\emph on
+normal
\end_layout
\end_inset
- later if you want them to be different.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+large
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
-\end_inset
-
-latex
-\begin_inset Quotes erd
-\end_inset
-
- language, leading to Left-to-Right (latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-in TeX code or URL.
- A kludge.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+larger
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+largest
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+huge
\end_layout
\end_inset
-] Indicates whether the PlainLayout should be used or, instead, the user
- can change the paragraph style used in the inset.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+giant
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+]
+\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 Description
+\begin_layout Standard
+As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
+ by layout information.
+ In general, LyX provides sensible defaults and, as mentioned earlier, it
+ will even construct default CSS style rules from the other layout tags.
+ For example, LyX will attempt to use the information provided in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InToc
+Font
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
+ declaration for the Chapter style to write CSS that will appropriately
+ format chapter headings.
\end_layout
-\end_inset
+\begin_layout Standard
+In many cases, then, you may not have to do anything at all to get acceptable
+ XHTML output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so LyX provides a number of layout tags
+ that can be used to customize the XHTML and CSS that are generated.
+\end_layout
-,
+\begin_layout Standard
+Note that there are two tags,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+HTMLPreamble
\end_layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
- One would not, for example, want the content of a footnote in a section
- header to be included in the TOC displayed in the outline, but one would
- normally want the content of a character style displayed.
- Default is false: not to include.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+AddToHTMLPreamble
\end_layout
\end_inset
- As with paragraph styles (see page
+ that may appear outside style and inset declarations.
+ See
\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
+LatexCommand prettyref
+reference "sub:General-text-class"
\end_inset
-).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelFont
+ for details on these.
\end_layout
-\end_inset
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Paragraph-Style-XHTML"
- The font used for the label.
- See section
-\begin_inset space ~
\end_inset
+Paragraph styles
+\end_layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
- Note that this definition can never appear before
+\begin_layout Standard
+The sort of XHTML LyX outputs for a paragraph depends upon whether we are
+ dealing with a normal paragraph, a command, or an environment, where this
+ is itself determined by the contents of the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Font
+LaTeXType
\end_layout
\end_inset
-, lest it be ineffective.
+ tag.
+
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelString
+\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
- What will be displayed on the button or elsewhere as the inset label.
- Some inset types (TeX code and Branch) modify this label on the fly.
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-LatexName
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+Contents of the paragraph.
+\end_layout
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
+\begin_layout LyX-Code
+</tag>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+The label tags are of course omitted if the paragraph does not have a label.
+\end_layout
-\begin_layout Plain Layout
-LatexParam
+\begin_layout Standard
+For an environment that is not some sort of list, the XHTML takes this form:
\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
\end_inset
- The optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-LatexName
+>
\end_layout
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
\end_inset
- stuff, including possible bracket pairs like
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-[]
-\end_layout
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+value
+\begin_inset Quotes erd
\end_inset
-.
- This parameter cannot be changed from within LyX.
+>Environment Label</labeltag>First paragraph.</itemtag>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+<itemtag>Second paragraph.</itemtag>
+\end_layout
-\begin_layout Plain Layout
-LatexType
+\begin_layout LyX-Code
+</tag>
\end_layout
-\end_inset
+\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
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
+\begin_layout Standard
+For a list, we have one of these forms:
+\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
\end_inset
-).
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-LyxType
-\end_layout
+value
+\begin_inset Quotes erd
+\end_inset
+><labeltag attr=
+\begin_inset Quotes erd
\end_inset
- Can be
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-charstyle
+>List Label</labeltag>First item.</itemtag>
\end_layout
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-custom
-\end_layout
+value
+\begin_inset Quotes erd
+\end_inset
+><labeltag attr=
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-element
+>List Label</labeltag>Second item.</itemtag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
+</tag>
+\end_layout
-, or
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-end
\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
\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.
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-MultiPar
-\end_layout
+value
+\begin_inset Quotes erd
+\end_inset
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
+value
+\begin_inset Quotes erd
+\end_inset
-\emph on
-0
+>First item.</itemtag>
\end_layout
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-1
-\end_layout
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+value
+\begin_inset Quotes erd
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set CustomPars to the same value and ForcePlain to the opposite
- value.
- These can be reset to other values, if they are used
-\emph on
-after
-\emph default
- MultiPar.
+>Second item.</itemtag>
\end_layout
-\begin_layout Description
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note the different orders of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+labeltag
\end_layout
\end_inset
- [
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+itemtag
\end_layout
\end_inset
-,
+.
+ Which order we get depends upon the setting of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+HTMLLabelFirst
\end_layout
\end_inset
-] Whether fragile commands in this layout should be
+: If
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+HTMLLabelFirst
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether the command should itself be protected.)
+ is false (the default), you get the first of these, with the label within
+ the item; if true, you get the second, with the label outside the item.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each paragraph type can be controlle
+d by means of the layout tags we are about to describe.
+ As mentioned earlier, however, LyX uses sensible defaults for many of these,
+ so you often may not need to do very much to get good XHTML output.
+ Think of the available tags as there so you can tweak things to your liking.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+HTMLAttr
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+class=`mydiv'
\end_layout
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:PathThru"
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
\end_inset
-).
-\end_layout
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Preamble
+class=`layoutname'
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Preamble"
+\begin_inset Quotes erd
\end_inset
-).
-\end_layout
-
-\begin_layout Description
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Requires
+layoutname
\end_layout
\end_inset
- [
+ is the LyX name of the layout, made lowercase, for example: chapter.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-
-\end_inset
-
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Requires"
-
-\end_inset
-
-).
+HTMLForceCSS
\end_layout
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Counters"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is both possible and necessary to define the
- counters (
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chapter
+0,1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+] Whether to output the default CSS information LyX generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-figure
+HTMLStyle
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- The standard counters are defined in the file
+.
+ Setting this to
\begin_inset Flex CharStyle: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 name
+1
\end_layout
-\begin_layout Standard
-where of course `name' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
\end_inset
-
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+0
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
- The following parameters can also be used:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString [string=""]
+HTMLItem
\end_layout
\end_inset
- when this is defined, this string defines how the counter is displayed.
- Setting this value sets
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+string
\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
+] The tag to be used for individual paragraphs of environments, replacing
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+itemtag
\end_layout
\end_inset
- will be replaced by the expansion of the
+ in the examples above.
+ Defaults to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+div
\end_layout
\end_inset
- (or
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+HTMLItemAttr
\end_layout
\end_inset
-) of the counter
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-counter
+string
\end_layout
\end_inset
-.
-
-\end_layout
+] Attributes for the item tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+class=`layoutname_item'
+\end_layout
-\backslash
+\end_inset
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
-\end_layout
+\begin_inset Quotes erd
\end_inset
-, where
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+HTMLLabel
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+ [
+\begin_inset Flex CharStyle: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.
+string
\end_layout
\end_inset
-
+] The tag to be used for paragraph and item labels, replacing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-arabic
+labeltag
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
+ in the examples above.
+ Defaults to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-alph
+span
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-;
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Alph
+HTMLLabelAttr
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-roman
+string
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
+] Attributes for the label tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Roman
+class=`layoutname_label'
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-;
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-hebrew
+HTMLLabelFirst
\end_layout
\end_inset
- for hebrew numerals.
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+0,1
\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
+\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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-master
+<dt>\SpecialChar \ldots{}
+</dt><dd>\SpecialChar \ldots{}
+</dd>
\end_layout
\end_inset
- (defined via
+.
+ Default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Within
+0
\end_layout
\end_inset
-), the string
+: The label tag is output inside the item tag.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
-\backslash
-themaster.
-\backslash
-arabic{counter}
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
\end_layout
\end_inset
- is used; otherwise the string
+ section when this style is used.
+ This might, for example, be used to include a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+<script>
+\end_layout
-\backslash
-arabic{counter}
+\end_inset
+
+ block defining an
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
\end_layout
\end_inset
- is used.
+ handler.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix [string=""]
+HTMLStyle
\end_layout
\end_inset
- Same as
+ 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+<style>
\end_layout
\end_inset
-, but for use in the Appendix.
+ block, so only the CSS itself need be included.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Within
+HTMLTag
\end_layout
\end_inset
\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,
+] The tag to be used for the main label, replacing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-subsection
+tag
\end_layout
\end_inset
- is numbered inside
+ in the examples above.
+ Defaults to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-section
+div
\end_layout
\end_inset
\end_layout
\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Font-description"
+InsetLayout XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output of insets can also be controlled by information in layout
+ files.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+At present, this is true only for
+\begin_inset Quotes eld
+\end_inset
+
+text
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets you can type into) and is not true for
+\begin_inset Quotes eld
+\end_inset
+command
+\begin_inset Quotes erd
\end_inset
+ insets (insets that are associated with dialog boxes).
+\end_layout
+
+\end_inset
+ Here, too, LyX tries to provide sensible defaults, and it constructs default
+ CSS style rules.
+ But everything can be customized.
\end_layout
\begin_layout Standard
-A font description looks like this:
+The XHTML LyX outputs for an inset has the following form:
\end_layout
\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
+<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
-EndFont
+<innertag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Contents of the inset.</innertag>
\end_layout
-\begin_layout Standard
-The following commands are available:
+\begin_layout LyX-Code
+</tag>
\end_layout
-\begin_layout Description
+\begin_layout Standard
+If the inset permits multiple paragraphs---that is, if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Color
+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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
+span
+\end_layout
-\emph on
-none
+\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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-black
+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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-white
+class=`myinset' onclick=`\SpecialChar \ldots{}
+'
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-red
+class=`insetname'
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-green
+insetname
\end_layout
\end_inset
-,
+ is the LyX name of the inset, made lowercase and with non-alphanumeric
+ characters converted to underscores, for example: footnote.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-blue
+HTMLForceCSS
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-cyan
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
-,
+] Whether to output the default CSS information LyX generates for this layout,
+ even if additional information is explicitly provided via
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-magenta
+HTMLStyle
\end_layout
\end_inset
-,
+.
+ Setting this to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-yellow
+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
status collapsed
\begin_layout Plain Layout
-Family
+HTMLInnerAttr
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+string
+\end_layout
-\emph on
-Roman
+\end_inset
+
+] Attributes for the inner tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname_inner'
\end_layout
\end_inset
-\emph default
-,
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sans
+HTMLInnerTag
\end_layout
\end_inset
-,
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The inner tag, replacing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+innertag
\end_layout
\end_inset
-]
+ in the examples above.
+ By default, there is none.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Misc
+HTMLIsBlock
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+0,
+\emph on
+1
\end_layout
\end_inset
-] Valid argument are:
+] 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-emph
+HTMLLabel
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-noun
+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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-underbar
+
+\backslash
+arabic{footnote}
\end_layout
\end_inset
-,
+.
+ This is optional, and there is no default.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-no_emph
+HTMLPreamble
\end_layout
\end_inset
-,
+ Information to be output in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-no_noun
+<head>
\end_layout
\end_inset
- and
+ section when this style is used.
+ This might, for example, be used to include a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-no_bar
+<script>
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
-\end_layout
-
-\begin_layout Description
+ block defining an
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Series
+onclick
\end_layout
\end_inset
- [
-\emph on
+ handler.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Medium
+HTMLStyle
\end_layout
\end_inset
-
-\emph default
-,
+ 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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Bold
+<style>
\end_layout
\end_inset
-]
+ block, so only the CSS itself need be included.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Shape
+HTMLTag
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
+string
\end_layout
\end_inset
-
-\emph default
-,
+] The tag to be used for the main label, replacing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Italic
+tag
\end_layout
\end_inset
-,
+ in the examples above.
+ The default depends upon the setting of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-SmallCaps
+MultiPar
\end_layout
\end_inset
-,
+: If
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Slanted
+MultiPar
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Description
+ is true, the default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Size
+div
\end_layout
\end_inset
- [
+; if it is false, the default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tiny
+span
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+\end_layout
-\begin_layout Plain Layout
-small
+\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
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
+>
+\end_layout
-\emph on
-normal
+\begin_layout LyX-Code
+Contents of the float.
\end_layout
-\end_inset
+\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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-large
+HTMLAttr
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-larger
+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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-largest
+class=`myfloat' onclick=`\SpecialChar \ldots{}
+'
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-huge
+class=`float float-floattype'
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-giant
+floattype
\end_layout
\end_inset
-]
-\end_layout
+ is LyX's name for this type of float, as determined by the float delcaration
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Floats"
-\begin_layout Subsection
-Upgrading old layout files
+\end_inset
+
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
\end_layout
-\begin_layout Standard
-The file format of layout files changes from time to time, so old layout
- files need to be converted.
- This process has been automated since LyX 1.4.0: If LyX reads an old format
- layout file it will call the conversion tool
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/scripts/layout2layout.py
+HTMLStyle
\end_layout
\end_inset
- and convert it to a temporary file in current format.
- The original file is left untouched.
- If you want to convert the layout file permanently, just call the converter
- by hand:
+ 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 CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
\end_layout
-\begin_layout LyX-Code
-python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
+\end_inset
+
+ block, so only the CSS itself need be included.
\end_layout
-\begin_layout Standard
-(You need to replace
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$LyXDir
+HTMLTag
\end_layout
\end_inset
- with the name of your LyX system directory, unless you happen to have defined
- such an environment variable.) Then copy
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myclassnew.layout
+string
\end_layout
\end_inset
- to
+] The tag to be used for this float, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir/layouts/
+tag
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Standard
-The automatic conversion only handles syntax changes.
- It cannot handle the case where the contents of included files was changed,
- so these will have to be converted separately.
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Section
-Creating Templates
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Creating-Templates"
+ in the example above.
+ The default is
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
\end_inset
+ and will rarely need changing.
+\end_layout
+
+\begin_layout Subsection
+LyX-generated CSS
+\end_layout
+\begin_layout Standard
+We have several times mentioned that LyX will generate default CSS style
+ rules for both insets and paragraph styles, based upon the other layout
+ information that is provided.
+ In this section, we shall say a word about which layout information LyX
+ uses and how.
\end_layout
\begin_layout Standard
-Templates are created just like usual documents.
- The only difference is that usual documents contain all possible settings,
- including the font scheme and the paper size.
- Usually a user doesn't want a template to overwrite his defaults in these
- cases.
- For that reason, the designer of a template should remove the corresponding
- commands like
+At present, LyX auto-generates CSS only for font information, making use
+ of the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-fontscheme
+Family
\end_layout
\end_inset
- or
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-papersize
+Series
\end_layout
\end_inset
- from the template LyX file.
- This can be done with any simple text-editor, for example
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-vi
+Shape
\end_layout
\end_inset
- or
+, and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-xedit
+Size
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Standard
-Put the edited template files you create in
+ specified in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir/templates/
+Font
\end_layout
\end_inset
-, copy the ones you use from the global template directory in
+ declaration.
+ (See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.) The translation is mostly straightforward and obvious.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/templates/
+Family Sans
\end_layout
\end_inset
- to the same place, and redefine the template path in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Paths
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ becomes
+\begin_inset Quotes eld
\end_inset
- dialog.
-\end_layout
-\begin_layout Standard
-Note that there is a template which has a particular meaning:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-defaults.lyx
+font-family: sans-serif;
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
- This template is loaded every time you create a new document with
-\begin_inset Flex CharStyle:MenuItem
+ The correspondence of LyX sizes and CSS sizes is a little less obvious
+ but nonetheless intuitive.
+ See the
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
-New
+getSizeCSS()
\end_layout
\end_inset
- in order to provide useful defaults.
- To create this template from inside LyX, all you have to do is to open
- a document with the correct settings, and use the
-\begin_inset Flex CharStyle:MenuItem
+ function in
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-Save as Document Defaults
+
+src/FontInfo.cpp
\end_layout
\end_inset
- button.
+ for the details.
+
\end_layout
\begin_layout Chapter
projects / lyx.git / blobdiff