#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 372
+\lyxformat 375
\begin_document
\begin_header
\textclass scrbook
\paperpagestyle headings
\tracking_changes false
\output_changes false
+\html_use_mathml true
+\html_be_strict true
\end_header
\begin_body
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:Creating-Templates"
+reference "sub:Creating-Templates"
\end_inset
\end_inset
, is contained in layout files.
+ Similarly, LyX itself does not know much about DocBook or XHTML.
\end_layout
\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 constructs.
+ 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
\end_inset
-.
+ 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
\end_inset
-, which just gets `included' in
+, which is included in
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
tells LyX how paragraphs that are marked with the Section, Subsection,
- etc, styles can be translated into corresponding LaTeX commands.
+ etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
+ commands and tags.
The
\begin_inset Flex CharStyle:Code
status collapsed
\end_layout
\begin_layout Standard
-Defining the LyX--LaTeX correspondence is not, however, the only thing layout
- files do.
+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.
+ 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)
+tell LyX how to translate it into LaTeX and (ii)
\begin_inset space ~
\end_inset
\emph on
is
\emph default
- able, to some extent, anyway, to use information about how it should display
- a paragraph on the screen to output information (in the form of CSS) about
- how the paragrpah should be displayed in a browser.
+ 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.
-\end_layout
-
-\begin_layout Standard
-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_inset Quotes eld
-\end_inset
-
-draw
-\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
-
- which is the internal construct LyX uses to render the screen display.
-
-\begin_inset Quotes eld
-\end_inset
-
-Layout
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
+ See
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sec:Tags-for-XHTML"
-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.
+ for the details.
\end_layout
\begin_layout Section
-Installing a new LaTeX package
+Installing new LaTeX files
\end_layout
\begin_layout Standard
-Some installations may not include a LaTeX package that you would like to
- use within LyX.
+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
\end_layout
\begin_layout Standard
-If your LaTeX distribution doesn't provide such a user interface, or if
- the file is not available through the package browser, then you can follow
- these steps.
+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
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.
+ 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
\end_inset
variable; this is usually somewhere like
-\begin_inset Flex CharStyle:Code
+\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
-Your local and user trees must have the same sort of directory structure
- as your main existing
+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
\end_inset
.
+ If you do not put them here, they probably will not work.
\end_layout
\begin_layout Enumerate
Once your tree is properly set up, you can install the package into an appropria
te location.
- For example, you might install the FoilTeX files into
+ 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
-foiltex
+/home/yourname/texmf/
\end_layout
\end_inset
- directory contains various files.
+ and then, from inside that directory, just run:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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
+
+.
+
\end_layout
\begin_layout Enumerate
) and then restart LyX.
If the new package was a document class, such as FoilTeX again, you will
- now see it—
+ now see it available under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-slides (FoilTeX)
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Document Class
\end_layout
\end_inset
-—available under
+, in this case as
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
-Document Class
+slides (FoilTeX)
\end_layout
\end_inset
.
-
\end_layout
\begin_layout Standard
-Unless, of course, no layout file is available for your new document class.
+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
-
-\begin_layout Plain Layout
-article
-\end_layout
-
-\end_inset
-
- text class as an example.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-*.layout
-\end_layout
-
-\end_inset
-
- files describe what paragraph and character styles are available for a
- given document class, how LyX should display them, and how they should
- be translated into LaTeX, DocBook, or whatever output format is being used.
+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 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 by LaTeX,
- DocBook, and so forth, that we can't hope to cover every different possibility
- or problem you might encounter.
+ 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.
\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 use a nice LaTeX document class that might also be of interest for
- others and so write a corresponding LyX layout, you should consider posting
- your layout to the
+ 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 "section on the LyX wiki"
+name "layout section on the LyX wiki"
target "http://wiki.lyx.org/Layouts/Layouts"
\end_inset
\end_layout
-\begin_layout Standard
-All the tags described here are case-insensitive; this means that
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Style
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-style
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-StYlE
-\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
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-emphasized
-\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
-
-float
-\begin_inset Quotes erd
-\end_inset
-
-, the default is shown like this:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-float=
-\emph on
-default
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
\begin_layout Subsection
Layout modules
\begin_inset CommandInset label
\end_inset
extension and provide LyX with information about document classes.
- As of LyX 1.6, however, layout informtion can also be contained in layout
+ As of LyX 1.6, however, layout information can also be contained in layout
\emph on
modules
extension.
Modules are to LaTeX packages much as layouts are to LaTeX classes, and
- some modules—such as the endnotes module—specifcally provide support for
- one such package.
+ some modules—such as the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+endnotes
+\end_layout
+
+\end_inset
+
+ module—specifcally provide support for one package.
In a sense, layout modules are similar to included
\begin_inset Foot
status collapsed
\end_inset
-, say, requires editing that file.
+ requires editing that file.
Modules, by contrast, are selected in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_layout
\begin_layout Standard
-A module must begin with a line like the following:
-\end_layout
+After creating a new module and copying it to the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-#
-\backslash
-DeclareLyXModule[endnotes.sty]{Endnotes}
+\begin_layout Plain Layout
+layout/
\end_layout
-\begin_layout Standard
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
+\end_inset
+
+ 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
status collapsed
\end_inset
+, highlight something, and then hit
+\begin_inset Quotes eld
+\end_inset
+
+OK
+\begin_inset Quotes erd
+\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
+
+\emph on
+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 actual documents
+\emph default
+.
+ Though of course the developers strive to keep LyX stable in such situations,
+ syntax errors and the like in your module file could cause strange behavior.
+\end_layout
+
+\begin_layout Subsection
+Layout for
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-The list of such packages is documented only in the source code.
+.sty
\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
+ files
\end_layout
-\end_inset
-
-, which declares that the module can only be used when there exists a conversion
- chain between the formats `
+\begin_layout Standard
+There are two situations you are likely to encounter when wanting to support
+ a new LaTeX document class, involving LaTeX2e class (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-from
+.cls
\end_layout
\end_inset
-' and `
+) and style (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-to
+.sty
\end_layout
\end_inset
-'.
+) files.
+ Supporting a style file is usually fairly easy.
+ Supporting a new class file is a bit harder.
+ We'll discuss the former in this section and the latter in the next.
+ Similar remarks apply, of course, if you want to support a new DocBook
+ DTD.
\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.
+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
-\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
+myclass.sty
\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.
- However, changes you make to the module will be seen immediately, if you
- open
+ and that it is meant to be used with
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+report.cls
\end_layout
\end_inset
-, highlight something, and then hit
-\begin_inset Quotes eld
-\end_inset
-
-OK
-\begin_inset Quotes erd
-\end_inset
-
-.
+, which is a standard class.
-\emph on
-It is strongly recommended that you save your work before doing so
-\emph default
-.
- In fact,
-\emph on
-it is strongly recommended that you not attempt to edit modules while simultaneo
-usly working on actual documents
-\emph default
-.
- Though of course the developers strive to keep LyX stable in such situations,
- syntax errors and the like in your module file could cause strange behavior.
-\end_layout
-
-\begin_layout Subsection
-Supporting new document classes
\end_layout
\begin_layout Standard
-There are two situations you are likely to encounter when wanting to support
- a new LaTeX document class, involving LaTeX2e class (
-\begin_inset Flex CharStyle:Code
+Start by copying the existing class's layout file into your local directory:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-.cls
-\end_layout
-
-\end_inset
-
-) and style (
+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
-.sty
-\end_layout
-
-\end_inset
-
-) files.
- Supporting a style file is usually fairly easy.
- Supporting a new document class is a bit harder.
-\end_layout
-
-\begin_layout Subsection
-A layout for a
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-sty
-\end_layout
-
-\end_inset
-
- file
-\end_layout
-
-\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.
- Gor 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
-myclass.sty
+-userdir
\end_layout
\end_inset
- and it is meant to be used with
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-report.cls
+ option.
\end_layout
\end_inset
-, which is a standard class.
-
-\end_layout
-\begin_layout Standard
-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.
- 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"
+ The layout information for sections is contained in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+stdsections.inc
+\end_layout
\end_inset
- for information on how to do so.
+, 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
+Input stdclass.inc
\end_layout
-\begin_layout Standard
-If
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+, which itself includes
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myclass.sty
+stdsections.inc
\end_layout
\end_inset
- can be used with several different document classes, and even if it cannot,
- you might find it easiest just to user a module that you can load with
- the base class.
- The simplest possible such module would be:
+.
+ For example, you might add these lines:
\end_layout
\begin_layout LyX-Code
-#
-\backslash
-DeclareLyXModule{My Class}
+Style Chapter
\end_layout
\begin_layout LyX-Code
-#DescriptionBegin
+ Font
\end_layout
\begin_layout LyX-Code
-#Support for myclass.sty.
+ Family Sans
\end_layout
\begin_layout LyX-Code
-#DescriptionEnd
-\begin_inset Newline newline
-\end_inset
-
-
+ EndFont
\end_layout
\begin_layout LyX-Code
-Format 11
-\begin_inset Newline newline
+End
+\end_layout
+
+\begin_layout Standard
+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 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
+myclass.sty
+\end_layout
+
+\end_inset
+
+ 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
+
+\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
+
+
+\end_layout
+
+\begin_layout LyX-Code
+Format 20
+\begin_inset Newline newline
\end_inset
\backslash
-usepackage{myclass}
+usepackage{mypkg}
\begin_inset Newline newline
\end_inset
\end_layout
\begin_layout Subsection
-Layout for a
+Layout for
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-cls
+.cls
\end_layout
\end_inset
- file
+ files
\end_layout
\begin_layout Standard
\end_inset
-, and it is based upon
+ and it is based upon
\begin_inset Flex CharStyle:Code
status collapsed
Again, the specifics are covered below.
\end_layout
-\begin_layout Section
+\begin_layout Subsection
+Creating templates
\begin_inset CommandInset label
LatexCommand label
-name "sec:TextClass"
+name "sub:Creating-Templates"
\end_inset
-Declaring a new text class
-\end_layout
-\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 too much in one sitting.
- Go have another adult beverage, just for good measure.
\end_layout
\begin_layout Standard
-Here we go!
+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
-Lines in a layout file which begin with
+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
-#
+
+\backslash
+font_roman
\end_layout
\end_inset
- are comments.
- There is one exception to this rule.
- All
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-*.layout
+
+\backslash
+papersize
\end_layout
\end_inset
- files should begin with a line like:
+ 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}
+.
+
\end_layout
\begin_layout Standard
-The second line is used when you configure LyX.
- The layout file is read by the LaTeX script
+Put the edited template files you create in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chkconfig.ltx
+UserDir/templates/
\end_layout
\end_inset
-, in a special mode where
+, copy the ones you use from the global template directory in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-#
+LyXDir/templates/
\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
-\begin_inset Flex CharStyle:Code
+ to the same place, and redefine the template path in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-article.layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
\end_inset
-, then they define a text class of name
+ dialog.
+\end_layout
+
+\begin_layout Standard
+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
-article
+defaults.lyx
\end_layout
\end_inset
- (the name of the layout file) which uses the LaTeX document class
-\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
-article.cls
+File\SpecialChar \menuseparator
+New
\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
+ 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
-Document\SpecialChar \menuseparator
-Settings
+Save as Document Defaults
\end_layout
\end_inset
- dialog.
+ button.
\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
+\begin_layout Subsection
+Upgrading old layout files
\end_layout
-\end_inset
-
- document class, but where you changed the appearance of the section headings.
- If you put it in a file
+\begin_layout Standard
+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
-myarticle.layout
+layout2layout.py
\end_layout
\end_inset
-, the header of this file should be:
+ 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 LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
+mv myclass.layout myclass.old
\end_layout
\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[article]{article (with my own headings)}
+python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
\end_layout
\begin_layout Standard
-This declares a text class
+You need to replace
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myarticle
+LyXDir
\end_layout
\end_inset
-, associated with the LaTeX document class
-\begin_inset Flex CharStyle:Code
-status collapsed
+ with the name of your LyX system directory, of course.
+\end_layout
-\begin_layout Plain Layout
-article.cls
+\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"
- and described as
-\begin_inset Quotes eld
\end_inset
-article (with my own headings)
-\begin_inset Quotes erd
-\end_inset
+The layout file format
+\end_layout
-.
- If your text class depends on several packages, you can declare it as:
+\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 too much in one sitting.
+ Go have another adult beverage, just for good measure.
\end_layout
-\begin_layout LyX-Code
+\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
-\size small
-#% Do not delete the line below; configure depends on this
+\begin_layout Plain Layout
+Style
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\size small
-#
-\backslash
-DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+style
\end_layout
-\begin_layout Standard
-This indicates that your text class uses the
+\end_inset
+
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-foo.sty
+StYlE
\end_layout
\end_inset
- package.
- Finally, it is also possible to declare classes for DocBook code.
- Typical declarations will look like:
+ 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
+
+\emph on
+emphasized
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\size small
-#% Do not delete the line below; configure depends on this
+.
+ 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
+
+float
+\begin_inset Quotes erd
+\end_inset
+
+, the default is shown like this:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+float=
+\emph on
+default
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\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).
+\begin_layout Subsection
+The Document Class Declaration
\end_layout
\begin_layout Standard
-So, to be as explicit as possible, the form of the layout declaration is:
+Lines in a layout file which begin with
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+#
+\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
+*.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[class,package.sty]{layout description}
+DeclareLaTeXClass{article}
\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.
+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
+chkconfig.ltx
\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
+\end_inset
+
+, in a special mode where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/layouts/
+#
\end_layout
\end_inset
- or to
+ 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
-UserDir/layouts
+article.layout
\end_layout
\end_inset
-, run
-\begin_inset Flex CharStyle:MenuItem
+, then they define a text class of name
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+article
\end_layout
\end_inset
-, exit LyX and restart.
- Then your new text class should be available along with the others.
+ (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
-\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.
- In versions of LyX prior to 1.6, this was not true.
- As a result, editing layout files was very time consuming.
- Beginning with 1.6, however, you can force a reload of the layout currently
- in use by using the LyX function
+\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
-layout-reload
+Document\SpecialChar \menuseparator
+Settings
\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 use this function simply by entering it in the mini-buffer.
-
+ dialog.
\end_layout
\begin_layout Standard
-
-\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 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.
- The LyX team strives to keep LyX stable in such situations, but safe is
- better than sorry.
-\begin_inset Foot
+Let's assume that you wrote your own text class that uses the
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-And while we're giving advice, make regular backups.
- And be nice to your mother.
+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
-\begin_layout Subsection
-File format
+\end_inset
+
+, the header of this file should be:
\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:
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\begin_layout Description
+\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
-Format
+myarticle
\end_layout
\end_inset
- [
+, associated with the LaTeX document class
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-int
+article.cls
\end_layout
\end_inset
-] The format of the layout file.
+ 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 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 NNN.
-\begin_inset Note Note
-status open
+This indicates that your text class uses the
+\begin_inset Flex CharStyle:Code
+status collapsed
\begin_layout Plain Layout
-FIXME!
+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: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
-\end_inset
-
- But LyX is capable of reading earlier formats, too, just as it is capable
- of reading files produced by earlier versions of LyX.
-\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Subsection
-General text class parameters
+\begin_layout Plain Layout
+BabelPreamble
\end_layout
-\begin_layout Standard
-These are the general parameters which describe the form of the entire document:
-\end_layout
+\end_inset
-\begin_layout Description
+ 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
-AddToPreamble
+BabelPreamble
\end_layout
\end_inset
- Adds information to the document preamble.
+ declarations.
Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndPreamble
+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
-ClassOptions
+$$lang
\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
+ is replaced by the language name (as used by the babel package).
+\end_layout
- for a description.
- Must end with
+\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_layout Plain Layout
-End
+_()
\end_layout
\end_inset
+ replaces its argument by the translation of the argument to the current
+ language.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-.
+\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
-Columns
+BottomSep
\end_layout
\end_inset
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
+float=0
\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
+]
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+Note that a `float' here is a real number, such as: 1.5.
\end_layout
\end_inset
- dialog.
+ 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
-Counter
+Category
\end_layout
\end_inset
- [
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+[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
-
+ 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
-End
+CommandDepth
\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.
+ Depth of XML command.
+ Used only with XML-type formats.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-DefaultFont
+CopyStyle
\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
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:CopyStyle"
- for how to declare fonts.
- Must end with
-\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndFont
+[string]
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ Copies all the features of an existing style into the current one.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-DefaultModule
+DependsOn
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ The name of a style whose preamble should be output
+\emph on
+before
+\emph default
+ this one.
+ This allows to ensure some ordering of the preamble snippets when macros
+ definitions depend on one another.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-string]
+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
- 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
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+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
-] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex CharStyle:MenuItem
+] 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
-Standard
+LatexType
\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
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ExcludesModule
+Environment
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+Item_Environment
\end_layout
\end_inset
-] This tag indicates that the module in question—which should be specified
- by filename without the
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.module
+List_Environment
\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"
+No_Label
+\end_layout
\end_inset
-).
-\end_layout
+ means
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
+nothing
+\begin_inset Quotes erd
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Float
+Box
\end_layout
\end_inset
- Defines a new float.
- See Section
+ (resp.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\begin_inset space ~
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Floats"
+Filled_Box
+\end_layout
\end_inset
- for details.
- Must end with
-\begin_inset Quotes eld
+) 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_layout Plain Layout
-End
+Static
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ is an explicit text string.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IfCounter
+EndLabelString
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+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
-
-
+] The string used for a label with a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+Static
\end_layout
\end_inset
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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"
+\begin_layout Plain Layout
+EndLabelType
+\end_layout
\end_inset
- for details on counters.
+.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IfStyle
+Fill_Bottom
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\emph on
+0
+\emph default
+,1
+\end_layout
-] 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
-
+] Similar to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+Fill_Top
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
status collapsed
\begin_layout Plain Layout
-Input
+Fill_Top
\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
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
-, which contains most of the basic layouts.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] With this parameter the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-InsetLayout
+Fill
\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
+ value of the
\begin_inset Quotes eld
\end_inset
+Vertical space above
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Flex CharStyle:Code
+ list of the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-End
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\end_layout
\end_inset
+ dialog can be set when initializing a paragraph with this style.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain 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.
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
-\begin_inset Newline newline
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
\end_inset
-See Section
+ 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:Flex-insets-and"
+reference "sub:Font-description"
\end_inset
- for more information.
-
-\end_layout
-
-\begin_layout Description
+.
+ Note that defining this font automatically defines the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+LabelFont
\end_layout
\end_inset
- [
+ 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
-string
+LabelFont
\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
+.
+\end_layout
-MMMMM
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+FreeSpacing
+\end_layout
-.
- (Note that this is not a `length', like
-\begin_inset Quotes eld
\end_inset
-2ex
-\begin_inset Quotes erd
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:FreeSpacing"
+
\end_inset
-.)
-\end_layout
+[
+\emph on
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NoFloat
+
+\emph on
+0
\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
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NoStyle
+1
\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
+] 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
-OutputFormat
+FreeSpacing
\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
+ can be enabled.
+ Note that LyX will create protected blanks for the additional blanks when
+ in another mode than LaTeX-mode.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-OutputType
+HTML*
\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
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:Paragraph-Style-XHTML"
\end_inset
- parameter is encountered.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-OutputType
+InnerTag
\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'.
+ [[FIXME]] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
\begin_inset Flex CharStyle:Code
-status open
+status collapsed
\begin_layout Plain Layout
-PageStyle
+InPreamble
\end_layout
\end_inset
- [
-\emph on
-
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-plain
+[1, 0]
\end_layout
\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
-\emph default
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-empty
+InTitle
\end_layout
\end_inset
-,
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-headings
+[1, 0]
\end_layout
\end_inset
-] The default pagestyle.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
+ 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
-Document\SpecialChar \menuseparator
-Settings
+TitleLatexType
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex CharStyle:Code
-status open
+status collapsed
\begin_layout Plain Layout
-Preamble
+TitleLatexName
\end_layout
\end_inset
- Sets the preamble for the LaTeX document.
- Note that this will completely override any prior
+ global entries).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Preamble
+ItemSep
\end_layout
\end_inset
- or
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+float=0
\end_layout
\end_inset
- declarations.
- (Use
+] 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
-AddToPreamble
+Parsep
\end_layout
\end_inset
- if you just want to add material to the preamble.) Must end with
-\begin_inset Quotes eld
-\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
-EndPreamble
+Itemsep
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
+ Note that this is a
+\emph on
+ multiplier.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Provides
+ItemTag
\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
+KeepEmpty
\end_layout
\end_inset
-] [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:KeepEmpty"
+
+\end_inset
+
+[
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
+
+\emph default
,
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-] Whether the class already provides the feature
+] 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
-.
- A feature is in general the name of a package (
+ [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
-amsmath
+Top_Environment
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-makeidx
+Centered_Top_Environment
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) or a macro (
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-url
+LabelCounter
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-boldsymbol
+string=""
\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 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
-LaTeXFeatures.cpp
+LabelType
\end_layout
\end_inset
- if you're interested.
-
-\begin_inset Flex CharStyle:MenuItem
+ is
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX Configuration
+Counter
\end_layout
\end_inset
- also gives an overview of the supported packages.
-\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
-ProvidesModule
+LabelType
\end_layout
\end_inset
- [
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+Enumerate
\end_layout
\end_inset
-] Indicates that this layout provides the functionality of the module mentioned,
- which should be specified by the filename without the
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.module
+LabelCounter myenum
\end_layout
\end_inset
- extension.
- This will typically be used if the layout includes the module directly,
- rather than using the
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Then the actual counters used are
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DefaultModule
+myenumi
\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
+myenumii
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+myenumiii
\end_layout
\end_inset
-] Whether the class requires the feature
+, and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+myenumiv
\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
+, much as in LaTeX.
+ These counters must all be declared separately.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-LaTeXFeatures.cpp
-\end_layout
+See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
- for a list of these.)
+ for details on counters.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RightMargin
+LabelFont
\end_layout
\end_inset
- A string that indicates the width of the right margin on the screen, for
- example,
-\begin_inset Quotes eld
+ The font used for the label.
+ See section
+\begin_inset space ~
\end_inset
-MMMMM
-\begin_inset Quotes erd
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
\end_inset
.
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
+LabelIndent
\end_layout
\end_inset
- counter in LaTeX.
+ Text that indicates how far a label should be indented.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Sides
+Labelsep
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+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
-\emph default
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-2
+LabelString
\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
+string=""
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Description
+] The string used for a label with a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Style
+Static
\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
-
-
+ labeltype.
+ When
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+LabelCounter
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\begin_inset Newline newline
-\end_inset
-
-See Section
-\begin_inset space ~
-\end_inset
-
-
+ is set, this string can be contain the special formatting commands described
+ in Section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Paragraph-Styles"
+reference "sub:Counters"
\end_inset
- for details on paragraph styles.
-\end_layout
+.
+\begin_inset Foot
+status collapsed
-\begin_layout Description
+\begin_layout Plain Layout
+For the sake of backwards compatibility, the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+@
+\emph on
+style-name
+\emph default
+@
\end_layout
\end_inset
- [
+ will be replaced by the expanded
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+LabelString
\end_layout
\end_inset
-] The name of the command or environment to be used with
+ of style
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+
+\emph on
+style-name
\end_layout
\end_inset
.
-\end_layout
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_inset
-\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
-
-\emph on
-CommandAfter
+LabelStringAppendix
\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.
-
+] This is used inside the appendix instead of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CommandAfter
+LabelString
\end_layout
\end_inset
- means that the macro with name
+.
+ Note that every
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+LabelString
\end_layout
\end_inset
- will be inserted after the last layout which has
-\begin_inset Quotes eld
-\end_inset
-
-
+ statement resets
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InTitle 1
+LabelStringAppendix
\end_layout
\end_inset
+ too.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-.
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelTag
\end_layout
\end_inset
- corresponds to the case where the block of paragraphs which have
-\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
-InTitle 1
+LabelType
\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
+
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
+ Enumerate, Itemize, Bibliography
\end_layout
\end_inset
- environment.
+]
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TocDepth
+Manual
\end_layout
\end_inset
- Sets which divisions are included in the table of contents.
- Corresponds to the
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces (like
+\begin_inset space ~
+\end_inset
+
+that one) if you want more than one word as the label.
+
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tocdepth
+Static
\end_layout
\end_inset
- counter in LaTeX.
-\end_layout
-
-\begin_layout Subsection
+ means the label is simply whatever
\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
-
-
+ declares it to be.
+ Note that this really is `static'.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+Top_Environment
\end_layout
\end_inset
- section can contain the following entries:
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FontSize
+Centered_Top_Environment
\end_layout
\end_inset
- [
+ are special cases of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string="10|11|12"
+Static
\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
+.
+ 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
-|
+Abstract
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ layout, for example.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Header
+Sensitive
\end_layout
\end_inset
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
+ is a special case for the caption-labels
+\begin_inset Quotes eld
\end_inset
-g.: PUBLIC
+Figure
+\begin_inset Quotes erd
+\end_inset
+
+ and
\begin_inset Quotes eld
\end_inset
--//OASIS//DTD DocBook V4.2//EN
+Table
\begin_inset Quotes erd
\end_inset
.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Sensitive
\end_layout
-\begin_layout Description
+\end_inset
+
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
+\end_layout
+
+\begin_layout Itemize
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-PageStyle
+Counter
\end_layout
\end_inset
- [
+ label type defines automatically numbered labels.
+ The
\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
+ will be expanded to resolve any counter references it contains: For example,
+ it might be
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-|
+Section
+\backslash
+thechapter.
+\backslash
+thesection
\end_layout
\end_inset
\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
-Other
+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
-string=""
+Itemize
\end_layout
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
+ produces various bullets at the different levels.
+ It is also hardcoded.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-documentclass
+Bibliography
\end_layout
\end_inset
- command.
-\end_layout
-
-\begin_layout Standard
-The
+ is used internally by LyX and should be used only with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+LatexType BibEnvironment
\end_layout
\end_inset
- section must end with
-\begin_inset Quotes eld
-\end_inset
-
+.
+\end_layout
+\end_deeper
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+LangPreamble
\end_layout
\end_inset
+ Like
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+BabelPreamble
\end_layout
-\begin_layout Subsection
-Paragraph Styles
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Paragraph-Styles"
-
\end_inset
+, 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
-\end_layout
-\begin_layout Standard
-A paragraph style description looks like this:
-\begin_inset Foot
+\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.
+EndLangPreamble
\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_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-End
+.
\end_layout
+\begin_deeper
\begin_layout Standard
-where the following commands are allowed:
-\end_layout
-
-\begin_layout Description
+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
-Align
+LangPreamble
\end_layout
\end_inset
- [
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-block
-\emph default
-, left, right, center
+BabelPreamble
\end_layout
\end_inset
-] Paragraph alignment.
-\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
-AlignPossible
+theorems-ams.inc
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
+ file) shows how this works:
+\end_layout
-\begin_layout Plain Layout
+\begin_layout LyX-Code
+Preamble
+\end_layout
-\emph on
-block
-\emph default
-, left, right, center
+\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
-] 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.)
+\begin_layout LyX-Code
+EndPreamble
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
-\begin_layout Plain Layout
-BabelPreamble
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
\end_layout
-\end_inset
+\begin_layout LyX-Code
- 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
+\end_layout
-\begin_layout Plain Layout
-BabelPreamble
+\begin_layout LyX-Code
+EndLangPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
- declarations.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
+\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
-EndBabelPreamble
-\end_layout
-
-\end_inset
+\backslash
+claimname
+\end_layout
-\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
+ 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
-$$lang
-\end_layout
-
-\end_inset
-
- is replaced by the language name (as used by the babel package).
+BabelPreamble
\end_layout
-\begin_layout Itemize
-The
-\begin_inset Quotes eld
-\end_inset
-
-Function
-\begin_inset Quotes erd
\end_inset
-
+ then uses the commands offered by the babel package to redefine
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-_()
+
+\backslash
+claimname
\end_layout
\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.
+ for each used language in multilanguage documents.
\end_layout
\end_deeper
status collapsed
\begin_layout Plain Layout
-BottomSep
+LatexName
\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
-float=0
+LatexParam
\end_layout
\end_inset
-]
-\begin_inset Foot
+ An optional parameter for the corresponding
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+LatexName
\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.
+ stuff.
+ This parameter cannot be changed from within LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Category
+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
-[string]
+
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
\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
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CommandDepth
+List_Environment, Bib_Environment
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
-\end_layout
+] How the layout should be translated into LaTeX.
+\begin_inset Foot
+status collapsed
-\begin_layout Description
+\begin_layout Plain Layout
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+LatexType
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:CopyStyle"
+ 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
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-[string]
+Paragraph
\end_layout
\end_inset
- Copies all the features of an existing style into the current one.
+ means nothing special.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+Command
\end_layout
\end_inset
- The name of a style whose preamble should be output
-\emph on
-before
-\emph default
- this one.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another.
-\begin_inset Foot
+ means
+\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
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+Environment
\end_layout
\end_inset
- [
+ means
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
+
+\backslash
+end{
\emph on
-No_Label
+LatexName
\emph default
-, Box, Filled_Box, Static
+}
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+.
+
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Item_Environment
\end_layout
\end_inset
- is
+ is the same as
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-,
+, except that an
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+
+\backslash
+item
\end_layout
\end_inset
- or
+ is generated for each paragraph of this environment.
+
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-).
-
+ is the same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-No_Label
+Item_Environment
\end_layout
\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
+, except that
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelWidthString
+\end_layout
-nothing
-\begin_inset Quotes erd
\end_inset
-,
+ is passed as an argument to the environment.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Box
+LabelWidthString
\end_layout
\end_inset
- (resp.
-\begin_inset Flex CharStyle:Code
+ can be defined in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-\begin_inset space ~
-\end_inset
-Filled_Box
+\bar under
+L
+\bar default
+ayout\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+aragraph
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
-\end_inset
+ dialog.
+
+\end_layout
-black) square suitable for end of proof markers,
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
-\begin_layout Plain Layout
-Static
+\begin_layout LyX-Code
+
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
+\end_layout
+
+\begin_layout Standard
+or:
\end_layout
-\end_inset
+\begin_layout LyX-Code
- is an explicit text string.
+\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
-EndLabelString
+LeftMargin
\end_layout
\end_inset
\end_inset
-] The string used for a label with a
+] 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 this parameter is also used when the margin is defined as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+Manual
\end_layout
\end_inset
-
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+Dynamic
\end_layout
\end_inset
.
+ Then it is added to the manual or dynamic margin.
-\end_layout
+\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
-Fill_Bottom
+MM
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+MM
\end_layout
\end_inset
-] Similar to
+
+\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
-Fill_Top
+-
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
+ This way was chosen so that the look is the same with each used screen
+ font.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Fill_Top
+Margin
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-0
+Static
\emph default
-,1
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
-] With this parameter the
-\begin_inset Flex CharStyle:MenuItem
+]
+\begin_inset Newline newline
+\end_inset
+
+The kind of margin that the layout has on the left side.
+
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Fill
+Static
\end_layout
\end_inset
- value of the
-\begin_inset Quotes eld
-\end_inset
+ just means a fixed margin.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Manual
+\end_layout
-Vertical space above
-\begin_inset Quotes erd
\end_inset
- list of the
+ means that the left margin depends on the string entered in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- dialog can be set when initializing a paragraph with this style.
-\begin_inset Foot
+ dialog.
+ This is used to typeset nice lists without tabulators.
+
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain 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.
+Dynamic
\end_layout
\end_inset
-
-\end_layout
+ means that the margin depends on the size of the label.
+ This is used for automatic enumerated headlines.
+ It is obvious that the headline
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+5.4.3.2.1 Very long headline
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Font
-\end_layout
+ must have a wider left margin (as wide as
+\begin_inset Quotes eld
+\end_inset
+5.4.3.2.1
+\begin_inset Quotes erd
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
+ plus the space) than
+\begin_inset Quotes eld
\end_inset
+3.2 Very long headline
+\begin_inset Quotes erd
+\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+, even if standard
+\begin_inset Quotes eld
+\end_inset
+word processors
+\begin_inset Quotes erd
\end_inset
-.
- Note that defining this font automatically defines the
+ are not able to do this.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+First_Dynamic
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ 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
-LabelFont
+Right_Address_Box
\end_layout
\end_inset
-.
+ means the margin is chosen in a way that the longest row of this paragraph
+ fits to the right margin.
+ This is used to typeset an address on the right edge of the page.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+NeedProtect
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
-
-\end_inset
-
-[
-\emph on
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-
-\emph default
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\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
-\end_layout
-
-\end_inset
-
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-InnerTag
-\end_layout
-
-\end_inset
-
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+] Whether fragile commands in this layout should be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InPreamble
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-[1, 0]
+\backslash
+protect
\end_layout
\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.
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether this command should itself be protected.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InTitle
+Newline
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-[1, 0]
+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
-TitleLatexType
+
+\emph on
+1
\end_layout
\end_inset
- and
+] Whether newlines are translated into LaTeX newlines (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+
+\backslash
+
+\backslash
+
\end_layout
\end_inset
- global entries).
+) or not.
+ The translation can be switched off to allow more comfortable LaTeX editing
+ inside LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemSep
+NextNoIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
+1
\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
-Parsep
+
+\emph on
+0
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+] Whether the following Paragraph is allowed to indent its very first row.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+1
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
-\end_layout
-
-\begin_layout Description
+ means that it is not allowed to do so;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ItemTag
+0
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
+ means it could do so if it wants to.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+ObsoletedBy
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
-
-\end_inset
-
-[
-\emph on
+ 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
-
-\emph on
-0
+OptionalArgs
\end_layout
\end_inset
-
-\emph default
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+int=0
\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.
+] 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
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+ParIndent
\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 Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+string=""
\end_layout
\end_inset
-,
+] The indent of the very first line of a paragraph.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+Parindent
\end_layout
\end_inset
-).
-\end_layout
-
-\begin_layout Description
+ 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
-LabelCounter
+NextNoIndent
\end_layout
\end_inset
- [
+.
+ Also, Standard layout paragraphs inside environments use the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+Parindent
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
-
-The name of the counter for automatic numbering.
-
-\begin_inset Newline newline
-\end_inset
+ of the environment, not their native one.
+ For example, Standard paragraphs inside an enumeration are not indented.
+\end_layout
-This
-\emph on
-must
-\emph default
- be given if
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelType
+Parsep
\end_layout
\end_inset
- is
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Counter
+float=0
\end_layout
\end_inset
-.
- In that case, the counter will be stepped each time the layout appears.
-
-\begin_inset Newline newline
-\end_inset
+] The vertical space between two paragraphs of this layout.
+\end_layout
-This
-\emph on
-may
-\emph default
- also be given if
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelType
+Parskip
\end_layout
\end_inset
- is
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+float=0
\end_layout
\end_inset
-, though this case is a bit complicated.
- Suppose you declare
+] LyX allows the user to choose either
\begin_inset Quotes eld
\end_inset
+indent
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelCounter myenum
-\end_layout
+ 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
-.
- Then the actual counters used are
-\begin_inset Flex CharStyle:Code
-status collapsed
+ is chosen, this value is completely ignored.
+ When
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-myenumi
-\end_layout
+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
-myenumii
+value
+\begin_inset space ~
+\end_inset
+
+* DefaultHeight
\end_layout
\end_inset
-,
+ where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myenumiii
+DefaultHeight
\end_layout
\end_inset
-, and
+ is the height of a row with the normal font.
+ This way, the look stays the same with different screen fonts.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myenumiv
+PassThru
\end_layout
\end_inset
-, much as in LaTeX.
- These counters must all be declared separately.
-\begin_inset Newline newline
-\end_inset
-
-See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:PathThru"
\end_inset
- for details on counters.
-\end_layout
+[
+\emph on
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-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"
+\emph on
+0
+\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Description
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelIndent
+1
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
+] 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
-Labelsep
+Preamble
\end_layout
\end_inset
- [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Preamble"
+
+\end_inset
+
+Information to be included in the LaTeX preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+EndPreamble
\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.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+Requires
\end_layout
\end_inset
- [
+[
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+string
\end_layout
\end_inset
-] The string used for a label with a
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Requires"
+
+\end_inset
+
+Whether the layout requires the feature
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+string
\end_layout
\end_inset
- labeltype.
- When
+.
+ See the description of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+Provides
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in Section
+ above (page
\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+LatexCommand pageref
+reference "des:FreeSpacing"
\end_inset
-.
-\begin_inset Foot
-status collapsed
+) for information on `features'.
+
+\end_layout
-\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-@
-\emph on
-style-name
-\emph default
-@
+RightMargin
\end_layout
\end_inset
- will be replaced by the expanded
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+string=""
\end_layout
\end_inset
- of style
+] Similar to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
+LeftMargin
\end_layout
\end_inset
.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
-
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Spacing
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+single
+\emph default
+, onehalf, double, other
\end_layout
\end_inset
-] This is used inside the appendix instead of
+
+\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
-.
- Note that every
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+onehalf
\end_layout
\end_inset
- statement resets
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+double
\end_layout
\end_inset
- too.
-\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
-LabelTag
+other
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+, 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
-LabelType
+Spacing
\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
-
-\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
- Enumerate, Itemize, Bibliography
+setspace.sty
\end_layout
\end_inset
-]
+.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+TextFont
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
- Use protected spaces (like
-\begin_inset space ~
+ The font used for the text body .
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
\end_inset
-that one) if you want more than one word as the label.
-
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+TocLevel
\end_layout
\end_inset
- means the label is simply whatever
+
+\series medium
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\series medium
+[int]
\end_layout
\end_inset
- declares it to be.
- Note that this really is `static'.
+
+\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 Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+TopSep
\end_layout
\end_inset
- and
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+float=0
\end_layout
\end_inset
- are special cases of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Static
+] 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
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Floats"
+
\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.
- This might be used with the
+
+\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
-Abstract
+figure
\end_layout
\end_inset
- layout, for example.
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Sensitive
+table
\end_layout
\end_inset
- is a special case for the caption-labels
-\begin_inset Quotes eld
-\end_inset
-
-Figure
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-Table
-\begin_inset Quotes erd
-\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
-Sensitive
+stdfloats.inc
\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.
+, so you may have to do no more than add
\end_layout
-\begin_layout Itemize
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Counter
+\begin_layout LyX-Code
+Input stdfloats.inc
\end_layout
-\end_inset
+\begin_layout Standard
+to your layout file.
+ If you want to implement a text class that proposes some other float types
+ (like the AGU class bundled with LyX), the information below will hopefully
+ help you:
+\end_layout
- label type defines automatically numbered labels.
- The
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Extension
\end_layout
\end_inset
- will be expanded to resolve any counter references it contains: For example,
- it might be
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Section
-\backslash
-thechapter.
-\backslash
-thesection
+string
\end_layout
\end_inset
-
+=
\begin_inset Quotes erd
\end_inset
-.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\begin_inset Quotes erd
\end_inset
- for more information on counters.
+] 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 Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+GuiName
\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
-Itemize
+string
\end_layout
\end_inset
- produces various bullets at the different levels.
- It is also hardcoded.
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Bibliography
-\end_layout
+\begin_inset Quotes erd
\end_inset
- is used internally by LyX and should be used only with
+] 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
-LatexType BibEnvironment
+HTML*
\end_layout
\end_inset
-.
+ These are used for XHTML output.
+ See
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+LaTeXBuiltin
\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
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-If the style defines text that appears in the typeset document, it may use
-
+] Set to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+1
\end_layout
\end_inset
- and
+ 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
-BabelPreamble
+0
\end_layout
\end_inset
- to support non-english and even multilanguage documents correctly.
- The following excerpt (from the
+, the float will be defined using the LaTeX package
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+float
\end_layout
\end_inset
- file) shows how this works:
-\end_layout
-
-\begin_layout LyX-Code
-Preamble
+.
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
-\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
+\begin_layout Plain Layout
+ListName
\end_layout
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-EndBabelPreamble
+] The heading used for the list of floats.
+ This is translated to the document language.
\end_layout
-\begin_layout Standard
-The key to correct translation of the user visible text is the definition
- of the command
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+NumberWithin
\end_layout
\end_inset
- 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
-BabelPreamble
+string
\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
+=
+\begin_inset Quotes erd
+\end_inset
-\backslash
-claimname
-\end_layout
+\begin_inset Quotes erd
\end_inset
- for each used language in multilanguage documents.
-\end_layout
-
-\end_deeper
-\begin_layout Description
+] 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
-LatexName
+chapter
\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
+, the floats will be numbered within chapters.
+
\end_layout
-\end_inset
-
- An optional parameter for the corresponding
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Placement
\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
-[
+] 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
-
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
+t
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment, Bib_Environment
+b
\end_layout
\end_inset
-] 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
-LatexType
-\end_layout
-
-\end_inset
-
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
+p
\end_layout
\end_inset
-
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+h
\end_layout
\end_inset
- means nothing special.
-
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Command
+Note that the order of these letters in the string is irrelevant, like in
+ LaTeX.
\end_layout
\end_inset
- means
+ On top of that there is a new type,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
+H
\end_layout
\end_inset
-.
-\end_layout
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+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
-Environment
+H
\end_layout
\end_inset
- means
+ 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
+tbp
+\end_layout
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
+\end_inset
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
-
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Style
\end_layout
\end_inset
- is the same as
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+string
\end_layout
\end_inset
-, except that an
+=
+\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
\backslash
-item
+newfloat
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+Type
\end_layout
\end_inset
- is the same as
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+string
\end_layout
\end_inset
-, except that
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-LabelWidthString
-\end_layout
+\begin_inset Quotes erd
\end_inset
- is passed as an argument to the environment.
-
+] The
+\begin_inset Quotes eld
+\end_inset
+
+type
+\begin_inset Quotes erd
+\end_inset
+
+ of the new class of floats, like program or algorithm.
+ After the appropriate
\begin_inset Flex 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
+, commands such as
+\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
+\backslash
+begin{program}
\end_layout
\end_inset
- dialog.
-
-\end_layout
-
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
-\end_layout
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
-\end_layout
-
-\begin_layout Standard
-or:
+end{algorithm*}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
-
-\backslash
-end{latexname}.
+ will be available.
\end_layout
\begin_layout Standard
-depending upon the LaTeX type.
-\end_layout
-
-\end_deeper
-\begin_layout Description
+Note that defining a float with type
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+
+\emph on
+type
\end_layout
\end_inset
- [
+ automatically defines the corresponding counter with name
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+type
\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_layout
+
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Flex-insets-and"
+
\end_inset
-.
- Note that this parameter is also used when the margin is defined as
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-Manual
\end_layout
-\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
- or
+\begin_layout Itemize
+character style (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+CharStyle
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
+): These define semantic markup corresponding to such LaTeX commands as
-\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
+
+\backslash
+noun
\end_layout
\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+
+\backslash
+code
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
\end_inset
+.
+\end_layout
+\begin_layout Itemize
+user custom (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-MM
+Custom
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
-\end_inset
-
-
+): 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
--
+endnote
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- This way was chosen so that the look is the same with each used screen
- font.
-
+ module.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+XML elements (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Margin
+Element
\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
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+InsetLayout
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
+ tag, which shall be explained in a moment.
+\end_layout
-The kind of margin that the layout has on the left side.
-
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+InsetLayout
\end_layout
\end_inset
- just means a fixed margin.
-
+ 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
-Manual
+InsetLayout
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex CharStyle:MenuItem
+ 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
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
+InsetLayout
+\end_layout
+
\end_inset
-Settings
+ definition must begin with a line of the form:
\end_layout
-\end_inset
+\begin_layout LyX-Code
+InsetLayout <Type>
+\end_layout
- dialog.
- This is used to typeset nice lists without tabulators.
-
+\begin_layout Standard
+Here
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+<Type>
\end_layout
\end_inset
- means that the margin depends on the size of the label.
- This is used for automatic enumerated headlines.
- It is obvious that the headline
-\begin_inset Quotes eld
-\end_inset
-
-5.4.3.2.1 Very long headline
-\begin_inset Quotes erd
-\end_inset
-
- must have a wider left margin (as wide as
-\begin_inset Quotes eld
-\end_inset
-
-5.4.3.2.1
-\begin_inset Quotes erd
-\end_inset
-
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
+ indicates the inset whose layout is being defined, and here there are two
+ cases.
+\end_layout
-3.2 Very long headline
-\begin_inset Quotes erd
-\end_inset
+\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
-, even if standard
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+<Type>
+\end_layout
-word processors
-\begin_inset Quotes erd
\end_inset
- are not able to do this.
-
+ any one of the following:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+Algorithm
\end_layout
\end_inset
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+Branch
\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
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Box
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Box:shaded
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+ERT
\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
+Figure
\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
+Foot
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-0
+Index
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Info
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-
+Info:menu
\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:shortcut
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Info:shortcuts
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Listings
\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
+Marginal
\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
+Note:Comment
\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:Note
\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:GreyedOut
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-int=0
+OptArg
\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.
-\end_layout
-
-\begin_layout Description
+,
\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
-\end_layout
-
-\end_inset
-
-] LyX allows the user to choose either
-\begin_inset Quotes eld
-\end_inset
-
-indent
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
-
-indent
-\begin_inset Quotes erd
-\end_inset
-
- is chosen, this value is completely ignored.
- When
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
- is chosen, the parindent of a LaTeXtype
-\begin_inset Quotes eld
-\end_inset
+\emph on
+0
+\end_layout
-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
-
-* DefaultHeight
+1
\end_layout
\end_inset
- where
+] Whether to use the content of the inset as the label, when the inset is
+ closed.
+ Default is false.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+CopyStyle
\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.
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "des:CopyStyle"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+CustomPars
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:PathThru"
-
-\end_inset
-
-[
-\emph on
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-
-\emph default
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
+] 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
-Preamble
+Decoration
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Preamble"
+ can be
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+Classic
+\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
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+Minimalistic
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+, or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Requires
+Conglomerate
\end_layout
\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
-string
+Classic
\end_layout
\end_inset
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
-
-\end_inset
-
-Whether the layout requires the feature
+, ERT insets generally
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+Minimalistic
\end_layout
\end_inset
-.
- See the description of
+, and character styles
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Provides
+Conglomerate
\end_layout
\end_inset
- 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
-RightMargin
+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
-] Similar to
-\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
-LeftMargin
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
.
-\end_layout
-
-\begin_layout Description
+ Note that defining this font automatically defines the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Spacing
+LabelFont
\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
-
-\emph on
-single
-\emph default
-, onehalf, double, other
+LabelFont
\end_layout
\end_inset
-
-\emph on
-value
-\emph default
-] This defines what the default spacing should be in the layout.
- The arguments
+ later if you want them to be different.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-single
+ForceLTR
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+ Force the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-onehalf
-\end_layout
+latex
+\begin_inset Quotes erd
+\end_inset
+ language, leading to Left-to-Right (latin) output, e.
+\begin_inset space \thinspace{}
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Plain Layout
-double
+in TeX code or URL.
+ A kludge.
\end_layout
-\end_inset
-
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-other
+ForcePlain
\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
-.
+] 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
status collapsed
\begin_layout Plain Layout
-TextFont
+FreeSpacing
\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:FreeSpacing"
\end_inset
-.
+).
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-
-\series medium
-TocLevel [int]
+HTML*
\end_layout
\end_inset
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
+ These tags control XHTML output.
+ See
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TopSep
+InToc
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-float=0
-\end_layout
-
-\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this 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.
+\emph on
+0
\end_layout
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Floats"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is has been both possible and necessary to
- define the floats (
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-figure
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-table
+] 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
-\end_inset
-
-, \SpecialChar \ldots{}
-) in the text class itself.
- Standard floats are included in the file
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-stdfloats.inc
+KeepEmpty
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:KeepEmpty"
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
+\end_inset
-\begin_layout Standard
-to your layout file.
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with LyX), the information below will hopefully
- help you:
+).
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Extension
+LabelFont
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
-=
-\begin_inset Quotes erd
\end_inset
+.
+ Note that this definition can never appear before
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\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.
+, lest it be ineffective.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-GuiName
+LabelString
\end_layout
\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.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LatexName
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The string that will be used in the menus and also for the caption.
- This is translated to the current language if babel is used.
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LaTeXBuiltin
+LatexParam
\end_layout
\end_inset
- [
+ The optional parameter for the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LatexName
\end_layout
\end_inset
-,
+ stuff, including possible bracket pairs like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+[]
\end_layout
\end_inset
-] Set to
+.
+ This parameter cannot be changed from within LyX.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+LatexType
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
- If this is set to
+ 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
-0
+LyxType
\end_layout
\end_inset
-, the float will be defined using the LaTeX package
+ Can be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float
+charstyle
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ListName
+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 heading used for the list of floats.
- This is translated to the document language.
+ (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
-NumberWithin
+MultiPar
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+1
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if within is equal to
+] Whether multiple paragraphs are permitted in this inset.
+ This will also set
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chapter
+CustomPars
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
-\end_layout
-
-\begin_layout Description
+ to the same value and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Placement
+ForcePlain
\end_layout
\end_inset
- [
+ to the opposite value.
+ These can be reset to other values, if they are used
+\emph on
+after
+\emph default
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+MultiPar
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
+.
+ Default is true.
+\end_layout
-] The default placement for the given class of floats.
- The string should be as in standard LaTeX:
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-t
+NeedProtect
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-b
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-p
+1
\end_layout
\end_inset
- and
+] Whether fragile commands in this layout should be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-h
+
+\backslash
+protect
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.) Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+PassThru
\end_layout
\end_inset
- On top of that there is a new type,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-H
-\end_layout
-
-\end_inset
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
-\end_inset
+\emph on
+0
+\end_layout
-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
+1
\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
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:PathThru"
+
\end_inset
+).
+ Default is false.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tbp
+Preamble
\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
status collapsed
\begin_layout Plain Layout
-Style
+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 style used when defining the float using
-\begin_inset Flex CharStyle:Code
+
+\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
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+chapter
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Type
+figure
\end_layout
\end_inset
- [
+, \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
-string
+stdcounters.inc
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+, so you may have to do no more than add
+\end_layout
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
+
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
+
+\begin_layout Standard
+where of course `
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+CounterName
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The
+' is replaced by the name of the counter.
+ And it must end with
\begin_inset Quotes eld
\end_inset
-type
-\begin_inset Quotes erd
-\end_inset
- of the new class of floats, like program or algorithm.
- After the appropriate
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+End
\end_layout
\end_inset
-, commands such as
+
+\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
-
-\backslash
-begin{program}
+LabelString [string=""]
\end_layout
\end_inset
- or
+ 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
-
-\backslash
-end{algorithm*}
+LabelStringAppendix
\end_layout
\end_inset
- will be available.
+ to the same value.
+ The following special constructs can be used in the string:
\end_layout
-\begin_layout Standard
-Note that defining a float with type
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\emph on
-type
+\backslash
+thecounter
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ will be replaced by the expansion of the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+LabelString
\end_layout
\end_inset
-.
-\end_layout
+ (or
+\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
+LabelStringAppendix
+\end_layout
\end_inset
+) of the counter
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+counter
\end_layout
-\begin_layout Standard
-LyX has supported character styles since version 1.4.0; as of version 1.6.0,
- these are called Flex insets.
-
-\end_layout
+\end_inset
-\begin_layout Standard
-Flex insets come in three different kinds:
+.
+
\end_layout
\begin_layout Itemize
-character style (
+counter values can be expressed using LaTeX-like macros
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\backslash
-noun
+\emph on
+numbertype
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ can be:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-\backslash
-code
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Actually, the situation is a bit more complicated: any
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\size default
+\emph on
+\noun default
+\color inherit
+numbertype
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ other than those described below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Itemize
-user custom (
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Custom
+arabic
\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
+: 1, 2, 3,\SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-endnote
+alph
\end_layout
\end_inset
- module.
-\end_layout
-
-\begin_layout Itemize
-XML elements (
+ for lower-case letters: a, b, c, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Element
+Alph
\end_layout
\end_inset
-): For use with DocBook classes.
-\end_layout
-
-\begin_layout Standard
-Flex insets are defined using the
+ for upper-case letters: A, B, C, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+roman
\end_layout
\end_inset
- tag, which shall be explained in a moment.
-\end_layout
-
-\begin_layout Standard
-The
+ for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+Roman
\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,
+ for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+hebrew
\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.
+ for hebrew numerals.
\end_layout
+\end_deeper
\begin_layout Standard
-The
+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 Plain Layout
-InsetLayout
+master
\end_layout
\end_inset
- definition must begin with a line of the form:
-\end_layout
-
-\begin_layout LyX-Code
-InsetLayout <Type>
-\end_layout
-
-\begin_layout Standard
-Here
+ (defined via
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<Type>
+Within
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are two
- cases.
-\end_layout
-
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
+), the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<Type>
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
\end_layout
\end_inset
- any one of the following:
+ is used; otherwise the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+
+\backslash
+arabic{counter}
\end_layout
\end_inset
-,
+ is used.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Branch
+LabelStringAppendix [string=""]
\end_layout
\end_inset
-,
+ Same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Box
+LabelString
\end_layout
\end_inset
-,
+, but for use in the Appendix.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+Within
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ERT
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Figure
-\end_layout
+\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
-Foot
+subsection
\end_layout
\end_inset
-,
+ is numbered inside
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Index
+section
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+\end_layout
-\begin_layout Plain Layout
-Info
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Font-description"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A font description looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
\end_layout
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+ ...
+\end_layout
-\begin_layout Plain Layout
-Info:menu
+\begin_layout LyX-Code
+EndFont
\end_layout
-\end_inset
+\begin_layout Standard
+The following commands are available:
+\end_layout
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+Color
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+
+\emph on
+none
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Listings
+black
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Marginal
+white
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Note:Comment
+red
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Note:Note
+green
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Note:GreyedOut
+blue
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-OptArg
+cyan
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Table
+magenta
\end_layout
\end_inset
-, or
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-URL
+yellow
\end_layout
\end_inset
-.
+]
\end_layout
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<Type>
+Family
\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
-\end_layout
-
-\end_inset
-
- entry.
-\end_layout
-\begin_layout Standard
-The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
-\end_layout
-
-\end_inset
-
- definition can contain the following entries:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-BgColor
+\emph on
+Roman
\end_layout
\end_inset
- The color for the inset's background.
- The valid colors are defined in
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-src/ColorCode.h
+Sans
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+Typewriter
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
-
-\end_inset
-
-).
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-CustomPars
+Misc
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
+] Valid arguments are:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+emph
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Decoration
+noun
\end_layout
\end_inset
- can be
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Classic
+underbar
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Minimalistic
+no_emph
\end_layout
\end_inset
-, or
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+no_noun
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Classic
+no_bar
\end_layout
\end_inset
-, ERT insets generally
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+emph
\end_layout
\end_inset
-, and character styles
+ turns on emphasis, and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+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
-End
+no_emph
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
+ 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
-Font
+Series
\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
+
+\emph on
+Medium
\end_layout
\end_inset
- to the same value, so define this first and define
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Bold
\end_layout
\end_inset
- later if you want them to be different.
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ForceLTR
+Shape
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
-\end_inset
+ [
+\emph on
-latex
-\begin_inset Quotes erd
-\end_inset
+\begin_inset Flex CharStyle:Code
+status collapsed
- language, leading to Left-to-Right (latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+
+\emph on
+Up
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-in TeX code or URL.
- A kludge.
-\end_layout
-\begin_layout Description
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+Italic
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+SmallCaps
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Slanted
\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
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+Size
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
-
-\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-).
+\begin_layout Plain Layout
+tiny
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InToc
+small
\end_layout
\end_inset
- [
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\emph on
-0
+normal
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+large
\end_layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
- One would not, for example, want the content of a footnote in a section
- header to be included in the TOC displayed in the outline, but one would
- normally want the content of a character style displayed.
- Default is false: not to include.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+larger
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
-
-\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-).
+\begin_layout Plain Layout
+largest
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+huge
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+giant
+\end_layout
+
\end_inset
+]
+\end_layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-XHTML"
\end_inset
-.
- Note that this definition can never appear before
+Tags for XHTML output
+\end_layout
+
+\begin_layout Standard
+As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
+ by layout information.
+ In general, LyX provides sensible defaults and, as mentioned earlier, it
+ will even construct default CSS style rules from the other layout tags.
+ For example, LyX will attempt to use the information provided in the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-, lest it be ineffective.
+ declaration for the Chapter style to write CSS that will appropriately
+ format chapter headings.
\end_layout
-\begin_layout Description
+\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
-LabelString
+HTMLPreamble
\end_layout
\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.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+AddToHTMLPreamble
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
+ that may appear outside style and inset declarations.
+ See
+\begin_inset CommandInset ref
+LatexCommand prettyref
+reference "sub:General-text-class"
+
+\end_inset
+
+ for details on these.
\end_layout
-\begin_layout Description
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Paragraph-Style-XHTML"
+
+\end_inset
+
+Paragraph styles
+\end_layout
+
+\begin_layout Standard
+The sort of XHTML LyX outputs for a paragraph depends upon whether we are
+ dealing with a normal paragraph, a command, or an environment, where this
+ is itself determined by the contents of the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+LaTeXType
\end_layout
\end_inset
- The optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
-status collapsed
+ tag.
+
+\end_layout
-\begin_layout Plain Layout
-LatexName
+\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
- 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
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
\end_inset
-.
- This parameter cannot be changed from within LyX.
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+Contents of the paragraph.
+\end_layout
-\begin_layout Plain Layout
-LatexType
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The label tags are of course omitted if the paragraph does not have a label.
+\end_layout
+
+\begin_layout Standard
+For an environment that is not some sort of list, the XHTML takes this form:
\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
\end_inset
-).
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Environment Label</labeltag>First paragraph.</itemtag>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+<itemtag>Second paragraph.</itemtag>
+\end_layout
-\begin_layout Plain Layout
-LyxType
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note that the label is output only for the first paragraph, as it should
+ be for a theorem, for example.
+
+\end_layout
+
+\begin_layout Standard
+For a list, we have one of these forms:
\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
\end_inset
- Can be
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-charstyle
+>
\end_layout
+\begin_layout LyX-Code
+<itemtag 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
-custom
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>First item.</itemtag>
\end_layout
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+value
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-element
-\end_layout
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+value
+\begin_inset Quotes erd
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
-status collapsed
+>List Label</labeltag>Second item.</itemtag>
+\end_layout
-\begin_layout Plain Layout
-end
+\begin_layout LyX-Code
+</tag>
\end_layout
-\end_inset
+\begin_layout LyX-Code
- (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
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-MultiPar
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
\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
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+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
+HTMLForceCSS
\end_layout
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Requires"
-
-\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-).
+\begin_layout Plain Layout
+0,1
\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
+] 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
-chapter
+HTMLStyle
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+.
+ Setting this to
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-figure
+1
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- The standard counters are defined in the file
+ 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
-stdcounters.inc
+0
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
-
-\begin_layout LyX-Code
-Input stdcounters.inc
-\end_layout
-
-\begin_layout Standard
-to your layout file to get them to work.
- But if you want to define custom counters, then you can do so.
- The counter declaration must begin with:
-\end_layout
-
-\begin_layout LyX-Code
-Counter CounterName
+.
\end_layout
-\begin_layout Standard
-where of course `
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CounterName
+HTMLItem
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-End
+string
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- The following parameters can also be used:
-\end_layout
-
-\begin_layout Description
+] The tag to be used for individual paragraphs of environments, replacing
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString [string=""]
+itemtag
\end_layout
\end_inset
- when this is defined, this string defines how the counter is displayed.
- Setting this value sets
+ in the examples above.
+ Defaults to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+div
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
+.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+HTMLItemAttr
\end_layout
\end_inset
- will be replaced by the expansion of the
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+string
\end_layout
\end_inset
- (or
+] Attributes for the item tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+class=`layoutname_item'
\end_layout
\end_inset
-) of the counter
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-counter
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
-
\end_layout
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+HTMLLabel
+\end_layout
-\backslash
+\end_inset
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
-, where
+] The tag to be used for paragraph and item labels, replacing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+labeltag
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+ in the examples above.
+ Defaults to
+\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.
+span
\end_layout
\end_inset
-
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-arabic
+HTMLLabelAttr
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-alph
+string
\end_layout
\end_inset
- for lower-case letters: a, b, c, \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
-Alph
+class=`layoutname_label'
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-roman
+HTMLLabelFirst
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Roman
+0,1
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-;
+] 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
-hebrew
+<dt>\SpecialChar \ldots{}
+</dt><dd>\SpecialChar \ldots{}
+</dd>
\end_layout
\end_inset
- for hebrew numerals.
+.
+ Default is
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+0
\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
+
+: 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
-master
+HTMLPreamble
\end_layout
\end_inset
- (defined via
+ Information to be output in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Within
+<head>
\end_layout
\end_inset
-), 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
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
+<script>
\end_layout
\end_inset
- is used; otherwise the string
+ block defining an
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
+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
-Typewriter
+string
\end_layout
\end_inset
-]
+] The inner tag, replacing
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+innertag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ By default, there is none.
\end_layout
\begin_layout Description
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 arguments 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.
- For example,
+ block defining an
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-emph
+onclick
\end_layout
\end_inset
- turns on emphasis, and
+ handler.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-no_emph
+HTMLStyle
\end_layout
\end_inset
- turns it off.
-
-\begin_inset Newline newline
-\end_inset
-
-If the latter seems puzzling, remember that the font settings for the present
- context are generally inherited from the surrounding context.
- So
+ 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
-no_emph
+<style>
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
+ block, so only the CSS itself need be included.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Series
+HTMLTag
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Medium
+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
-Bold
+tag
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Description
+ in the examples above.
+ The default depends upon the setting of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Shape
+MultiPar
\end_layout
\end_inset
- [
-\emph on
-
+: If
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
+MultiPar
\end_layout
\end_inset
-
-\emph default
-,
+ is true, the default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Italic
+div
\end_layout
\end_inset
-,
+; if it is false, the default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-SmallCaps
+span
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+\end_layout
-\begin_layout Plain Layout
-Slanted
+\begin_layout Subsection
+Float XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output for floats too can be controlled by layout information.
+ The output has the following form:
\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
\end_inset
-]
+>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the float.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The caption, if there is one, is a separate inset and will be output as
+ such.
+ Its appearance can be controlled via the InsetLayout for caption insets.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Size
+HTMLAttr
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-tiny
+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
-small
+class=`myfloat' onclick=`\SpecialChar \ldots{}
+'
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-\emph on
-normal
-\end_layout
+\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
-large
+class=`float float-floattype'
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-larger
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-largest
+floattype
\end_layout
\end_inset
-,
+ 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"
+
+\end_inset
+
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-huge
+HTMLStyle
\end_layout
\end_inset
-,
+ CSS style information to be included when this float is used.
+ Note that this will automatically be wrapped in a layout-generated
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-giant
+<style>
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Subsection
-Upgrading old layout files
+ block, so only the CSS itself need be included.
\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
+HTMLTag
\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:
-\end_layout
-
-\begin_layout LyX-Code
-python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
-\end_layout
-
-\begin_layout Standard
-(You need to replace
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$LyXDir
+string
\end_layout
\end_inset
- with the name of your LyX system directory, unless you happen to have defined
- such an environment variable.) Then copy
+] 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
-myclassnew.layout
+tag
\end_layout
\end_inset
- to
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir/layouts/
+div
\end_layout
\end_inset
-.
+ and will rarely need changing.
\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.
+\begin_layout Subsection
+LyX-generated CSS
\end_layout
-\begin_layout Section
-Creating Templates
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Creating-Templates"
-
-\end_inset
-
-
+\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