-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 410
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413
\begin_document
\begin_header
\textclass scrbook
#End
\end_local_layout
\language english
+\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes true
+\tracking_changes false
\output_changes false
\html_math_output 0
+\html_css_as_file 0
\html_be_strict true
\end_header
status collapsed
\begin_layout Plain Layout
-Alt-V D
+Alt-V F D
\end_layout
\end_inset
\begin_layout Plain Layout
View\SpecialChar \menuseparator
+View (Other Formats)\SpecialChar \menuseparator
DVI
\end_layout
\begin_inset CommandInset href
LatexCommand href
name "information on the web"
-target "http://www.lyx.org/devel/cvs.php"
+target "http://www.lyx.org/HowToUseSVN"
\end_inset
\begin_layout Plain Layout
\shape up
-ksmod
+kxmod
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-ksmod
+kxmod
\end_layout
\end_inset
\end_inset
- module—specifcally provide support for one package.
+ module—specifically provide support for one package.
In a sense, layout modules are similar to included
\begin_inset Foot
status collapsed
status collapsed
\begin_layout Plain Layout
-layout/
+layouts/
\end_layout
\end_inset
\begin_layout Standard
There are two situations you are likely to encounter when wanting to support
- a new LaTeX document class, involving LaTeX2e class (
+ a new LaTeX document class, involving style (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.cls
+.sty
\end_layout
\end_inset
-) and style (
+) files and LaTeX2e class (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.sty
+.cls
\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.
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Modules
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-The module declaration should then be followed by lines like the following:
+The module declaration should then be followed by lines like the following
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Preferably in English if the module should be published with LyX.
+ This description will appear in the list of messages to be translated and
+ will be thus translated with the next interface update.
+\end_layout
+
+\end_inset
+
+:
\end_layout
\begin_layout LyX-Code
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Modules
\end_layout
\end_inset
\end_layout
\begin_layout Subsection
-File format
+Format number
\end_layout
\begin_layout Standard
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+NoCounter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] This command deletes an existing counter, usually one defined in an included
+ file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
NoFloat
\end_layout
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new layout or modify an existing one.
+Note that this will either define a new style or modify an existing one.
\end_layout
\end_inset
\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
+ style is separated from the following paragraph.
+ If the next paragraph has another style, the separations are not simply
added, but the maximum is taken.
\end_layout
\end_inset
The category for this style.
- This is used to group related styles in the Layout combobox on the toolbar.
+ This is used to group related styles in the style combobox on the toolbar.
Any string can be used, but you may want to use existing categories with
your own styles.
.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Fill_Bottom
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] Similar to
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Fill_Top
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Fill_Top
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] With this parameter the
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Fill
-\end_layout
-
-\end_inset
-
- value of the
-\begin_inset Quotes eld
-\end_inset
-
-Vertical space above
-\begin_inset Quotes erd
-\end_inset
-
- list of the
-\begin_inset Flex MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-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
-
-\end_inset
-
-
\end_layout
\begin_layout Description
\end_inset
- If 1, marks the layout as to be included in the document preamble rather
+ If 1, marks the style as to be included in the document preamble rather
than in the document body.
This is useful for document classes that want such information as the title
and author to appear in the preamble.
- Note that this works only for layouts for which the
+ Note that this works only for styles for which the
\begin_inset Flex Code
status collapsed
\end_inset
- If 1, marks the layout as being part of a title block (see also the
+ If 1, marks the style as being part of a title block (see also the
\begin_inset Flex Code
status collapsed
\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
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
environment's
\begin_inset Flex Code
status collapsed
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
+ people do not forget them; in some special classes, a style can be used
as some kind of break, which does not contain actual text.
\end_layout
\end_inset
.
- In that case, the counter will be stepped each time the layout appears.
+ In that case, the counter will be stepped each time the style appears.
\begin_inset Newline newline
\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.
+ environment or the top of a chain of paragraphs with this style.
This might be used with the
\begin_inset Flex MenuItem
status collapsed
\end_inset
- layout, for example.
+ style, for example.
\end_layout
\begin_layout Itemize
\end_inset
-] How the layout should be translated into LaTeX.
+] How the style should be translated into LaTeX.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\bar under
-L
+Edit
\bar default
-ayout\SpecialChar \menuseparator
+\SpecialChar \menuseparator
\bar under
P
\bar default
aragraph
+\begin_inset space ~
+\end_inset
+
+settings
\end_layout
\end_inset
\end_inset
-] If you put layouts into environments, the leftmargins are not simply added,
+] If you put styles into environments, the leftmargins are not simply added,
but added with a factor
\begin_inset Formula $\frac{4}{depth+4}$
\end_inset
\begin_inset Newline newline
\end_inset
-The kind of margin that the layout has on the left side.
+The kind of margin that the style has on the left side.
\begin_inset Flex Code
status collapsed
\end_inset
-] Whether fragile commands in this layout should be
+] Whether fragile commands in this style should be
\begin_inset Flex Code
status collapsed
\end_inset
- Name of a layout that has replaced this layout.
- This is used to rename a layout, while keeping backward compatibility.
+ Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
\end_layout
\begin_layout Description
\end_inset
-] The number of optional arguments that can be used with this layout.
+] The number of optional arguments that can be used with this style.
This is useful for things like section headings, and only makes sense with
LaTeX.
Note that, on output, the optional arguments will all precede any required
\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
+ will be fixed for a certain style.
+ The exception is the default style, since the indentation for these paragraphs
+ can be prohibited with
\begin_inset Flex Code
status collapsed
\end_inset
.
- Also, Standard layout paragraphs inside environments use the
+ Also,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\end_inset
+
+ style paragraphs inside environments use the
\begin_inset Flex Code
status collapsed
\end_inset
of the environment, not their native one.
- For example, Standard paragraphs inside an enumeration are not indented.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\end_inset
+
+ paragraphs inside an enumeration are not indented.
\end_layout
\begin_layout Description
\end_inset
-] The vertical space between two paragraphs of this layout.
+] The vertical space between two paragraphs of this style.
\end_layout
\begin_layout Description
\begin_inset Quotes erd
\end_inset
- layout is ignored and all paragraphs are separated by this parskip argument.
+ style is ignored and all paragraphs are separated by this parskip argument.
The vertical space is calculated with
\begin_inset Flex Code
status collapsed
\end_inset
] The number of required arguments that the LaTeX command or environment
- corresponding to this layout expects.
+ corresponding to this style expects.
In the case of a command, these are required arguments
\emph on
other than
\end_inset
-Whether the layout requires the feature
+Whether the style requires the feature
\begin_inset Flex Code
status collapsed
\emph on
value
\emph default
-] This defines what the default spacing should be in the layout.
+] This defines what the default spacing should be in the style.
The arguments
\begin_inset Flex Code
status collapsed
\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
+ with this style is separated from the previous paragraph.
+ If the previous paragraph has another style, the separations are not simply
added, but the maximum is taken.
\end_layout
status collapsed
\begin_layout Plain Layout
-ListCommand
+IsPredefined
\end_layout
\end_inset
[
+\emph on
+
\begin_inset Flex Code
-status collapsed
+status open
\begin_layout Plain Layout
-string
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-] The command used to generate a list of floats of this type; the leading
- `
-\backslash
-' should be omitted.
- This
-\emph on
-must
\emph default
- be given if
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedsFloatPkg
+1
\end_layout
\end_inset
- is false, since there is no standard way to generate this command.
- It is ignored if
+] Indicates whether the float is already defined in the document class or
+ if we instead need to load
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedsFloatPkg
+float.sty
\end_layout
\end_inset
- is true, since in that case there is a standard way.
-\end_layout
-
-\begin_layout Description
+ and use what it provides to define it on-the-fly.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
+0
\end_layout
\end_inset
- [
+, which means: use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+float.sty
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+.
+ It should be set to
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+1
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] A title for a list of floats of this kind (list of figures, tables, or
- whatever).
- It is used for the screen label within LyX; it is passed to LaTeX for use
- as the title there; and it is used as the title in XHTML output.
- It will be translated to the document language.
+ if the float is already defined by the LaTeX document class.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NeedsFloatPkg
+ListCommand
\end_layout
\end_inset
[
\begin_inset Flex Code
-status open
+status collapsed
\begin_layout Plain Layout
-0
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+=
+\begin_inset Quotes erd
+\end_inset
-\emph on
-1
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Indicates whether the float is already defined in the document class or
- if we instead need to load
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' should be omitted.
+ This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+UsesFloatPkg
\end_layout
\end_inset
- and use what it provides.
- The default is
+ is false, since there is no standard way to generate this command.
+ It is ignored if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+UsesFloatPkg
\end_layout
\end_inset
-, which means: use
+ is true, since in that case there is a standard way to define the command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+ListName
\end_layout
\end_inset
-.
- It should be set to
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+string
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within LyX; it is passed to LaTeX for use
+ as the title there; and it is used as the title in XHTML output.
+ It will be translated to the document language.
\end_layout
\begin_layout Description
will be available.
\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UsesFloatPkg
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Tells us whether this float is defined using the facilities provided by
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
+\end_layout
+
+\end_inset
+
+, either by the class file or a package, or on-the-fly by LyX itself.
+\end_layout
+
\begin_layout Standard
Note that defining a float with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:GreyedOut
+Note:Greyedout
\end_layout
\end_inset
\end_inset
- may be be any valid identifier not used by a pre-existing inset.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- It may also include a namespace identifier, preceding a colon, such as
-
+ must be of the form
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-Flex:Code
+Flex:<name>
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+name
+\end_layout
+
+\end_inset
+
+ may be be any valid identifier not used by a pre-existing Flex inset.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
Note that the definition of a flex inset
\emph on
must
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+Display
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Only useful if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Environment
+\end_layout
+
+\end_inset
+
+.
+ Indicates whether the environment will stand on its own in LaTeX output
+ or will appear inline with the surrounding text.
+ If set to false, it is supposed that the LaTeX environment ignores white
+ space (including one newline character) after the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
+
+\end_inset
+
+ tags.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
End
\end_layout
\end_inset
-] Indicates whether the PlainLayout should be used or, instead, the user
- can change the paragraph style used in the inset.
+] Indicates whether the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PlainLayout
+\end_layout
+
+\end_inset
+
+ should be used or, instead, the user can change the paragraph style used
+ in the inset.
Default is false.
\end_layout
\end_inset
These tags control XHTML output.
- See
+ See section
\begin_inset CommandInset ref
-LatexCommand formatted
+LatexCommand ref
reference "sec:Tags-for-XHTML"
\end_inset
\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.
+ Some inset types (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TeX code
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Branch
+\end_layout
+
+\end_inset
+
+) modify this label on the fly.
\end_layout
\begin_layout Description
\end_inset
-] Whether fragile commands in this layout should be
+] Whether fragile commands in this inset should be
\begin_inset Flex Code
status collapsed
\begin_inset Quotes erd
\end_inset
-
+.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-The defines a macro that prints the author, followed by a comma, if the
+This defines a macro that prints the author, followed by a comma, if the
\begin_inset Flex Code
status collapsed
\end_inset
- is LyX's name for this type of float, as determined by the float delcaration
+ is LyX's name for this type of float, as determined by the float declaration
(see
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
The file format of the original file.
- This must be the name of a format that is known to LyX (see section
+ This must be the name of a format that is known to LyX (see section
+\begin_inset space ~
+\end_inset
+
+
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
\end_inset
- section for all formats.
+ section for all templates.
Use a dummy text when no representation is available.
Then you can at least see a reference to the external material in the exported
document.
\bar under
P
\bar default
-references:Conversion
+references\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File Format
\end_layout
\end_inset