-#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
\pdfbookmark[1]{\contentsname}{}
\myTOC
\mainmatter }
-
-% redefine the \LyX macro for PDF bookmarks
-\def\LyX{\texorpdfstring{%
- L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
- {LyX}}
-
-% used for multi-column text
-\usepackage{multicol}
\end_preamble
\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\end_modules
\maintain_unincluded_children false
\begin_local_layout
-Format 7
-InsetLayout CharStyle:MenuItem
+Format 35
+InsetLayout Flex:MenuItem
LyxType charstyle
LabelString menu
LatexType command
#End
\end_local_layout
\language english
+\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\tracking_changes true
\output_changes false
\html_math_output 0
+\html_css_as_file 0
\html_be_strict true
+\author -195340706 "Georg Baum"
\end_header
\begin_body
\begin_layout Standard
\begin_inset Branch OutDated
-status open
+status collapsed
\begin_layout Standard
Information from previous versions of this document that now seems to be
\end_inset
this file contains a list of all the languages currently supported by LyX.
+\change_inserted -195340706 1334775793
+
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+
+\change_inserted -195340706 1334775793
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -195340706 1334775793
+layouttranslations
+\end_layout
+
+\end_inset
+
+ this file contains translations for internationalized paragraph styles
+ (see sec.
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+).
+\change_unchanged
+
\end_layout
\begin_layout Section
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
in the appearing context menu.
\end_layout
+\begin_layout Standard
+
+\change_inserted -195340706 1329851811
+The
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+MIME
+\end_layout
+
+\end_inset
+
+ type of a format is optional, but if it is specified, it must be unique
+ across all formats.
+ It is used to detect files of this format from the file contents.
+ For some important file formats there is no MIME type officially registered
+ with the
+\begin_inset CommandInset href
+LatexCommand href
+name "IANA"
+target "http://www.iana.org/assignments/media-types/"
+
+\end_inset
+
+.
+ Therefore LyX uses the extended list of MIME types as specified by
+\begin_inset CommandInset href
+LatexCommand href
+name "freedesktop.org"
+target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Standard
The
\begin_inset Flex MenuItem
\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
syntax errors and the like in your module file could cause strange behavior.
\end_layout
+\begin_layout Subsubsection
+Local Layout
+\end_layout
+
+\begin_layout Standard
+Modules are to LyX as packages are to LaTeX.
+ Sometimes, however, you find yourself wanting a specific inset or character
+ style just for one document and writing a module that will also be available
+ to other documents makes little sense.
+ What you need is LyX's
+\begin_inset Quotes eld
+\end_inset
+
+Local Layout
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+You will find it under
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Local Layout
+\family default
+.
+ The large text box allows you to enter anything that you might enter in
+ a layout file or module.
+ You can think of a document's local layout, in fact, as a module that belongs
+ just to it.
+ So, in particular, you must enter a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
+\end_layout
+
+\end_inset
+
+ tag.
+ Any format is acceptable, but one would normally use the format current
+ at the time.
+ (In LyX 2.0, the current layout format is 35.) You should be aware that local
+ layout is not supported by versions of LyX prior to 1.6, so you should not
+ use it if you want to be able to export your document to LyX 1.5 or earlier
+ (without, that is, losing the local layout information).
+ If you wish to be able to export to 1.6---local layout is supported in 1.6,
+ though there is no UI for it---then you should use format 11 and, of course,
+ use only layout constructs that were available in LyX 1.6.
+\end_layout
+
+\begin_layout Standard
+When you have entered something in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Local Layout
+\end_layout
+
+\end_inset
+
+ pane, LyX will enable the
+\begin_inset Quotes eld
+\end_inset
+
+Validate
+\begin_inset Quotes erd
+\end_inset
+
+ button at the bottom.
+ Clicking this button will cause LyX to determine whether what you have
+ entered is valid layout information for the chosen format.
+ LyX will report the result but, unfortunately, will not tell you what errors
+ there might have been.
+ These will be written to the terminal, however, if LyX is started from
+ a terminal.
+ You will not be permitted to save your local layout until you have entered
+ something valid.
+\end_layout
+
+\begin_layout Standard
+The warnings at the end of the previous section apply here, too.
+ Do not play with local layout while you are actually working, especially
+ if you have not saved your document.
+ That said, using local layout with a test document can be a very convenient
+ way to try out layout ideas, or even to start developing a module.
+\end_layout
+
\begin_layout Subsection
Layout for
\begin_inset Flex MenuItem
\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.
\end_layout
\begin_layout LyX-Code
-#DescriptionEnd
+#DescriptionEnd
\begin_inset Newline newline
\end_inset
\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
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLStyles
+\end_layout
+
+\end_inset
+
+ Adds CSS styling information.
+ This will either be output in a
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ block or, if the user has so chosen, to a separate CSS file.Must end with
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndStyles
+\end_layout
+
+\end_inset
+
+
\begin_inset Quotes erd
\end_inset
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyles
+\end_layout
+
+\end_inset
+
+ Sets CSS styling information.
+ This will either be output in a
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ block or, if the user has so chosen, to a separate CSS file.
+ Note that this will completely override any prior
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyles
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLStyles
+\end_layout
+
+\end_inset
+
+ declarations.
+ (Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLStyles
+\end_layout
+
+\end_inset
+
+ if you just want to add material.) Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndStyles
+\end_layout
+
+\end_inset
+
+
\begin_inset Quotes erd
\end_inset
status collapsed
\begin_layout Plain Layout
-NoFloat
+NoCounter
\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 Code
status collapsed
\begin_layout Plain Layout
-NoStyle
+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
+
+\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 Code
+status collapsed
+
+\begin_layout Plain Layout
+NoStyle
\end_layout
\end_inset
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_inset
-\begin_inset CommandInset label
-LatexCommand label
-name "des:CopyStyle"
-
-\end_inset
-
-
\begin_inset Flex Code
status collapsed
.
-\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
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
-
-\end_inset
-
-[
+ [
\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
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:LatexType"
-
-\end_inset
-
-[
+ [
\begin_inset Flex Code
status collapsed
\end_inset
-] How the layout should be translated into LaTeX.
+] How the style should be translated into LaTeX.
\begin_inset Foot
status collapsed
status collapsed
\begin_layout Plain Layout
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
+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
-] Whether the following Paragraph is allowed to indent its very first row.
-
+] If set to true, and if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+DefaultStyle
\end_layout
\end_inset
- means that it is not allowed to do so;
+ (usually
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Standard
\end_layout
\end_inset
- means it could do so if it wants to.
+) paragraphs are being indented, then the indentation of such a paragraph
+ following one of this type will be suppressed.
+ (So this will not affect the display of non-default paragraphs.)
\end_layout
\begin_layout Description
\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
ParbreakIsNewline
\end_layout
-\end_inset
-
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:ParbreakIsNewline"
-
\end_inset
[
\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
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:PassThru"
-
-\end_inset
-
-[
+ [
\begin_inset Flex Code
status collapsed
\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.
+ 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
\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
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
-
-\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
\begin_layout Standard
One important point to note here is that the translations are provided by
- LyX itself, through the same mechanism it uses for internationalization
- of the user interface.
+ LyX itself, through the
+\change_inserted -195340706 1334775793
+file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -195340706 1334775793
+layouttranslations
+\end_layout
+
+\end_inset
+
+
+\change_deleted -195340706 1334775793
+same mechanism it uses for internationalization of the user interface
+\change_unchanged
+.
This means, in effect, that
\begin_inset Flex Code
status collapsed
are really only of use in layout files that are provided with LyX, since
text entered in user-created layout files will not be seen by LyX's internation
-alization routines.
+alization routines
+\change_inserted -195340706 1334775793
+ unless the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted -195340706 1334775793
+layouttranslations
+\end_layout
+
+\end_inset
+
+ file is modified accordingly
+\change_unchanged
+.
That said, however, any layout created with the intention that it will
be included with LyX should use these tags where appropriate.
+
+\change_inserted -195340706 1334775793
+ Please note that the paragraph style translations provided by LyX will
+ never change with a minor update (e.g.
+ from version 2.1.x to 2.1.y).
+ It is however quite likely that a major update (e.g.
+ from 2.0.x to 2.1.y) will introduce new translations or corrections.
+\change_unchanged
+
\end_layout
\begin_layout Subsection
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
+\emph default
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
-\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
+] 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 false, since there is no standard way to generate this command.
- It is ignored if
+ and use what it provides to define it on-the-fly.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedsFloatPkg
+0
\end_layout
\end_inset
- is true, since in that case there is a standard way.
-\end_layout
-
-\begin_layout Description
+, which means: use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
+float.sty
\end_layout
\end_inset
- [
+.
+ It should be set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+1
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] A title for a list of floats of this kind (list of figures, tables, or
- whatever).
- It is used for the screen label within 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
definition can contain the following entries:
\end_layout
+\begin_layout Description
+
+\change_inserted -195340706 1333913893
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ Preamble for changing languages.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Description
\begin_inset Flex Code
status collapsed
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[string]
+\end_layout
\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
-End
+Display
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\emph on
+1
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
+] 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_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+Environment
+\end_layout
\end_inset
.
- Note that defining this font automatically defines the
+ 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
-LabelFont
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
- to the same value, so define this first and define
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
- later if you want them to be different.
+ tags.
+ Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ForceLTR
+End
\end_layout
\end_inset
- Force the
+ Required at the end of the InsetLayout declarations.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ to the same value, so define this first and define
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ later if you want them to be different.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForceLTR
+\end_layout
+
+\end_inset
+
+ Force the
\begin_inset Quotes eld
\end_inset
\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
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
\end_inset
-).
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
+\begin_inset Flex 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.
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
\begin_inset Flex Code
status collapsed
-\begin_layout Plain Layout
-KeepEmpty
+\begin_layout Plain Layout
+KeepEmpty
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a style can be used
+ as some kind of break, which does not contain actual text.
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex 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"
+
+\end_inset
+
+.
+ Note that this definition can never appear before
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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
+
+\change_inserted -195340706 1333913893
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
+\end_inset
+
+ Language dependent preamble.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexName
+\end_layout
+
+\end_inset
+
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexParam
+\end_layout
+
+\end_inset
+
+ The optional parameter for the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexName
+\end_layout
+
+\end_inset
+
+ stuff, including possible bracket pairs like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[]
+\end_layout
+
+\end_inset
+
+.
+ This parameter cannot be changed from within LyX.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+List_Environment, Bib_Environment
+\end_layout
+
+\end_inset
+
+] How the style should be translated into LaTeX.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Paragraph
+\end_layout
+
+\end_inset
+
+ means nothing special.
+
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Command
+\end_layout
+
+\end_inset
+
+ means
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Environment
+\end_layout
+
+\end_inset
+
+ means
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
-
-\end_inset
-
-).
- Default is false.
+.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Item_Environment
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
-
+ is the same as
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+Environment
+\end_layout
\end_inset
-.
- Note that this definition can never appear before
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+
+\backslash
+item
\end_layout
\end_inset
-, lest it be ineffective.
+ is generated for each paragraph of this environment.
+
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+List_Environment
\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
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Item_Environment
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+, except that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+LabelWidthString
\end_layout
\end_inset
- The optional parameter for the corresponding
+ is passed as an argument to the environment.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+LabelWidthString
\end_layout
\end_inset
- stuff, including possible bracket pairs like
-\begin_inset Flex Code
+ can be defined in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-[]
+
+\bar under
+Edit
+\bar default
+\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+aragraph
+\begin_inset space ~
+\end_inset
+
+settings
\end_layout
\end_inset
-.
- This parameter cannot be changed from within LyX.
+ dialog.
+
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
-\begin_layout Plain Layout
-LatexType
+\begin_layout LyX-Code
+
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
\end_layout
-\end_inset
+\begin_layout Standard
+or:
+\end_layout
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
+\begin_layout LyX-Code
-\end_inset
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+
+\backslash
+end{latexname}.
+\end_layout
-).
+\begin_layout Standard
+depending upon the LaTeX type.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\end_inset
-] Whether fragile commands in this layout should be
+] Whether fragile commands in this inset should be
\begin_inset Flex Code
status collapsed
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:ParbreakIsNewline"
+] Indicates that paragraphs will not be separated by an empty line in LaTeX
+ output, but only by a line break; together with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru 1
+\end_layout
\end_inset
-).
+, this allows to emulate a plain text editor (like the ERT inset).
Default is false.
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:PassThru"
-
-\end_inset
-
-).
- Default is false.
+] 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
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Preamble"
+ Information to be included in the LaTeX preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndPreamble
+\end_layout
\end_inset
-).
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
\end_inset
-] As with paragraph styles (see page
+] Whether the style requires the feature
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+.
+ See the description of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Provides
+\end_layout
+
+\end_inset
+
+ above (page
\begin_inset CommandInset ref
LatexCommand pageref
-reference "des:Requires"
+reference "des:FreeSpacing"
\end_inset
-).
+) for information on `features'.
+
\end_layout
\begin_layout Description
\end_inset
-]
+]
\end_layout
\begin_layout Description
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+strikeout
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
underbar
\end_layout
\begin_inset Flex Code
status collapsed
+\begin_layout Plain Layout
+uuline
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+uwave
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
no_emph
\end_layout
\end_inset
- and
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_strikeout
+\end_layout
+
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uuline
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_uwave
+\end_layout
+
+\end_inset
+
.
Each of these turns on or off the corresponding attribute.
For example,
\begin_inset 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
for the details.
-
\end_layout
\begin_layout Chapter
multiple export formats.
For instance, in the case of a plain text file, it is not exactly an award-winn
ing idea to include the figure as raw PostScript.
- Instead, you'd either prefer to just include a reference to the figure
+ Instead, you would either prefer to just include a reference to the figure
or try to invoke some graphics to ASCII converter to make the final result
look similar to the real graphics.
The external material management allows you to do this, because it is parametri
\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
projects / lyx.git / blobdiff