#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 354
+\lyxformat 369
\begin_document
\begin_header
\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
%
-% This preamble is designed to ensure that the User's Guide prints
+% This preamble is designed to ensure that this document prints
% out as advertised. If you mess with this preamble,
-% parts of the User's Guide may not print out as expected. If you
+% parts of this document may not print out as expected. If you
% have problems LaTeXing this file, please contact
% the documentation team
% email: lyx-docs@lists.lyx.org
\graphics default
\default_output_format default
+\bibtex_command default
+\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
\use_bibtopic false
\use_indices false
\paperorientation portrait
-\backgroundcolor #ffffff
\branch OutDated
\selected 0
+\filename_suffix 0
\color #f5fae7
\end_branch
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
-\defskip medskip
+\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 2
\paperpagestyle headings
\tracking_changes false
\output_changes false
-\author ""
-\author ""
\end_header
\begin_body
\end_inset
menu.
- The editor is for example launched when you press the
+ The editor is for example launched when you right-click on an image and
+ choose
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Edit
+Edit externally
\end_layout
\end_inset
- button in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Graphics
-\end_layout
-
-\end_inset
-
- or the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-External material
-\end_layout
-
-\end_inset
-
- dialog.
+ in the appearing context menu.
\end_layout
\begin_layout Standard
do right away:
\end_layout
-\begin_layout Itemize
-Read
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-DocStyle.lyx
-\end_layout
-
-\end_inset
-
-, the guide to writing LyX documentation.
- Pay special attention to the translator's section.
-\end_layout
-
\begin_layout Itemize
Check out the documentation translation web page at
\begin_inset CommandInset href
\begin_layout Plain Layout
Help\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ntroduction
+Introduction
\end_layout
\end_inset
\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
+
+, which declares that the module can only be used when there exists a conversion
+ chain between formats `from' and `to'.
\end_layout
\begin_layout Standard
\end_inset
- This sequence defines a new counter.
- See Section
-\begin_inset space ~
-\end_inset
-
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\begin_layout Plain Layout
+string
+\end_layout
\end_inset
- for details.
+] This sequence defines the properties for a counter.
+ If the counter does not yet exist, it is created; if it does exist, it
+ is modified.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
+\begin_inset Newline newline
+\end_inset
+
+See 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
\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
+
+.
+\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
\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
- This sequence defines a new paragraph style.
- If the style already exists, it will redefine some of its parameters instead.
- See Section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Paragraph-Styles"
-
-\end_inset
-
- for details.
- Must end with
+ This sequence defines a paragraph style.
+ If the style does not yet exist, it is created; if it does exist, its parameter
+s are redefined Must end with
\begin_inset Quotes eld
\end_inset
\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
status collapsed
\begin_layout Plain Layout
-BottomSep
+BabelPreamble
\end_layout
\end_inset
- [
+ Language dependent information to be included in the LaTeX preamble when
+ this style is used.
+ Note that this will completely override any prior
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+BabelPreamble
\end_layout
\end_inset
-]
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
-\end_layout
-
+ declarations.
+ Must end with
+\begin_inset Quotes eld
\end_inset
- The vertical space with which the last of a chain of paragraphs with this
- layout is separated from the following paragraph.
- If the next paragraph has another layout, the separations are not simply
- added, but the maximum is taken.
-\end_layout
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Category
+EndBabelPreamble
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-[string]
-\end_layout
+\begin_inset Quotes erd
\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.
-
+.
+ 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
-CommandDepth
+$$lang
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
+ is replaced by the language name (as used by the babel package).
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\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_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.
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+BottomSep
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
+
+\end_inset
+
+]
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that a `float' here is a real number, such as: 1.5.
+\end_layout
+
+\end_inset
+
+ The vertical space with which the last of a chain of paragraphs with this
+ layout is separated from the following paragraph.
+ If the next paragraph has another layout, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Category
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+[string]
+\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
+\end_layout
+
+\end_inset
+
+ Depth of XML command.
+ Used only with XML-type formats.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+InnerTag
\end_layout
\end_inset
- Language dependent information to be included in the LaTeX preamble when
- this style is used.
- Note that this will completely override any prior
+ [[FIXME]] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+InTitle
\end_layout
\end_inset
- declarations.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+[1, 0]
+\end_layout
+\end_inset
+ If 1, marks the layout as being part of a title block (see also the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+TitleLatexType
\end_layout
\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TitleLatexName
+\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:
+ global entries).
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$lang
+ItemSep
\end_layout
\end_inset
- is replaced by the language name (as used by the babel package).
-\end_layout
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Itemize
-The
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+float=0
+\end_layout
-Function
-\begin_inset Quotes erd
\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
\end_layout
\end_inset
- replaces its argument by the translation of the argument to the current
- language.
+.
+ But the whole items of the environment are additionally separated with
+ this
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Itemsep
\end_layout
-\begin_layout Standard
-This preamble snippet will only be used if the document contains more than
- one language and the babel package is used.
+\end_inset
+
+.
+ Note that this is a
+\emph on
+ multiplier.
\end_layout
-\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+ItemTag
\end_layout
\end_inset
- Like
+ [[FIXME]] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+KeepEmpty
\end_layout
\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
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:KeepEmpty"
+
\end_inset
+[
+\emph on
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+
+\emph on
+0
\end_layout
\end_inset
-\begin_inset Quotes erd
+\emph default
+,
+\begin_inset Flex CharStyle: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 layout can be used
+ as some kind of break, which does not contain actual text.
\end_layout
-\begin_deeper
-\begin_layout Standard
-If the style defines text that appears in the typeset document, it may use
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+LabelBottomsep
\end_layout
\end_inset
- and
+ [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
-BabelPreamble
+Top_Environment
\end_layout
\end_inset
- to support non-english and even multilanguage documents correctly.
- The following excerpt (from the
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+Centered_Top_Environment
\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
+LabelCounter
\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_inset
-\end_layout
+]
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+The name of the counter for automatic numbering.
+
+\begin_inset Newline newline
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+This
+\emph on
+must
+\emph default
+ be given if
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
+\begin_layout Plain Layout
+LabelType
\end_layout
-\begin_layout LyX-Code
-EndBabelPreamble
-\end_layout
+\end_inset
-\begin_layout Standard
-The key to correct translation of the user visible text is the definition
- of the command
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+Counter
\end_layout
\end_inset
- in the language preamble.
- This command holds the name of the theorem that will appear in the output.
- The
+.
+ In that case, the counter will be stepped each time the layout appears.
+
+\begin_inset Newline newline
+\end_inset
+
+This
+\emph on
+may
+\emph default
+ also be given if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+LabelType
\end_layout
\end_inset
- then uses the commands offered by the babel package to redefine
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+Enumerate
\end_layout
\end_inset
- for each used language in multilanguage documents.
-\end_layout
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
-\end_deeper
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InnerTag
+LabelCounter myenum
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Then the actual counters used are
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InTitle
+myenumi
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-[1, 0]
+myenumii
\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
+myenumiii
\end_layout
\end_inset
- and
+, and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+myenumiv
\end_layout
\end_inset
- global entries).
+, 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"
+
+\end_inset
+
+ for details on counters.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemSep
+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
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+LabelIndent
\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
+ Text that indicates how far a label should be indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Parsep
+Labelsep
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+string=""
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
+] The horizontal space between the label and the text body.
+ Only used for labels that are not above the text body.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ItemTag
+LabelString
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+string=""
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
-
-\end_inset
-
-[
-\emph on
-
+] The string used for a label with a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Static
\end_layout
\end_inset
-
-\emph default
-,
+ labeltype.
+ When
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+LabelCounter
\end_layout
\end_inset
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a layout can be used
- as some kind of break, which does not contain actual text.
-\end_layout
+ is set, this string can be contain the special formatting commands described
+ in Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-\begin_layout Description
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For the sake of backwards compatibility, the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+@
+\emph on
+style-name
+\emph default
+@
\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 (
+ will be replaced by the expanded
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+LabelString
\end_layout
\end_inset
-,
+ of style
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+
+\emph on
+style-name
\end_layout
\end_inset
-).
+.
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelCounter
+LabelStringAppendix
\end_layout
\end_inset
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
-
-The name of the counter for automatic numbering (see Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
-
- for details).
- This must be given if
+] This is used inside the appendix instead of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Labeltype
+LabelString
\end_layout
\end_inset
- is
+.
+ Note that every
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Counter
+LabelString
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ statement resets
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+LabelStringAppendix
\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
-
-.
+ too.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelIndent
+LabelTag
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
+ [FIXME] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Labelsep
+LabelType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
+ Enumerate, Itemize, Bibliography
\end_layout
\end_inset
-] The horizontal space between the label and the text body.
- Only used for labels that are not above the text body.
+]
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Manual
\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 ~
+\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
-string=""
+Static
\end_layout
\end_inset
-] The string used for a label with a
+ means the label is simply whatever
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+LabelString
\end_layout
\end_inset
- labeltype.
- When
+ declares it to be.
+ Note that this really is `static'.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+Top_Environment
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
-\end_inset
-
-.
-\begin_inset Foot
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+Centered_Top_Environment
+\end_layout
+
+\end_inset
+
+ are special cases of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-@
-\emph on
-style-name
-\emph default
-@
+Static
\end_layout
\end_inset
- will be replaced by the expanded
-\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
-LabelString
+Abstract
\end_layout
\end_inset
- of style
+ layout, for example.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
+Sensitive
\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"
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
+Figure
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+Table
+\begin_inset Quotes erd
\end_inset
.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Sensitive
\end_layout
\end_inset
-
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Counter
\end_layout
\end_inset
- [
+ label type defines automatically numbered labels.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+LabelString
\end_layout
\end_inset
-] This is used inside the appendix instead of
+ 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
-LabelString
+Section
+\backslash
+thechapter.
+\backslash
+thesection
\end_layout
\end_inset
-.
- Note that every
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelString
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+ for more information on counters.
\end_layout
-\end_inset
-
- statement resets
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Enumerate
\end_layout
\end_inset
- too.
+ produces the usual sort of enumeration labels.
+ At present, it is hardcoded to use Arabic numerals, lowercase letters,
+ small Roman numerals, and uppercase letters for the four possible depths.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelTag
+Itemize
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+ produces various bullets at the different levels.
+ It is also hardcoded.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Labeltype
+Bibliography
\end_layout
\end_inset
- [
+ is used internally by LyX and should be used only with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment,
-\begin_inset Newline newline
-\end_inset
-
-Centered_Top_Environment, Sensitive, Counter
+LatexType BibEnvironment
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
-
+.
+\end_layout
+\end_deeper
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+LangPreamble
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
-\begin_inset Foot
+ Like
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Use protected spaces if you want more than one word as the label.
+BabelPreamble
\end_layout
\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
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+EndLangPreamble
\end_layout
\end_inset
- means it is defined in the layout (see
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelString
-\end_layout
+\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
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+LangPreamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+BabelPreamble
\end_layout
\end_inset
- are special cases of
+ 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
-Static
+theorems-ams.inc
\end_layout
\end_inset
-.
- The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this layout.
- Usage is for example the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ file) shows how this works:
+\end_layout
-\begin_layout Plain Layout
-Abstract
+\begin_layout LyX-Code
+Preamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
+\end_layout
- layout or the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
-\begin_layout Plain Layout
-Bibliography
+\begin_layout LyX-Code
+EndPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
- layout.
- This is also the case for
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
+
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-Manual
\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
- labels with latex type
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
-\begin_layout Plain Layout
-Environment
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
-, in order to make layouts for theorems work correctly.
-
+\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
-Sensitive
-\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
+\backslash
+claimname
+\end_layout
-Table
-\begin_inset Quotes erd
\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
-Sensitive
+BabelPreamble
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float.
- The
+ then uses the commands offered by the babel package to redefine
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Counter
-\end_layout
-\end_inset
-
- label type defines automatically numbered labels.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\backslash
+claimname
+\end_layout
\end_inset
-.
+ for each used language in multilanguage documents.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-List_Environment
+List_Environment, Bib_Environment
\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.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
means nothing special.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- and
+.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-, except that a
+, except that an
\begin_inset Flex CharStyle:Code
status collapsed
is generated for each paragraph of this environment.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
dialog.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-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
\begin_layout Standard
depending upon the LaTeX type.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
] The string that will be used in the menus and also for the caption.
+ This is translated to the current language if babel is used.
\end_layout
\begin_layout Description
\end_inset
] The heading used for the list of floats.
+ This is translated to the document language.
\end_layout
\begin_layout Description
\end_inset
.
-
\end_layout
\begin_layout Enumerate
projects / lyx.git / blobdiff