-\begin_layout PlainLayout
-where
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-key
-\end_layout
-
-\end_inset
-
- is a keyboard key and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-deadkey
-\end_layout
-
-\end_inset
-
- is dead key name.
- The following dead keys are supported (shortcut name is in parentheses):
-\end_layout
-
-\begin_layout Quotation
-
-\emph on
-Name
-\begin_inset Space \hfill{}
-\end_inset
-
-Example
-\end_layout
-
-\begin_layout Quotation
-acute (acu)
-\begin_inset Space \hfill{}
-\end_inset
-
-áéíóú
-\end_layout
-
-\begin_layout Quotation
-grave (gra)
-\begin_inset Space \hfill{}
-\end_inset
-
-àèìòù
-\end_layout
-
-\begin_layout Quotation
-macron (mac)
-\begin_inset Space \hfill{}
-\end_inset
-
- ō
-\end_layout
-
-\begin_layout Quotation
-tilde (til)
-\begin_inset Space \hfill{}
-\end_inset
-
-ñÑ
-\end_layout
-
-\begin_layout Quotation
-underbar (underb)
-\begin_inset Space \hfill{}
-\end_inset
-
-
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-b o
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Quotation
-cedilla (ced)
-\begin_inset Space \hfill{}
-\end_inset
-
-çÇ
-\end_layout
-
-\begin_layout Quotation
-underdot (underd)
-\begin_inset Space \hfill{}
-\end_inset
-
-
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-d o
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Quotation
-circumflex (circu)
-\begin_inset Space \hfill{}
-\end_inset
-
-âêîôû
-\end_layout
-
-\begin_layout Quotation
-circle (circl)
-\begin_inset Space \hfill{}
-\end_inset
-
-ÅůŮ
-\end_layout
-
-\begin_layout Quotation
-tie (tie)
-\begin_inset Space \hfill{}
-\end_inset
-
-
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-t o
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Quotation
-breve (bre)
-\begin_inset Space \hfill{}
-\end_inset
-
-ă
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-u o
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Quotation
-caron (car)
-\begin_inset Space \hfill{}
-\end_inset
-
-čšž
-\end_layout
-
-\begin_layout Quotation
-hungarian umlaut (hug)
-\begin_inset Space \hfill{}
-\end_inset
-
-őű
-\end_layout
-
-\begin_layout Quotation
-umlaut (uml)
-\begin_inset Space \hfill{}
-\end_inset
-
-äöü
-\end_layout
-
-\begin_layout Quotation
-dot (dot)
-\begin_inset Space \hfill{}
-\end_inset
-
-ż
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-.s
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Since in many international keyboards there are exceptions to what some
- dead keys should do, you can define them using
-\end_layout
-
-\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-kxmod
-\end_layout
-
-\end_inset
-
- deadkey key outstring
-\end_layout
-
-\begin_layout PlainLayout
-For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
-, so you put in
-\end_layout
-
-\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-kxmod
-\end_layout
-
-\end_inset
-
- caron o "
-\backslash
-^o"
-\end_layout
-
-\begin_layout PlainLayout
-to make it work correctly.
- Also, you have to define as exceptions dead keys over i and j, to remove
- the dot from them before inserting an accent mark.
- I will change this when the time comes, but so far I haven't had time.
-\end_layout
-
-\begin_layout PlainLayout
-Oh, and about characters: backslash is escaped, so to enter it, you'll need
- double backslash.
- Also, quotes and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-#
-\end_layout
-
-\end_inset
-
- have different meaning.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-#
-\end_layout
-
-\end_inset
-
- marks comments, quotes start and end LaTeX-style commands.
- To enter quote, you'll need to use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-"
-\end_layout
-
-\end_inset
-
-, to enter
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-#
-\end_layout
-
-\end_inset
-
-, use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-#
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-If you make a keyboard description file that works for your language, please
- mail it to me, so I can include it in the next keymap distribution.
-\end_layout
-
-\begin_layout Standard
-More keywords will be supported in keymap configuration file in future,
- like
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-kinclude filename
-\end_layout
-
-\end_inset
-
-
-\emph on
-
-\begin_inset Space \hfill{}
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-include
-\end_layout
-
-\end_inset
-
- another file
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-kprog program
-\end_layout
-
-\end_inset
-
-
-\emph on
-
-\begin_inset Space \hfill{}
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-define
-\end_layout
-
-\end_inset
-
- an external keymap translation program
-\end_layout
-
-\begin_layout Standard
-Also, it should look into
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lyxrc
-\end_layout
-
-\end_inset
-
- file for defaults, too (for example, a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-kinclude
-\end_layout
-
-\end_inset
-
- option to include default keyboard).
-\end_layout
-
-\begin_layout Section
-International Keymap Stuff
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:keymap"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The next two sections describe the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.kmap
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.cdef
-\end_layout
-
-\end_inset
-
- file syntax in detail.
- These sections should help you design your own key map if the ones provided
- do not meet your needs.
-\end_layout
-
-\begin_layout Subsection
-The .kmap File
-\end_layout
-
-\begin_layout Standard
-A
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-kmap
-\end_layout
-
-\end_inset
-
- file maps keystrokes to characters or strings.
- As the name suggests it sets a keyboard mapping.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.kmap
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
- file keywords
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-kmap
-\shape default
-,
-\shape up
-kmod
-\shape default
-,
-\shape up
-ksmod
-\end_layout
-
-\end_inset
-
-, and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-kcomb
-\end_layout
-
-\end_inset
-
- are described in this section.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-kmap
-\end_layout
-
-\end_inset
-
- Map a character to a string
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kmap
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\family roman
-\emph on
-string
-\end_layout
-
-\begin_layout Standard
-This will ma
-\family roman
-p
-\family default
-
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\family roman
-to
-\family default
-
-\family roman
-\emph on
-string
-\emph default
-.
- Note that in
-\family default
-
-\family roman
-\emph on
-string
-\emph default
-,
-\family default
-
-\family roman
-\shape up
-the double-quote (")
-\family default
-\shape default
-
-\family roman
-and
-\family default
-
-\family roman
-\shape up
-the backslash (
-\backslash
-)
-\family default
-\shape default
-
-\family roman
-must be escaped with a preceding backslash (
-\shape up
-
-\backslash
-
-\shape default
-)
-\family default
-.
-\end_layout
-
-\begin_layout Standard
-An example of a
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-kmap
-\end_layout
-
-\end_inset
-
- statement to cause the symbol
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-/
-\end_layout
-
-\end_inset
-
- to be output for the keystroke
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-&
-\end_layout
-
-\end_inset
-
- is:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kmap & /
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-kmod
-\end_layout
-
-\end_inset
-
- Specify an accent character
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kmod
-\family roman
-\emph on
-char accent allowed
-\end_layout
-
-\begin_layout Standard
-This will make the cha
-\family roman
-racter
-\family default
-
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\family roman
-\shape up
-\emph on
-be an accent
-\family default
-\shape default
-\emph default
-
-\family roman
-\shape up
-on the
-\family default
-\shape default
-
-\family roman
-\shape up
-\emph on
-allowed
-\family default
-\shape default
-\emph default
-
-\family roman
-\shape up
-cha
-\family default
-racter(s).
- This is the dead key
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-The term
-\family roman
-\emph on
-dead key
-\family default
-\emph default
- refers to a key that does not produce a character by itself, but when followed
- with another key, produces the desired accent character.
- For example, a German characte
-\family roman
-r with an umlaut like
-\family default
-
-\family roman
-\emph on
-ä
-\family default
-\emph default
-
-\family roman
-can be produced in this manner.
-\end_layout
-
-\end_inset
-
- mechanism.
-
-\end_layout
-
-\begin_layout Standard
-If you
-\family roman
-hit
-\family default
-
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\family roman
-and then another key not in
-\family default
-
-\family roman
-\emph on
-allowed
-\emph default
-, you will get a
-\family default
-
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\family roman
-followed by the other, unallowed key, as output.
-
-\family default
- Note that a
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-Backspace
-\end_layout
-
-\end_inset
-
- cancels a dead key, so if
-\family roman
-you hit
-\family default
-
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-\emph on
-Backspace
-\end_layout
-
-\end_inset
-
-, the cursor will not go one position backwards but will instead cancel
- the effect t
-\family roman
-hat
-\family default
-
-\family roman
-\shape up
-\emph on
-char
-\family default
-\shape default
-\emph default
-
-\family roman
-\shape up
-might have had on the next keystroke.
-
-\end_layout
-
-\begin_layout Standard
-The following example specifies that the character ' is to be an acute accent,
- allowed on the characters a, e, i, o, u, A, E, I, O, and U:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kmod ' acute aeiouAEIOU
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ksmod
-\end_layout
-
-\end_inset
-
- Specify an exception to the accent character
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kxmod
-\family roman
-\emph on
-accent char result
-\end_layout
-
-\begin_layout Standard
-This defines an exce
-\family roman
-ption for
-\family default
-
-\family roman
-\emph on
-accent
-\family default
-\emph default
-
-\family roman
-on
-\family default
-
-\family roman
-\emph on
-char
-\emph default
-.
- T
-\shape up
-he
-\family default
-\shape default
-
-\family roman
-\shape up
-\emph on
-accent
-\family default
-\shape default
-\emph default
-
-\family roman
-\shape up
-must
-\family default
-\shape default
-
-\shape up
-have been assigned a keystroke with a previous
-\shape default
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-
-\backslash
-kmo
-\shape default
-d
-\end_layout
-
-\end_inset
-
- declar
-\family roman
-ation and
-\family default
-
-\family roman
-\emph on
-char
-\family default
-\emph default
-
-\family roman
-must not belong in the
-\family default
-
-\family roman
-\emph on
-allowed
-\family default
-\emph default
-
-\family roman
-set of
-\family default
-
-\family roman
-\emph on
-accent
-\emph default
-.
- When
-\family default
-
-\family roman
-\shape up
-you enter the
-\family default
-\shape default
-
-\family roman
-\shape up
-\emph on
-accent char
-\family default
-\shape default
-\emph default
-
-\family roman
-\shape up
-sequence,
-\family default
-\shape default
-
-\family roman
-\shape up
-\emph on
-result
-\family default
-\shape default
-\emph default
-
-\family roman
-\shape up
- is produced.
- If such a declaration does not exist in
-\family default
-\shape default
-
-\shape up
-the
-\shape default
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.kmap
-\end_layout
-
-\end_inset
-
- file and yo
-\family roman
-u enter
-\family default
-
-\family roman
-\emph on
-accent char
-\emph default
-, you get
-\family default
-
-\family roman
-\emph on
-accent_key char
-\family default
-\emph default
-
-\family roman
- where
-\family default
-
-\family roman
-\emph on
-accent_key
-\family default
-\emph default
-
-\family roman
- is the first arg
-\family default
-ument of the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-
-\backslash
-kmod
-\end_layout
-
-\end_inset
-
- declaration.
-
-\end_layout
-
-\begin_layout Standard
-The following command produces causes äi to be produced when you enter acute-i
- ('i):
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kxmod acute i "
-\backslash
-
-\backslash
-'{
-\backslash
-
-\backslash
-i}"
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-kcomb
-\end_layout
-
-\end_inset
-
- Combine two accent characters
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kcomb
-\family roman
-\emph on
-accent1 accent2 allowed
-\end_layout
-
-\begin_layout Standard
-This one is getting pretty esoteric.
- It allows you to combine the effect
-\family roman
-of
-\family default
-
-\family roman
-\emph on
-accent1
-\family default
-\emph default
-
-\family roman
-and
-\family default
-
-\family roman
-\emph on
-accent2
-\family default
-\emph default
-
-\family roman
-(in that order!) on
-\family default
-
-\family roman
-\emph on
-allowed
-\family default
-\emph default
-
-\family roman
-chars.
- The keystrokes for
-\family default
-
-\family roman
-\emph on
-accent1
-\family default
-\emph default
-
-\family roman
-and
-\family default
-
-\family roman
-\emph on
-accent2
-\family default
-\emph default
-
-\family roman
-must have be
-\family default
-en set with a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-
-\backslash
-kmod
-\end_layout
-
-\end_inset
-
- command at
-\family roman
-a
-\family default
-
-\family roman
-\emph on
-previous
-\family default
-\emph default
-
-\family roman
-point in the
-\family default
- file.
-
-\end_layout
-
-\begin_layout Standard
-Consider this example from the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-greek.kmap
-\end_layout
-
-\end_inset
-
- file:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-kmod ; acute aeioyvhAEIOYVH
-\backslash
-kmod : umlaut iyIY
-\backslash
-kcomb acute umlaut iyIY
-\end_layout
-
-\begin_layout Standard
-This allows you to press
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-;:i
-\end_layout
-
-\end_inset
-
- and get the effect of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-
-\backslash
-'{
-\backslash
-"{i}}
-\end_layout
-
-\end_inset
-
-.
-
-\family roman
-\shape up
-A backspace
-\family default
-\shape default
- in this case cancels the last dead key, so if you press
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-;: Backspace i
-\end_layout
-
-\end_inset
-
- you get
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-
-\backslash
-'{i}
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-The .cdef File
-\end_layout
-
-\begin_layout Standard
-After the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.kmap
-\end_layout
-
-\end_inset
-
- mapping is performed, a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.cde
-\shape default
-f
-\end_layout
-
-\end_inset
-
- file maps the strings that the symbols generate to characters in the current
- font.
- The LyX distribution currently includes at least the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-iso8859-1.cdef
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-iso8859-2.cdef
-\end_layout
-
-\end_inset
-
- files.
-\end_layout
-
-\begin_layout Standard
-In general the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-.cdef
-\end_layout
-
-\end_inset
-
- file is a sequence of declarations of the form
-\end_layout
-
-\begin_layout LyX-Code
-
-\family roman
-\emph on
-char_index_in_set
-\family default
-\emph default
-
-\family roman
-\emph on
- string
-\end_layout
-
-\begin_layout Standard
-For example, in order to map
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\shape up
-
-\backslash
-'{e}
-\end_layout
-
-\end_inset
-
- to the corresponding character in the iso-8859-1 set (233), the following
- declaration is used
-\end_layout
-
-\begin_layout LyX-Code
-233 "
-\backslash
-
-\backslash
-'{e}"
-\end_layout
-
-\begin_layout Standard
-with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"
-\end_layout
-
-\end_inset
-
- being escap
-\family roman
-ed in
-\family default
-
-\family roman
-\emph on
-string
-\emph default
-.
- Note that
-\family default
- the same character can apply to more than one string.
- In the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-i
-\shape up
-so-8859-7.cdef
-\end_layout
-
-\end_inset
-
- file you have
-\end_layout
-
-\begin_layout LyX-Code
-192 "
-\backslash
-
-\backslash
-'{
-\backslash
-
-\backslash
-
-\backslash
-"{i}}"
-\newline
-192 "
-\backslash
-
-\backslash
-
-\backslash
-"{
-\backslash
-
-\backslash
-'{i}}"
-\end_layout
-
-\begin_layout Standard
-If LyX cannot find a mapping for the string produced by the keystroke or
- a deadkey sequence, it will check if it looks like an accented char and
- try to draw an accent over the character on screen.
-\end_layout
-
-\begin_layout Subsection
-Dead Keys
-\end_layout
-
-\begin_layout Standard
-There is a second way to add support for international characters through
- so-called dead-keys.
- A dead-key works in combination with a letter to produce an accented character.
- Here, we'll explain how to create a really simple dead-key to illustrate
- how they work.
-\end_layout
-
-\begin_layout Standard
-Suppose you happen to need the circumflex character,
-\begin_inset Quotes eld
-\end_inset
-
- ̂
-\begin_inset Quotes erd
-\end_inset
-
-.
- You could bind the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-^
-\end_layout
-
-\end_inset
-
--key [a.k.a.
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Shift-6
-\end_layout
-
-\end_inset
-
-] to the LyX command
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-accent-circumflex
-\end_layout
-
-\end_inset
-
- in your
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lyxrc
-\end_layout
-
-\end_inset
-
- file.
- Now, whenever you type the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-^
-\end_layout
-
-\end_inset
-
--key followed by a letter, that letter will have a circumflex accent on
- it.
- For example, the sequence
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-^e
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- produces the letter:
-\begin_inset Quotes eld
-\end_inset
-
-ê
-\begin_inset Quotes erd
-\end_inset
-
-.
- If you tried to type
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-^t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-, however, LyX will complain with a beep, since a
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- never takes a circumflex accent.
- Hitting
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Space
-\end_layout
-
-\end_inset
-
- after a dead-key produces the bare-accent.
- Please note this last point! If you bind a key to a dead-key, you'll need
- to rebind the character on that key to yet another key.
- Binding the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-,-key
-\end_layout
-
-\end_inset
-
- to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
-\end_layout
-
-\begin_layout Standard
-One common way to bind dead-keys is to use
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Meta-
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Ctrl-
-\end_layout
-
-\end_inset
-
-, and
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Shift-
-\end_layout
-
-\end_inset
-
- in combination with an accent, like
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-~
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-,
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-^
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- Another way involves using
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xmodmap
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xkeycaps
-\end_layout
-
-\end_inset
-
- [remember them from section?] to set up the special
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Mode_Switch
-\end_layout
-
-\end_inset
-
- key.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Mode_Switch
-\end_layout
-
-\end_inset
-
- acts in some ways just like
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Shift
-\end_layout
-
-\end_inset
-
- and permits you to bind keys to accented characters.
- You can also turn keys into dead-keys by binding them to something like
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-usldead_cedilla
-\end_layout
-
-\end_inset
-
- and then binding this symbolic key to the corresponding LyX command.
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-Note from
-\noun on
-John Weiss
-\noun default
-: This is exactly what I do in my
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-~/.lyx/lyxrc
-\end_layout
-
-\end_inset
-
- and my
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-~/.xmodmap
-\end_layout
-
-\end_inset
-
- files.
- I have my
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Scroll
-\begin_inset Space ~
-\end_inset
-
-Lock
-\end_layout
-
-\end_inset
-
- key set up as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Mode_Shift
-\end_layout
-
-\end_inset
-
- and a bunch of these
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-usldead_*
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- symbolic keys bound such things as
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Scroll
-\begin_inset Space ~
-\end_inset
-
-Lock-^
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Scroll
-\begin_inset Space ~
-\end_inset
-
-Lock-~
-\end_layout
-
-\end_inset
-
-.
- This is how I produce my accented characters.
-\end_layout
-
-\end_inset
-
- You can make just about anything into the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Mode_Switch
-\end_layout
-
-\end_inset
-
- key: One of the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Ctrl-
-\end_layout
-
-\end_inset
-
- keys, a spare function key, etc.
- As for the LyX commands that produce accents, check the entry for
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-accent-acute
-\end_layout
-
-\end_inset
-
- in the
-\emph on
-Reference Manual
-\emph default
-.
- You'll find the complete list there.
-\end_layout
-
-\begin_layout Subsection
-Saving your Language Configuration
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:savlang"
-
-\end_inset
-
-You can edit your preferences so that your desired language environment
- is automatically configured when LyX starts up, via the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
-\end_layout
-
-\end_inset
-
- dialog.
-\end_layout
-
-\begin_layout Chapter
-Installing New Document Classes, Layouts, and Templates
-\begin_inset CommandInset label
-LatexCommand label
-name "chap:textclass"
-
-\end_inset
-
-
-\begin_inset OptArg
-status collapsed
-
-\begin_layout PlainLayout
-Installing New Document Classes
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-In this chapter, we describe the procedures for creating and installing
- new LyX layout and template files, as well as offer a refresher on correctly
- installing new LaTeX document classes.
- Some definitions: a document class is a LaTeX file (usually ending in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.cls
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.sty
-\end_layout
-
-\end_inset
-
-) which describes the format of a document such as an article, report, journal
- preprint, etc.
- and all the commands needed to realize that format.
- A layout file is a LyX file which corresponds to a LaTeX document class
- and which tells LyX how to
-\begin_inset Quotes eld
-\end_inset
-
-draw
-\begin_inset Quotes erd
-\end_inset
-
- things on the screen to make the display look something like the final
- printed page.
- More precisely, a layout file describes a
-\begin_inset Quotes eld
-\end_inset
-
-text class
-\begin_inset Quotes erd
-\end_inset
-
- which is the internal construct LyX uses to render the screen display.
-
-\begin_inset Quotes eld
-\end_inset
-
-Layout
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-text class
-\begin_inset Quotes erd
-\end_inset
-
- can be used somewhat interchangeably, but it is better to refer to the
- file as the layout, and the thing living in LyX's memory as the text class.
- A template file is simply a LyX document which contains a set of predefined
- entries for a given document class which are generally required for that
- class.
- Templates are especially useful for things like journal manuscripts which
- are to be submitted electronically.
-\end_layout
-
-\begin_layout Section
-Installing a new LaTeX package
-\end_layout
-
-\begin_layout Standard
-Some installations may not include a LaTeX package that you would like to
- use within LyX.
- For example, you might need FoilTeX, a common (and very powerful) package
- for preparing slides or viewgraphs for overhead projectors.
- Here are the formal steps involved in getting the package up and running
- if you are using teTeX or some other web2c based distribution.
-
-\end_layout
-
-\begin_layout Enumerate
-Get the package from CTAN or wherever.
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-See the
-\emph on
-Inventory of your LaTeX configuration
-\emph default
- manual for details of what CTAN is and where supported document classes
- can be found.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Enumerate
-Read the file
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf.cnf
-\end_layout
-
-\end_inset
-
- (this usually lives in the directory
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$TEXMF/web2c
-\end_layout
-
-\end_inset
-
-, though you can run
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-kpsewhich texmf.cnf
-\end_layout
-
-\end_inset
-
- to locate it).
- It describes how to add a local
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf
-\end_layout
-
-\end_inset
-
- directory; follow the instructions.
- You need to insert the name of your local
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf
-\end_layout
-
-\end_inset
-
- directory in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf.cnf
-\end_layout
-
-\end_inset
-
-.
- Under Linux,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-/usr/local
-\end_layout
-
-\end_inset
-
- is a logical place to install software that did not come with your distribution
-, so you might use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-/usr/local/texmf
-\end_layout
-
-\end_inset
-
-.
- Usually, you will have to modify only two things:
-\end_layout
-
-\begin_deeper
-\begin_layout Enumerate
-Set
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TEXMFLOCAL
-\end_layout
-
-\end_inset
-
- to the directory you chose; e.g.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TEXMFLOCAL = /usr/local/texmf
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Enumerate
-Make sure
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TEXMF includes the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TEXMFLOCAL
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
- variable; e.g.
-
-\newline
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TEXMF = {$HOMETEXMF,!!$TEXMFLOCAL,!!$TEXMFMAIN}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_deeper
-\begin_layout Enumerate
-Create your local
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf directory (e.g.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-/usr/local/texmf
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-).
- You must follow the directory structure of your existing
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf
-\end_layout
-
-\end_inset
-
- directory (for example, latex packages should go under
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-/usr/local/texmf/tex/latex/
-\end_layout
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Enumerate
-Install the package.
- For example, you would unpack the FoilTeX tarball and create
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-/usr/local/texmf/tex/latex/foiltex
-\end_layout
-
-\end_inset
-
-.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-foiltex
-\end_layout
-
-\end_inset
-
- directory contains various files.
-\end_layout
-
-\begin_layout Enumerate
-Run:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texhash
-\end_layout
-
-\end_inset
-
-.
- This should create
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-/usr/local/texmf/ls-R
-\end_layout
-
-\end_inset
-
- amongst others.
-\end_layout
-
-\begin_layout Enumerate
-From within LyX, do:
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
-\end_layout
-
-\end_inset
-
-.
- Restart LyX.
-\end_layout
-
-\begin_layout Standard
-Now you should see your new package---for example
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-slides (FoilTeX)
-\end_layout
-
-\end_inset
-
----under
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-ocument
-\end_layout
-
-\end_inset
-
-, field
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-C
-\bar default
-lass
-\end_layout
-
-\end_inset
-
-.
- Note that there are simpler ways of installing packages: you can add a
- link to the new package directory in the system LaTeX directory (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$TEXMF/tex/latex
-\end_layout
-
-\end_inset
-
-, don't forget to then run
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texconfig
-\end_layout
-
-\end_inset
-
-), or sometimes simply set the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$TEXINPUTS
-\end_layout
-
-\end_inset
-
- environment variable to include the new package.
- However, the formal procedure described in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-texmf.cnf
-\end_layout
-
-\end_inset
-
- is guaranteed to work, so you should follow it unless circumstances absolutely
- prevent it: such as, when you don't have superuser access.
-\end_layout
-
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Layouts"
-
-\end_inset
-
-Layouts
-\end_layout
-
-\begin_layout Standard
-This section describes how to write and install your own LyX layout files
- (also known as text classes) and walks through the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-article
-\end_layout
-
-\end_inset
-
- text class format as an example.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.layout
-\end_layout
-
-\end_inset
-
- files describe what paragraph styles are available for a given document
- class and how LyX should display them.
- We try to provide a thorough description of the process here; however,
- there are so many different types of documents supported by LaTeX classes
- that we can't hope to cover every different possibility or problem you
- might encounter.
- (The LyX users' list is frequented by people with lots of experience with
- layout design who are willing to share what they've learned.)
-\end_layout
-
-\begin_layout Standard
-As you prepare to write a new layout, it is extremely helpful to look at
- the example layouts distributed with LyX.
- If you use a nice LaTeX document class that might be of interest for others,
- too, and have a nice corresponding LyX layout, feel free to contribute
- the stuff to us, so we may put it into the distribution.
- There is also a section on the LyX wiki for this kind of material.
-\end_layout
-
-\begin_layout Standard
-All the tags described in this chapter are case-insensitive; this means
- that
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Style
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-style
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-StYlE
-\end_layout
-
-\end_inset
-
- are really the same command.
- The possible values are printed in brackets after the feature's name.
- The default value if a feature isn't specified inside a text class-description
- is typeset
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-emphasized
-\end_layout
-
-\end_inset
-
-.
- If the argument has a datatype like
-\begin_inset Quotes eld
-\end_inset
-
-string
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-float
-\begin_inset Quotes erd
-\end_inset
-
-, the default is shown like this:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float=
-\emph on
-default
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Layout-modules"
-
-\end_inset
-
-Layout modules
-\end_layout
-
-\begin_layout Standard
-Similar to layout files, and new with LyX 1.6, are layout
-\emph on
-modules
-\emph default
-.
- Modules are to LaTeX packages much as layouts are to LaTeX classes, and
- some modules---such as the Endnotes module---provide support for just such
- a package.
- In a sense, layout modules are similar to included files---files like stdsectio
-ns.inc---in that modules are not specific to a given document layout but
- may be used with many different layouts.
- The difference is that using a layout module does not require editing the
- layout file.
- Rather, modules are selected in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\end_layout
-
-\end_inset
-
- dialog.
-\end_layout
-
-\begin_layout Standard
-Building modules is the easiest way to get started with layout editing,
- since it can be as simple as adding a single new paragraph or flex inset.
- But modules may, in principle, contain anything a layout file can contain.
-\end_layout
-
-\begin_layout Standard
-A module must begin with a line like the following:
-\end_layout
-
-\begin_layout LyX-Code
-#
-\backslash
-DeclareLyXModule[endnotes.sty]{Endnotes}
-\end_layout
-
-\begin_layout Standard
-The argument in square brackets is optional: It declares any LaTeX packages
- on which the module depends.
- The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Document\SpecialChar \menuseparator
-Settings
-\end_layout
-
-\end_inset
-
-.
- LyX uses the name to identify the module, so it should be unique.
-\end_layout
-
-\begin_layout Standard
-The module declaration should then be followed by lines like the following:
-\end_layout
-
-\begin_layout LyX-Code
-#DescriptionBegin
-\end_layout
-
-\begin_layout LyX-Code
-#Adds an endnote command, in addition to footnotes.
-
-\end_layout
-
-\begin_layout LyX-Code
-#You will need to add
-\backslash
-theendnotes in ERT where you
-\end_layout
-
-\begin_layout LyX-Code
-#want the endnotes to appear.
-
-\end_layout
-
-\begin_layout LyX-Code
-#DescriptionEnd
-\end_layout
-
-\begin_layout LyX-Code
-#Requires: somemodule | othermodule
-\end_layout
-
-\begin_layout LyX-Code
-#Excludes: badmodule
-\end_layout
-
-\begin_layout Standard
-The description is used in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Document\SpecialChar \menuseparator
-Settings
-\end_layout
-
-\end_inset
-
- to provide the user with information about what the module does.
- The Requires is used to identify other modules with which this one must
- be used; the Excludes line is used to identify modules with which this
- one may not be used.
- Both are optional, and, as shown, multiple modules should be separated
- with the pipe symbol: |.
- Note that the required modules are treated disjunctively:
-\emph on
-at least one
-\emph default
- of the required modules must be used.
- Similarly,
-\emph on
-no
-\emph default
- excluded module may be used.
- Note that modules are identified here by their
-\emph on
-filenames
-\emph default
- without the .module extension.
- So
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-somemodule
-\end_layout
-
-\end_inset
-
- is really
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-somemodule.module
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-After creating a new module, you will need to reconfigure and then restart
- LyX for it to appear in the menu.
- However, changes you make to the module will be seen immediately, if you
- open
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Document\SpecialChar \menuseparator
-Settings
-\end_layout
-
-\end_inset
-
-, highlight something, and then hit
-\begin_inset Quotes eld
-\end_inset
-
-OK
-\begin_inset Quotes erd
-\end_inset
-
-.
-
-\emph on
-It is strongly recommended that you save your work before doing so
-\emph default
-.
- In fact, it is strongly recommended that you not attempt to edit modules
- while simultaneously working on documents.
- Though of course the developers strive to keep LyX stable in such situations,
- syntax errors and the like in your module file could cause strange behavior.
-\end_layout
-
-\begin_layout Subsection
-Supporting new document classes
-\end_layout
-
-\begin_layout Standard
-There are two situations you are likely to encounter when wanting to support
- a new LaTeX document class, involving LaTeX2e class (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.cls
-\end_layout
-
-\end_inset
-
-) and style (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.sty
-\end_layout
-
-\end_inset
-
-) files.
- Supporting a style file is usually fairly easy.
- Supporting a new document class is a bit harder.
-\end_layout
-
-\begin_layout Subsection
-A layout for a
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-sty
-\end_layout
-
-\end_inset
-
- file
-\end_layout
-
-\begin_layout Standard
-If your new document class is provided as a style file that is used in conjuncti
-on with an existing, supported document class---for the sake of the example,
- we'll assume that the style file is called
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-myclass.sty
-\end_layout
-
-\end_inset
-
- and it is meant to be used with
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-report.cls
-\end_layout
-
-\end_inset
-
-, which is a standard class---start by copying the existing class's layout
- file into your local directory:
-\end_layout
-
-\begin_layout LyX-Code
-cp report.layout ~/.lyx/layouts/myclass.layout
-\end_layout
-
-\begin_layout Standard
-Then edit
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-myclass.layout
-\end_layout
-
-\end_inset
-
- and change the line:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-DeclareLaTeXClass{report}
-\end_layout
-
-\begin_layout Standard
-to read
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
-\end_layout
-
-\begin_layout Standard
-Then add:
-\end_layout
-
-\begin_layout LyX-Code
-Preamble
-\newline
-
-\backslash
-usepackage{myclass}
-\newline
-EndPreamble
-\end_layout
-
-\begin_layout Standard
-near the top of the file.
-\end_layout
-
-\begin_layout Standard
-Start LyX and select
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
-\end_layout
-
-\end_inset
-
-.
- Then restart LyX and try creating a new document.
- You should see "
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-report (myclass)
-\end_layout
-
-\end_inset
-
-" as a document class option in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\end_layout
-
-\end_inset
-
- dialog.
- It is likely that some of the sectioning commands and such in your new
- class will work differently from how they worked in the base class---
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-report
-\end_layout
-
-\end_inset
-
- in this example---so you can fiddle around with the settings for the different
- sections if you wish.
- See below for more discussion on this.
-\end_layout
-
-\begin_layout Subsection
-Layout for a
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-cls
-\end_layout
-
-\end_inset
-
- file
-\end_layout
-
-\begin_layout Standard
-There are two possibilities here.
- One is that the class file is itself based upon an existing document class.
- For example, many thesis classes are based upon
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-book.cls
-\end_layout
-
-\end_inset
-
-.
- To see whether yours is, look for a line like
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-LoadClass{book}
-\end_layout
-
-\begin_layout Standard
-in the file.
- If so, then you may proceed largely as in the previous section, though
- the DeclareLaTeXClass line will be different.
- If your new class is thesis, and it is based upon book, then the line should
- read:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-DeclareLaTeXClass[myclass, book]{thesis}
-\end_layout
-
-\begin_layout Standard
-If, on the other hand, the new class is not based upon an existing class,
- you will probably have to
-\begin_inset Quotes eld
-\end_inset
-
-roll your own
-\begin_inset Quotes erd
-\end_inset
-
- layout.
- We strongly suggest copying an existing layout file which uses a similar
- LaTeX class and then modifying it, if you can do so.
- At least use an existing file as a starting point so you can find out what
- items you need to worry about.
- Again, the specifics are covered below.
-\end_layout
-
-\begin_layout Section
-Declaring a new text class
-\end_layout
-
-\begin_layout Standard
-When it's finally time to get your hands dirty and create or edit your own
- layout file, the following sections describe what you're up against.
- Our advice is to go slowly, save and test often, listen to soothing music,
- and enjoy one or two of your favorite adult beverages; more if you are
- getting particularly stuck.
- It's really not that hard, except that the multitude of options can become
- overwhelming if you try to do to much in one sitting.
- Go have another adult beverage, just for good measure.
-\end_layout
-
-\begin_layout Standard
-Here we go!
-\end_layout
-
-\begin_layout Standard
-Lines in a layout file which begin with a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-#
-\end_layout
-
-\end_inset
-
- are comments.
- There is one exception to this rule: all layouts should begin with lines
- like:
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass{article}
-\end_layout
-
-\begin_layout Standard
-The second line is used when you configure LyX.
- The layout file is read by the LaTeX script
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-chkconfig.ltx
-\end_layout
-
-\end_inset
-
-, in a special mode where
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-#
-\end_layout
-
-\end_inset
-
- is ignored.
- The first line is just a LaTeX comment, and the second one contains the
- declaration of the text class.
- If these lines appear in a file named
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-article.layout
-\end_layout
-
-\end_inset
-
-, then they define a text class of name
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-article
-\end_layout
-
-\end_inset
-
- (the name of the layout file) which uses the LaTeX document class
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-article.cls
-\end_layout
-
-\end_inset
-
- (the default is to use the same name as the layout).
- The string
-\begin_inset Quotes eld
-\end_inset
-
-article
-\begin_inset Quotes erd
-\end_inset
-
- that appears above is used as a description of the text class in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\end_layout
-
-\end_inset
-
- dialog.
-\end_layout
-
-\begin_layout Standard
-Let's assume that you wrote your own text class that uses the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-article.cls
-\end_layout
-
-\end_inset
-
- documentclass, but where you changed the appearance of the section headings.
- If you put it in a file
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-myarticle.layout
-\end_layout
-
-\end_inset
-
-, the header of this file should be:
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[article]{article (with my own headings)}
-\end_layout
-
-\begin_layout Standard
-This declares a text class
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-myarticle
-\end_layout
-
-\end_inset
-
-, associated with the LaTeX document class
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-article.cls
-\end_layout
-
-\end_inset
-
- and described as
-\begin_inset Quotes eld
-\end_inset
-
-article (with my own headings)
-\begin_inset Quotes erd
-\end_inset
-
-.
- If your text class depends on several packages, you can declare it as:
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
-\end_layout
-
-\begin_layout Standard
-This indicates that your text class uses the foo.sty package.
- Finally, it is also possible to declare classes for DocBook code.
- Typical declarations will look like
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareDocBookClass[article]{SGML (DocBook article)}
-\end_layout
-
-\begin_layout Standard
-Note that these declarations can also be given an optional parameter declaring
- the name of the document class (but not a list).
-\end_layout
-
-\begin_layout Standard
-So, to be as explicit as possible, the form of the layout declaration is:
-\end_layout
-
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[class,package.sty]{layout description}
-\end_layout
-
-\begin_layout Standard
-The class need only be specified if the name of the LaTeX class file and
- the name of the layout file are different; if the name of the classfile
- is not specified, then LyX will simply assume that it is the same as the
- name of the layout file.
-\end_layout
-
-\begin_layout Standard
-When the text class has been modified to your taste, all you have to do
- is to copy it either in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$LyXDir/layouts/
-\end_layout
-
-\end_inset
-
- or in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$UserDir/layouts
-\end_layout
-
-\end_inset
-
- and run
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
-\end_layout
-
-\end_inset
-
-.
- Exit LyX and restart it; then your new text class should be available along
- with the others.
-\end_layout
-
-\begin_layout Standard
-In versions of LyX prior to 1.6, you had to restart LyX to see any changes
- you made to your layout files.
- As a result, editing layout files could be very time consuming.
- Beginning with 1.6, however, you can force a reload of the layout currently
- in use by using the LyX function
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-layout-reload
-\end_layout
-
-\end_inset
-
-.
- There is no default binding for this function---though, of course, you
- can bind it to a key yourself (see section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:bindings"
-
-\end_inset
-
-).
- If you want to use this function, then, you should simply enter it in the
- mini-buffer.
-
-\emph on
-Warning
-\emph default
-: This is very much an `advanced feature'.
- It is
-\emph on
-strongly
-\emph default
- recommended that you save your work before using this function.
- In fact, it is
-\emph on
-strongly
-\emph default
- recommended that you not attempt to edit your layout while simultaneously
- working on a document that you care about.
- Use a test document.
- Syntax errors and the like in your layout file could cause peculiar behavior.
- In particular, such errors could cause LyX to regard the current layout
- as invalid and to attempt to switch to some other layout.
- The LyX team strives to keep LyX stable in such situations, but safe is
- better than sorry.
-\end_layout
-
-\begin_layout Subsection
-File format
-\end_layout
-
-\begin_layout Standard
-The first non-comment line must contain the file format number:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Format
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-int
-\end_layout
-
-\end_inset
-
-] This tag was introduced with LyX 1.4.0 (layout files of LyX 1.3.x and earlier
- don't have an explicit file format).
- The file format that is documented here is
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-6
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-General text class parameters
-\end_layout
-
-\begin_layout Standard
-These are the general parameters which describe the form of the entire document:
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Columns
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-1
-\emph default
-, 2
-\end_layout
-
-\end_inset
-
-] Whether the class-default should have one or two columns.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\end_layout
-
-\end_inset
-
- dialog.
- This setting (same goes for
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Sides
-\end_layout
-
-\end_inset
-
-, too) is important: if your text class has two columns by default but you
- forget to set it correctly, the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-twocolumn
-\end_layout
-
-\end_inset
-
- LaTeX option will
-\emph on
-not
-\emph default
- be output when you select
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Two columns
-\end_layout
-
-\end_inset
-
- in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Sides
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-1
-\emph default
-, 2
-\end_layout
-
-\end_inset
-
-] Whether the class-default should be printing on one or both sides of the
- paper.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\end_layout
-
-\end_inset
-
- dialog.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\series medium
-PageStyle
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-plain
-\emph default
-, empty, headings
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-] The class default pagestyle.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\end_layout
-
-\end_inset
-
- dialog.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ClassOptions\SpecialChar \ldots{}
-End
-\end_layout
-
-\end_inset
-
- This section describes various global options supported by the document
- class.
- See Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:classoptions"
-
-\end_inset
-
- for a description.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Provides
-\end_layout
-
-\end_inset
-
-[
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-] [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-, 1
-\end_layout
-
-\end_inset
-
-] Whether the class already provides the feature
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
- string
-\end_layout
-
-\end_inset
-
-.
- A feature is in general the name of a package (amsmath, makeidx, \SpecialChar \ldots{}
-) or a
- macro (url, boldsymbol,\SpecialChar \ldots{}
-); the complete list of supported features is unfortunat
-ely not documented.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Requires
-\end_layout
-
-\end_inset
-
-[
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-] Whether the class requires the feature
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
- string
-\end_layout
-
-\end_inset
-
-.
- A feature is in general the name of a package (amsmath, makeidx, \SpecialChar \ldots{}
-) or a
- macro (url, boldsymbol,\SpecialChar \ldots{}
-).
- Multiple features must be separated by commas.
- Note that you can only request supported features; unfortunately, the complete
- list of supported features is not documented (however,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX Configuration
-\end_layout
-
-\end_inset
-
- gives an overview of the supported packages).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-DefaultFont
-\end_layout
-
-\end_inset
-
- This is used to describe the default font of the document.
- See Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
-
-\end_inset
-
- for a description.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-DefaultStyle
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Standard
-\end_layout
-
-\end_inset
-
-.
- This will default to the first defined style if not given, but you are
- highly encouraged to use this directive.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TitleLatexType
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-CommandAfter
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Environment
-\end_layout
-
-\end_inset
-
-] Indicates what kind of markup is used to define the title of a document.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-CommandAfter
-\end_layout
-
-\end_inset
-
- means that the macro with name
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TitleLatexName
-\end_layout
-
-\end_inset
-
- will be inserted after the last layout which has
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InTitle 1
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Environment
-\end_layout
-
-\end_inset
-
- corresponds to the case where the block of paragraphs which have
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InTitle 1
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- should be enclosed into the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TitleLatexName
-\end_layout
-
-\end_inset
-
- environment.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TitleLatexName
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string="maketitle"
-\end_layout
-
-\end_inset
-
-] The name of the command/environment mentionned above.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Preamble\SpecialChar \ldots{}
-EndPreamble
-\end_layout
-
-\end_inset
-
- A set of macro definitions that will be output at the beginning of the
- LaTeX files.
- Use this for global definitions.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Input
-\end_layout
-
-\end_inset
-
- As its name implies, this command allows you to include another layout
- definition file within yours to avoid duplicating commands.
- Common examples are the standard layout files, for example,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-stdclass.inc
-\end_layout
-
-\end_inset
-
-, which contains most of the basic layouts.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Style\SpecialChar \ldots{}
-End
-\end_layout
-
-\end_inset
-
- This sequence defines a new 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 "sec:style"
-
-\end_inset
-
- for details.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NoStyle
-\end_layout
-
-\end_inset
-
- This command deletes an existing style.
- This is particularly useful when you want to suppress a style that has
- be defined in an input file.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Float\SpecialChar \ldots{}
-End
-\end_layout
-
-\end_inset
-
- This sequence defines a new float.
- See Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:floats"
-
-\end_inset
-
- for details.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NoFloat
-\end_layout
-
-\end_inset
-
- This command deletes an existing float.
- This is particularly useful when you want to suppress a float that has
- be defined in an input file.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InsetLayout\SpecialChar \ldots{}
-End
-\end_layout
-
-\end_inset
-
- This section (re-)defines the layout of an inset.
- It can be applied to an existing inset of to a new, user-defined inset,
- e.g., a new character style.
- See Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:charstyle"
-
-\end_inset
-
- for a description.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Counter\SpecialChar \ldots{}
-End
-\end_layout
-
-\end_inset
-
- This sequence defines a new counter.
- See Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
-
-\end_inset
-
- for details.
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ClassOptions
-\end_layout
-
-\end_inset
-
- section
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:classoptions"
-
-\end_inset
-
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ClassOptions
-\end_layout
-
-\end_inset
-
- section can contain the following entries:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-FontSize
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string="10|11|12"
-\end_layout
-
-\end_inset
-
-] The list of available font sizes for the document's main font, separated
- by
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-|
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-PageStyle
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string="empty|plain|headings|fancy"
-\end_layout
-
-\end_inset
-
-] The list of available page styles, separated by
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-|
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Other
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-documentclass
-\end_layout
-
-\end_inset
-
- command.
-\end_layout
-
-\begin_layout Subsection
-Specific Paragraph Layouts
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:style"
-
-\end_inset
-
-A paragraph layout description looks like this
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-Note that this will either define a new layout or modify an existing one.
-\end_layout
-
-\end_inset
-
-:
-\end_layout
-
-\begin_layout LyX-Code
-Style
-\family roman
-\emph on
-name
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-End
-\end_layout
-
-\begin_layout Standard
-where the following commands are allowed:
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-CopyStyle
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-[string]
-\end_layout
-
-\end_inset
-
- This is used to copy all the features of an existing layout into the current
- one.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexType
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-List_Environment
-\end_layout
-
-\end_inset
-
-] How the layout should be translated into LaTeX.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Paragraph
-\end_layout
-
-\end_inset
-
- means nothing special.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Command
-\end_layout
-
-\end_inset
-
- means
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Environment
-\end_layout
-
-\end_inset
-
- means
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
-\end_layout
-
-\end_inset
-
-.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Item_Environment
-\end_layout
-
-\end_inset
-
- is the same as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Environment
-\end_layout
-
-\end_inset
-
-, except that a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-item
-\end_layout
-
-\end_inset
-
- is generated for each paragraph of this environment.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-List_Environment
-\end_layout
-
-\end_inset
-
- is the same as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Item_Environment
-\end_layout
-
-\end_inset
-
-, except that
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelWidthString
-\end_layout
-
-\end_inset
-
- is passed as an argument to the environment.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelWidthString
-\end_layout
-
-\end_inset
-
- can be defined in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\end_layout
-
-\end_inset
-
- dialog.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\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 Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InTitle
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-[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 PlainLayout
-TitleLatexType
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TitleLatexName
-\end_layout
-
-\end_inset
-
- global entries)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexName
-\end_layout
-
-\end_inset
-
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexParam
-\end_layout
-
-\end_inset
-
- The optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexName
-\end_layout
-
-\end_inset
-
- stuff.
- This parameter cannot be changed from within LyX.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-OptionalArgs
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-int=0
-\end_layout
-
-\end_inset
-
-] The number of optional arguments that can be used with this layout.
- This is useful for things like section headings, and only makes sense with
- LaTeX.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Margin
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
-\end_layout
-
-\end_inset
-
-]
-\newline
-The kind of margin that the layout has on the left side.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Static
-\end_layout
-
-\end_inset
-
- just means a fixed margin.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Manual
-\end_layout
-
-\end_inset
-
- means that the left margin depends on the string entered in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\begin_inset Space ~
-\end_inset
-
-Settings
-\end_layout
-
-\end_inset
-
- dialog.
- This is used to typeset nice lists without tabulators.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Dynamic
-\end_layout
-
-\end_inset
-
- means that the margin depends on the size of the label.
- This is used for automatic enumerated headlines.
- It is obvious that the headline
-\begin_inset Quotes eld
-\end_inset
-
-5.4.3.2.1 Very long headline
-\begin_inset Quotes erd
-\end_inset
-
- must have a wider left margin (as wide as
-\begin_inset Quotes eld
-\end_inset
-
-5.4.3.2.1
-\begin_inset Quotes erd
-\end_inset
-
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
-
-3.2 Very long headline
-\begin_inset Quotes erd
-\end_inset
-
-, even if other word processors are not able to do this.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-First_Dynamic
-\end_layout
-
-\end_inset
-
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Right_Address_Box
-\end_layout
-
-\end_inset
-
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NextNoIndent
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-1,
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\end_layout
-
-\end_inset
-
-] Whether the following Paragraph is allowed to indent its very first row.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-1
-\end_layout
-
-\end_inset
-
- means that it is not allowed to do so,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-0
-\end_layout
-
-\end_inset
-
- means it could do so if it wants to.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ParIndent
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] The indent of the very first line of a paragraph.
- The argument is passed as a string.
- For example
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"MM"
-\end_layout
-
-\end_inset
-
- means that the paragraph is indented with the width of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"MM"
-\end_layout
-
-\end_inset
-
- in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-the
-\end_layout
-
-\end_inset
-
- normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"-"
-\end_layout
-
-\end_inset
-
-.
- This way was chosen so that the look is the same with each used screen
- font.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Parindent
-\end_layout
-
-\end_inset
-
- will be fixed for a certain layout.
- The exception is Standard layout, since the indentation of a Standard layout
- paragraph can be prohibited with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NextNoIndent
-\end_layout
-
-\end_inset
-
-.
- Also, Standard layout paragraphs inside environments use the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Parindent
-\end_layout
-
-\end_inset
-
- of the environment, not their native one.
- For example, Standard paragraphs inside an enumeration are not indented.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Parskip
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float=0
-\end_layout
-
-\end_inset
-
-] LyX allows to choose either
-\begin_inset Quotes eld
-\end_inset
-
-indent
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
-
-indent
-\begin_inset Quotes erd
-\end_inset
-
- is chosen, this value is completely ignored.
- When
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- is chosen, the parindent of a LaTeXtype
-\begin_inset Quotes eld
-\end_inset
-
-Paragraph
-\begin_inset Quotes erd
-\end_inset
-
- layout is ignored and all paragraphs are additionally separated by this
- parskip argument.
- The vertical space is calculated with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-value*DefaultHeight()
-\end_layout
-
-\end_inset
-
- where
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-DefaultHeight()
-\end_layout
-
-\end_inset
-
- is the height of a row with the normal font.
- This way, the look stays the same with different screen fonts.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TopSep
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float=0
-\end_layout
-
-\end_inset
-
-] The vertical space with which the very first of a chain of paragraphs
- with this layout is separated from the previous paragraph.
- If the previous paragraph has another layout, the separations are not simply
- added, but the maximum is taken.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-BottomSep
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float=0
-\end_layout
-
-\end_inset
-
-] The same as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TopSep
-\end_layout
-
-\end_inset
-
- for the very last paragraph.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Parsep
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float=0
-\end_layout
-
-\end_inset
-
-] The vertical space between two paragraphs of this layout.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Itemsep
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float=0
-\end_layout
-
-\end_inset
-
-] This is an extra space between the paragraphs of an environment 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 PlainLayout
-Parsep
-\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 PlainLayout
-Itemsep
-\end_layout
-
-\end_inset
-
-.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LeftMargin
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] If you put layouts into environments, the leftmargins are not simply added,
- but added with a factor
-\begin_inset Formula $\frac{4}{depth+4}$
-\end_inset
-
-.
- Note that this parameter is also used when the border is defined as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Manual
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Dynamic
-\end_layout
-
-\end_inset
-
-.
- Then it is added to the manual or dynamic border.
- This string has the same meaning as for
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ParIndent
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-RightMargin
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] Similar to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LeftMargin
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Labeltype
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment,
-\newline
-Centered_Top_Environment, Sensitive,
- Counter
-\end_layout
-
-\end_inset
-
-]
-\newline
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Manual
-\end_layout
-
-\end_inset
-
- means the label is the very first word (up to the first real blank).
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Static
-\end_layout
-
-\end_inset
-
- means it is defined in the layout (see
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
-).
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Top_Environment
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Centered_Top_Environment
-\end_layout
-
-\end_inset
-
- are special cases of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Static
-\end_layout
-
-\end_inset
-
-.
- The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this layout.
- Usage is for example the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Abstract
-\end_layout
-
-\end_inset
-
- layout or the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Bibliography
-\end_layout
-
-\end_inset
-
- layout.
- This is also the case for
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Manual
-\end_layout
-
-\end_inset
-
- labels with latex type
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Environment
-\end_layout
-
-\end_inset
-
-, in order to make layouts for theorems work correctly.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-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
-
-Table
-\begin_inset Quotes erd
-\end_inset
-
-.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Sensitive
-\end_layout
-
-\end_inset
-
- means the (hardcoded) label string depends on the kind of float.
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Counter
-\end_layout
-
-\end_inset
-
- label type defines automatically numbered labels.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelCounter
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-]
-\newline
-The name of the counter for automatic numbering (see Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
-
-\end_inset
-
- for details).
- This must be given if
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Labeltype
-\end_layout
-
-\end_inset
-
- is
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Counter
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Labelsep
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] The horizontal space between the label and the text body.
- Only used for labels that are not above the text body.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelBottomsep
-\end_layout
-
-\end_inset
-
- [float=0] The vertical space between the label and the text body.
- Only used for labels that are above the text body (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Top_Environment
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Centered_Top_Environment
-\end_layout
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] The string used for a label with a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Static
-\end_layout
-
-\end_inset
-
- labeltype.
- When the border is
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Manual
-\end_layout
-
-\end_inset
-
- this string is also used as a suggestion for the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelWidthString
-\end_layout
-
-\end_inset
-
- that can be set in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\begin_inset Space ~
-\end_inset
-
-Settings
-\end_layout
-
-\end_inset
-
- dialog.
- When
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelCounter
-\end_layout
-
-\end_inset
-
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
-
-\end_inset
-
-.
- For the sake of backwards compatibility, the string
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-@
-\emph on
-style-name
-\emph default
-@
-\end_layout
-
-\end_inset
-
- will be replaced by the expanded
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
- of style
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-style-name
-\end_layout
-
-\end_inset
-
-.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelStringAppendix
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] This is used inside the appendix instead of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
-.
- Note that every
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
- statement resets
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelStringAppendix
-\end_layout
-
-\end_inset
-
- too.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\series medium
-TocLevel [int]
-\end_layout
-
-\end_inset
-
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-EndLabeltype
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-No_Label
-\emph default
-, Box, Filled_Box, Static
-\end_layout
-
-\end_inset
-
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexType
-\end_layout
-
-\end_inset
-
- is
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Environment
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Item_Environment
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-List_Environment
-\end_layout
-
-\end_inset
-
-).
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-No_Label
-\end_layout
-
-\end_inset
-
- means
-\begin_inset Quotes eld
-\end_inset
-
-nothing
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Box
-\end_layout
-
-\end_inset
-
- (resp.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-\begin_inset Space ~
-\end_inset
-
-Filled_Box
-\end_layout
-
-\end_inset
-
-) is a white (resp.
-\begin_inset Space ~
-\end_inset
-
-black) square suitable for end of proof markers,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Static
-\end_layout
-
-\end_inset
-
- is an explicit text string.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-EndLabelString
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string=""
-\end_layout
-
-\end_inset
-
-] The string used for a label with a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Static
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-EndLabelType
-\end_layout
-
-\end_inset
-
-.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Align
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-block
-\emph default
-, left, right, center
-\end_layout
-
-\end_inset
-
-] Paragraph alignment.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-AlignPossible
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-block
-\emph default
-, left, right, center
-\end_layout
-
-\end_inset
-
-] A comma separated
-\emph on
-list
-\emph default
- of possible aligns.
- Some LaTeX styles prohibit certain alignments, since those wouldn't make
- sense.
- For example a right-aligned or centered enumeration isn't possible.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Fill_Top
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] With this parameter the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-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 CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\begin_inset Space ~
-\end_inset
-
-Settings
-\end_layout
-
-\end_inset
-
- dialog can be set when initializing a paragraph with this layout
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-
-\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
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Fill_Bottom
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] Similar to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Fill_Top
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NeedProtect
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] Whether fragile commands in this layout should be
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-protect
-\end_layout
-
-\end_inset
-
-'ed.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Newline
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-0,
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-1
-\end_layout
-
-\end_inset
-
-] Whether newlines are translated into LaTeX newlines (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-
-\backslash
-
-\end_layout
-
-\end_inset
-
-) or not.
- The translation can be switched off to allow more comfortable LaTeX editing
- inside LyX.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-PassThru
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-, 1
-\end_layout
-
-\end_inset
-
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
- This somehow replaces the older
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Latex
-\end_layout
-
-\end_inset
-
- font property.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-FreeSpacing
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-, 1
-\end_layout
-
-\end_inset
-
-] Usually LyX doesn't allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example when typing
- program code or plain LaTeX code.
- For this reason,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-FreeSpacing
-\end_layout
-
-\end_inset
-
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-KeepEmpty
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\emph default
-, 1
-\end_layout
-
-\end_inset
-
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a layout can be used
- as some kind of break, which does not contain actual text.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Spacing
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-single
-\emph default
-, onehalf, double, other
-\end_layout
-
-\end_inset
-
-
-\emph on
-value
-\emph default
-] This defines what the default spacing should be in the layout.
- The arguments
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-single
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-onehalf
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-double
-\end_layout
-
-\end_inset
-
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-other
-\end_layout
-
-\end_inset
-
-, then you should also provide a numerical argument which will be the actual
- multiplier value.
- Note that, contrary to other parameters,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Spacing
-\end_layout
-
-\end_inset
-
- implies the generation of specific LaTeX code, using the package setspace.sty
-\family roman
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-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 "sec:fonts"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelFont
-\end_layout
-
-\end_inset
-
- to the same value.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TextFont
-\end_layout
-
-\end_inset
-
- The font used for the text body .
- See section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-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 "sec:fonts"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Preamble\SpecialChar \ldots{}
-EndPreamble
-\end_layout
-
-\end_inset
-
- A set of macro definitions that will be output at the beginning of the
- LaTeX files when the layout is used.
- Use this to define the macros needed by this particular layout.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Requires
-\end_layout
-
-\end_inset
-
-[
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-] Whether the layout requires the feature
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
- string
-\end_layout
-
-\end_inset
-
-.
- A feature is in general the name of a package (amsmath, makeidx, \SpecialChar \ldots{}
-) or a
- macro (url, boldsymbol,\SpecialChar \ldots{}
-).
- Multiple features must be separated by commas.
- Note that you can only request supported features; unfortunately, the complete
- list of supported features is not documented (however,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX Configuration
-\end_layout
-
-\end_inset
-
- gives an overview of the supported packages).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-DependsOn
-\end_layout
-
-\end_inset
-
- the name of a style which preamble should be output
-\emph on
-before
-\emph default
- the one mentionned above.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-Note that, besides that functionality, there is no way to ensure any ordering
- of preambles.
- The ordering that you see in a given version of LyX may change without
- warning in later versions.
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout PlainLayout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-Floats
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:floats"
-
-\end_inset
-
-Since version 1.3.0 of LyX, it is necessary to define the floats (
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-figure
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-table
-\end_layout
-
-\end_inset
-
-, \SpecialChar \ldots{}
-) in the text class itself.
- If you are looking here to learn how to upgrade an existing text class,
- it will probably turn out that all you have to do is to add
-\end_layout
-
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
-
-\begin_layout Standard
-at a reasonable location of the text class.
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-Don't forget to also have a look at counters in next section.
-\end_layout
-
-\end_inset
-
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with LyX), the information below will hopefully
- help you:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Type
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The
-\begin_inset Quotes eld
-\end_inset
-
-type
-\begin_inset Quotes erd
-\end_inset
-
- of the new class of floats, like program or algorithm.
- After the appropriate
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-newfloat
-\end_layout
-
-\end_inset
-
-, commands such as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-begin{program}
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-end{algorithm*}
-\end_layout
-
-\end_inset
-
- will be available.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-GuiName
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The string that will be used in the menus and also for the caption.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LaTeXBuiltin
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-0
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-1
-\end_layout
-
-\end_inset
-
-] Set to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-1
-\end_layout
-
-\end_inset
-
- if the float is already defined by the documentclass.
- If this is set to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-0
-\end_layout
-
-\end_inset
-
-, the float will be defined using the LaTeX package
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-float
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NumberWithin
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if within is equal to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-chapter
-\end_layout
-
-\end_inset
-
-, the floats will be numbered within chapters.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Style
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The style used when defining the float using
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-newfloat
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Placement
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The default placement for the given class of floats.
- They are like in standard LaTeX:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-t
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-b
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-p
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-h
-\end_layout
-
-\end_inset
-
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
-\end_layout
-
-\end_inset
-
- On top of that there is a new type,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-H
-\end_layout
-
-\end_inset
-
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
-\end_inset
-
-here
-\begin_inset Quotes erd
-\end_inset
-
- and nowhere else.
- Note, however that the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-H
-\end_layout
-
-\end_inset
-
- specifier is special and, because of implementation details cannot be used
- in non-builtin float types.
- If you do not understand what this means, just use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"tbp"
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Extension
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- LaTeX writes the captions to this file.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ListName
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The heading used for the list of floats.
-\end_layout
-
-\begin_layout Standard
-Note that defining a float with type
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-type
-\end_layout
-
-\end_inset
-
- automatically defines the corresponding counter with name
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-type
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-Inset layouts and Flex insets
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:charstyle"
-
-\end_inset
-
-You can define character styles since version 1.4.0 of LyX; since version
- 1.6.0 these are called Flex insets.
-
-\end_layout
-
-\begin_layout Standard
-Furthermore it is possible to define the general layout of many different
- types of insets.
- Currently layout parameters can be defined for footnotes, marginal notes,
- note insets, ERT insets, branch insets, and Flex insets.
- The latter are definable from the user GUI and come in three different
- kinds: character style (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-CharStyle
-\end_layout
-
-\end_inset
-
-) , user custom (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Custom
-\end_layout
-
-\end_inset
-
-), and XML element (
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Element
-\end_layout
-
-\end_inset
-
-) insets.
-
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InsetLayout
-\end_layout
-
-\end_inset
-
- definition starting line is of the form
-\end_layout
-
-\begin_layout LyX-Code
-InsetLayout <Type> <Name>
-\end_layout
-
-\begin_layout Standard
-where
-\end_layout
-
-\begin_layout Standard
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-<type>
-\end_layout
-
-\end_inset
-
- can be
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Foot, Margin, Note, Flex
-\end_layout
-
-\end_inset
-
-, and
-\end_layout
-
-\begin_layout Standard
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-<Name>
-\end_layout
-
-\end_inset
-
- can be empty (for foot- and marginal notes, branches and ERT) or one of
- types
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-CharStyle:Noun
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Note:Comment
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Custom:Endnote
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Element:Filename
-\end_layout
-
-\end_inset
-
-, etc.
- Here, the second part of the name can be chosen freely (for CharStyle,
- Custom and Element), or from a predefined list (for Note).
-\end_layout
-
-\begin_layout Standard
-The following
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InsetLayout
-\end_layout
-
-\end_inset
-
- section can contain the following entries:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LyxType
-\end_layout
-
-\end_inset
-
-can be
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-charstyle
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-custom
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-element
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-end
-\end_layout
-
-\end_inset
-
- (indicating a dummy definition ending definitions of charstyles etc.).
- This entry is only meaningful for Flex (user definable) insets, the three
- types of which are CharStyle, Custom and Element.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Decoration
-\end_layout
-
-\end_inset
-
- can be
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Classic
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
- Minimalistic or Conglomerate
-\end_layout
-
-\end_inset
-
-, describing the rendering style used for the inset's frame and buttons.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
- defines what will be displayed on the button or elsewhere as the inset
- label.
- Some inset types (ERT and Branch) modify this label on the fly.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-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 "sec:fonts"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelFont
-\end_layout
-
-\end_inset
-
- to the same value.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-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 "sec:fonts"
-
-\end_inset
-
-.
- Note that this definition can never appear before
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Font
-\end_layout
-
-\end_inset
-
-, lest it be ineffective (see above)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexName
-\end_layout
-
-\end_inset
-
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexParam
-\end_layout
-
-\end_inset
-
- The optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexName
-\end_layout
-
-\end_inset
-
- stuff, including possible bracket pairs like
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-[]
-\end_layout
-
-\end_inset
-
-.
- This parameter cannot be changed from within LyX.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LatexType
-\end_layout
-
-\end_inset
-
- See section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:style"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Preamble\SpecialChar \ldots{}
-EndPreamble
-\end_layout
-
-\end_inset
-
- See section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:style"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Requires
-\end_layout
-
-\end_inset
-
-[
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-] See section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:style"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-Counters
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:counter"
-
-\end_inset
-
-Since version 1.3.0 of LyX, it is necessary to define the counters (
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-chapter
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-figure
-\end_layout
-
-\end_inset
-
-, \SpecialChar \ldots{}
-) in the text class itself.
- If you are looking here to learn how to upgrade an existing text class,
- it will probably turn out that all you have to do is to add
-\end_layout
-
-\begin_layout LyX-Code
-Input stdcounters.inc
-\end_layout
-
-\begin_layout Standard
-The following parameters can be used:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Name
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The name of the counter.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Within
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] If this is set to the name of another counter, the present counter will
- be reset everytime the other one is increased.
- For example,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-subsection
-\end_layout
-
-\end_inset
-
- is numbered inside
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-section
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString [string=""]
-\end_layout
-
-\end_inset
-
- when this is defined, this string defines how the counter is displayed.
- Setting this value resets
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelStringAppendix
-\end_layout
-
-\end_inset
-
- to the same value.
- The following special constructs can be used in the string:
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-thecounter
-\end_layout
-
-\end_inset
-
- will be replaced by the expansion of the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
- (or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelStringAppendix
-\end_layout
-
-\end_inset
-
-) of the counter
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-counter
-\end_layout
-
-\end_inset
-
-.
- If these are empty, a default value is constructed as follows: if the counter
- has a master counter
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-master
-\end_layout
-
-\end_inset
-
-, the string
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
-\end_layout
-
-\end_inset
-
- is used; otherwise the string
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-arabic{counter}
-\end_layout
-
-\end_inset
-
- is used.
-\end_layout
-
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
-\end_layout
-
-\end_inset
-
-, where
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-numbertype
-\end_layout
-
-\end_inset
-
- can be:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-arabic
-\end_layout
-
-\end_inset
-
- to translate
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-counter
-\end_layout
-
-\end_inset
-
- to arabic numerals, like 1, 2, 3\SpecialChar \ldots{}
-
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated than that: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those descibed below will produce arabic numerals.
- It would not be surprising to see this change in the future.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-alph
-\end_layout
-
-\end_inset
-
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Alph
-\end_layout
-
-\end_inset
-
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-roman
-\end_layout
-
-\end_inset
-
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Roman
-\end_layout
-
-\end_inset
-
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-hebrew
-\end_layout
-
-\end_inset
-
- for hebrew numerals.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelStringAppendix [string=""]
-\end_layout
-
-\end_inset
-
- the same as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LabelString
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_inset
-
-, for use in appendix.
-\end_layout
-
-\begin_layout Subsection
-Font description
-\end_layout
-
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:fonts"
-
-\end_inset
-
-A font description looks like that:
-\end_layout
-
-\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-EndFont
-\end_layout
-
-\begin_layout Standard
-and the following commands are available:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Family
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-Roman
-\emph default
-, Sans, Typewriter
-\end_layout
-
-\end_inset
-
-]
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Series
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-Medium
-\emph default
-, Bold
-\end_layout
-
-\end_inset
-
-]
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Shape
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-Up
-\emph default
-, Italic, SmallCaps, Slanted
-\end_layout
-
-\end_inset
-
-]
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Size
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tiny, small,
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-normal
-\emph default
-, large, larger, largest, huge, giant
-\end_layout
-
-\end_inset
-
-]
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Color
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-none
-\emph default
-, black, white, red, green, blue, cyan, magenta, yellow
-\end_layout
-
-\end_inset
-
-]
-\end_layout
-
-\begin_layout Subsection
-Upgrading old layout files
-\end_layout
-
-\begin_layout Standard
-The file format of layout files changes from time to time, so old layout
- files need to be converted.
- This process has been automated in LyX 1.4.0: If LyX reads an old format
- layout file it will call the conversion tool
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$LyXDir/scripts/layout2layout.py
-\end_layout
-
-\end_inset
-
- and convert it to a temporary file in current format.
- The original file is left untouched, so that you can still use it with
- LyX 1.3.x.
- If you want to convert the layout file permanently, just call the converter
- by hand:
-\end_layout
-
-\begin_layout LyX-Code
-python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
-\end_layout
-
-\begin_layout Standard
-Then copy
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-myclassnew.layout
-\end_layout
-
-\end_inset
-
- to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$UserDir/layouts/
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-The automatic conversion does only handle syntax changes.
- It cannot handle the case where the contents of included files was changed.
- For example, layout files based on
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-book.layout
-\end_layout
-
-\end_inset
-
- need to include
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-numreport.inc
-\end_layout
-
-\end_inset
-
- in addition to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-stdclass.inc
-\end_layout
-
-\end_inset
-
-.
- If you get error messages about undefined counters, try to convert your
- file with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout2layout.py
-\end_layout
-
-\end_inset
-
- and then add one of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-numarticle.inc
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-numreport.inc
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-numrevtex.inc
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Section
-Creating Templates
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:templates"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Templates are created just like usual documents.
- The only difference is that usual documents contain all possible settings,
- including the fontscheme and the papersize.
- Usually a user doesn't want a template to overwrite his defaults in these
- cases.
- For that reason, the designer of a template should remove the corresponding
- commands like
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-fontscheme
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-papersize
-\end_layout
-
-\end_inset
-
- from the template LyX file.
- This can be done with any simple text-editor, for example
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vi
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xedit
-\end_layout
-
-\end_inset
-
-.
-
-\end_layout
-
-\begin_layout Standard
-Put the edited template files you create in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$UserDir/templates/
-\end_layout
-
-\end_inset
-
-, copy the ones you use from the global template directory in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$LyXDir/templates/
-\end_layout
-
-\end_inset
-
- to the same place, and redefine the template path in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
-\end_layout
-
-\end_inset
-
- dialog (tabs
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Input
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Path
-\end_layout
-
-\end_inset
-
-).
-
-\end_layout
-
-\begin_layout Standard
-Note that there is a template which has a particular meaning:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-defaults.lyx
-\end_layout
-
-\end_inset
-
-.
- This template is loaded everytime you create a new document with
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-F
-\bar default
-ile
-\end_layout
-
-\end_inset
-
-\SpecialChar \menuseparator
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-N
-\bar default
-ew
-\end_layout
-
-\end_inset
-
- in order to provide useful defaults.
- To create this template from inside LyX, all you have to do is to open
- a document with the correct settings, and use the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Sa
-\bar under
-v
-\bar default
-e as Document Defaults
-\end_layout
-
-\end_inset
-
- button.
-\end_layout
-
-\begin_layout Chapter
-Including External Material
-\end_layout
-
-\begin_layout Section
-Background
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Note
-status collapsed
-
-\begin_layout PlainLayout
-This section is completely outdated.
-\end_layout
-
-\end_inset
-
-One often requested feature from LyX users is to be able to interface LyX
- with Xfig, Dia, or other similar applications that specialize in producing
- a certain kind of diagram, figure, schematic or whatever material might
- be relevant to include in your document.
- Previously, it was only possible to include boring, static, fixed images
- in LyX documents with the graphics feature, but there are several limitations
- attached to this approach:
-\end_layout
-
-\begin_layout Itemize
-If you want to change the figure, you have to invoke an external program
- by hand
-\end_layout
-
-\begin_layout Itemize
-LyX does not notice that the referenced files change, so the on-screen display
- can fast become obsolete, and this is aggravated by the lack of a means
- of updating the display
-\end_layout
-
-\begin_layout Itemize
-The graphics stuff does not provide any mechanisms for coping with different
- exported formats such as DocBook, HTML or plain text
-\end_layout
-
-\begin_layout Standard
-The external material facility attempts to solve all of these problems
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-Even if the graphics facility can't solve all problems, it is still valuable
- because it does provide in-line preview of the graphics, and supports advanced
- geometric transformations with a comfortable user interface.
-\end_layout
-
-\end_inset
-
-.
- It does this by offering a general method to interface LyX to external
- applications.
- Instead of introducing a long list of different constructs tailored for
- each specific application, we chose to sacrifice the in-line displaying
- of the included material in order to provide a general construct to cover
- a wide range of applications.
- The result is the external material construct.
- External material presents itself in the document simply as a button, but
- don't let this fool you.
- When you click on it, a dialog will appear that allows you to chose exactly
- what material to include, and in the following sections you will learn
- that this is indeed a powerful mechanism that can solve all of the above
- problems, and more.
-\end_layout
-
-\begin_layout Section
-How does it work?
-\end_layout
-
-\begin_layout Standard
-The external material feature is based on the concept of a
-\emph on
-template
-\emph default
-.
- A template is a specification of how LyX should interface with a certain
- kind of material.
- As bundled, LyX comes with predefined templates for Xfig figures, Dia diagrams,
- various raster format images, gnuplot, and more.
- You can check the actual list by using the menu
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
-External
-\end_layout
-
-\end_inset
-
-
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Material
-\end_layout
-
-\end_inset
-
-.
- Furthermore, it is possible to roll your own template to support a specific
- kind of material.
- Later we'll describe in more detail what is involved, and hopefully you
- will submit all the templates you create so we can include them in a later
- LyX version.
-\end_layout
-
-\begin_layout Standard
-Another basic idea of the external material feature is to distinguish between
- the original file that serves as a base for final material and the produced
- file that is included in your exported or printed document.
- For example, consider the case of a figure produced with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Xfig
-\end_layout
-
-\end_inset
-
-.
- The Xfig application itself works on an original file with the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.fig
-\end_layout
-
-\end_inset
-
- extension.
- Within XFig, you create and change your figure, and when you are done,
- you save the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-fig
-\end_layout
-
-\end_inset
-
--file.
- When you want to include the figure in your document, you invoke
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-transfig
-\end_layout
-
-\end_inset
-
- in order to create a PostScript file that can readily be included in your
- LaTeX file.
- In this case, the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.fig
-\end_layout
-
-\end_inset
-
- file is the original file, and the PostScript file is the produced file.
-\end_layout
-
-\begin_layout Standard
-This distinction is important in order to allow updating of the material
- while you are in the process of writing the document.
- Furthermore, it provides us with the flexibility that is needed to support
- 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,
- 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 parameter
-ized on the different export formats that LyX supports.
-\end_layout
-
-\begin_layout Standard
-Besides supporting the production of different products according to the
- exported format, it supports tight integration with editing and viewing
- applications.
- In the case of an XFig figure, you are able to invoke
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Xfig
-\end_layout
-
-\end_inset
-
- on the original file with a single click from within the external material
- dialog in LyX, and also preview the produced PostScript file with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ghostview
-\end_layout
-
-\end_inset
-
- with another click.
- No more fiddling around with the command line and/or file browsers to locate
- and manipulate the original or produced files.
- In this way, you are finally able to take full advantage of the many different
- applications that are relevant to use when you write your documents, and
- ultimately be more productive.
-\end_layout
-
-\begin_layout Section
-External material dialog
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-External Material
-\end_layout
-
-\end_inset
-
- dialog is described in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\emph on
-EmbeddedObjects
-\end_layout
-
-\end_inset
-
- manual.
-\end_layout
-
-\begin_layout Section
-Examples
-\end_layout
-
-\begin_layout Standard
-In this section, we should include some examples of use of the external
- material.
- Those examples could include:
-\end_layout
-
-\begin_layout Itemize
-External raster images
-\end_layout
-
-\begin_layout Itemize
-External XFig figures
-\end_layout
-
-\begin_layout Itemize
-Chess diagrams
-\end_layout
-
-\begin_layout Itemize
-Sound samples
-\end_layout
-
-\begin_layout Itemize
-The use of makefiles
-\end_layout
-
-\begin_layout Itemize
-Recursive external LyX templates
-\end_layout
-
-\begin_layout Section
-The external template configuration file
-\end_layout
-
-\begin_layout Standard
-It is relatively easy to add custom external template definitions to LyX.
- However, be aware this doing this in an careless manner most probably
-\emph on
-will
-\emph default
- introduce an easily exploitable security hole.
- So before you do this, please read the discussion about security which
- will follow later.
-\end_layout
-
-\begin_layout Standard
-Having said that, we encourage you to submit any interesting templates that
- you create.
-
-\end_layout
-
-\begin_layout Standard
-The external templates are defined in the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lib/external_templates
-\end_layout
-
-\end_inset
-
- file.
- You can place your own version in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.lyx/external_templates
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-A typical template looks like this:
-\end_layout
-
-\begin_layout LyX-Code
-Template XFig
-\end_layout
-
-\begin_layout LyX-Code
-GuiName "XFig: $$AbsOrRelPathParent$$Basename"
-\end_layout
-
-\begin_layout LyX-Code
-HelpText
-\end_layout
-
-\begin_layout LyX-Code
-An XFig figure.
-\end_layout
-
-\begin_layout LyX-Code
-HelpTextEnd
-\end_layout
-
-\begin_layout LyX-Code
-InputFormat fig
-\end_layout
-
-\begin_layout LyX-Code
-FileFilter "*.fig"
-\end_layout
-
-\begin_layout LyX-Code
-AutomaticProduction true
-\end_layout
-
-\begin_layout LyX-Code
-Transform Rotate
-\end_layout
-
-\begin_layout LyX-Code
-Transform Resize
-\end_layout
-
-\begin_layout LyX-Code
-Format LaTeX
-\end_layout
-
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
-\end_layout
-
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
-\end_layout
-
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pstex_t}
-\end_layout
-
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
-\end_layout
-
-\begin_layout LyX-Code
-UpdateFormat pstex
-\end_layout
-
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pstex_t"
-\end_layout
-
-\begin_layout LyX-Code
-Requirement "graphicx"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.eps"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile dvi "$$AbsPath$$Basename.eps"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
-\begin_layout LyX-Code
-Format PDFLaTeX
-\end_layout
-
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
-\end_layout
-
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
-\end_layout
-
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
-\end_layout
-
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
-\end_layout
-
-\begin_layout LyX-Code
-UpdateFormat pdftex
-\end_layout
-
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pdftex_t"
-\end_layout
-
-\begin_layout LyX-Code
-Requirement "graphicx"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.pdf"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
-\begin_layout LyX-Code
-Format Ascii
-\end_layout
-
-\begin_layout LyX-Code
-Product "$$Contents(
-\backslash
-"$$AbsPath$$Basename.asc
-\backslash
-")"
-\end_layout
-
-\begin_layout LyX-Code
-UpdateFormat asciixfig
-\end_layout
-
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.asc"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
-\begin_layout LyX-Code
-Format DocBook
-\end_layout
-
-\begin_layout LyX-Code
-Product "<graphic fileref=
-\backslash
-"$$AbsOrRelPathMaster$$Basename.eps
-\backslash
-">
-\end_layout
-
-\begin_layout LyX-Code
- </graphic>"
-\end_layout
-
-\begin_layout LyX-Code
-UpdateFormat eps
-\end_layout
-
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.eps"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile docbook "$$AbsPath$$Basename.eps"
-\end_layout
-
-\begin_layout LyX-Code
-ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
-\begin_layout LyX-Code
-Product "[XFig: $$FName]"
-\end_layout
-
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
-
-\begin_layout LyX-Code
-TemplateEnd
-\end_layout
-
-\begin_layout Standard
-As you can see, the template is enclosed in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Template
-\end_layout
-
-\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TemplateEnd
-\end_layout
-
-\end_inset
-
-.
- It contains a header specifying some general settings, and for each supported
- primary document file format a section
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Format
-\end_layout
-
-\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-FormatEnd
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-The template header
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Template
-\begin_inset Space ~
-\end_inset
-
-<id>
-\end_layout
-
-\end_inset
-
- A unique name for the template.
- It must not contain substitution macros (see below).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-GuiName
-\begin_inset Space ~
-\end_inset
-
-<guiname>
-\end_layout
-
-\end_inset
-
- The text that is displayed on the button.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-HelpText
-\begin_inset Space ~
-\end_inset
-
-<text>
-\begin_inset Space ~
-\end_inset
-
-HelpTextEnd
-\end_layout
-
-\end_inset
-
- The help text that is used in the External dialog.
- Provide enough information to explain to the user just what the template
- can provide him with.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-InputFormat
-\begin_inset Space ~
-\end_inset
-
-<format>
-\end_layout
-
-\end_inset
-
- The file format of the original file.
- This must be the name of a format that is known to LyX (see the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references:Conversion
-\end_layout
-
-\end_inset
-
- dialog).
- Use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"*"
-\end_layout
-
-\end_inset
-
- if the template can handle original files of more than one format.
- LyX will attempt to interrogate the file itself in order to deduce its
- format in this case.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-FileFilter
-\begin_inset Space ~
-\end_inset
-
-<pattern>
-\end_layout
-
-\end_inset
-
- A glob pattern that is used in the file dialog to filter out the desired
- files.
- If there is more than one possible file extension (e.g.
-\begin_inset Space ~
-\end_inset
-
-tgif has
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.obj
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.tgo
-\end_layout
-
-\end_inset
-
-), use something like
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"*.{obj,tgo}"
-\end_layout
-
-\end_inset
-
-.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-AutomaticProduction
-\begin_inset Space ~
-\end_inset
-
-true|false
-\end_layout
-
-\end_inset
-
- Wether the file represented by the template must be generated by LyX.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Transform
-\begin_inset Space ~
-\end_inset
-
-Rotate|Resize|Clip|Extra
-\end_layout
-
-\end_inset
-
- This command specifies which transformations are supported by this template.
- It may occur zero or more times.
- This command enables the corresponding tabs in the external dialog.
- Each
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Transform
-\end_layout
-
-\end_inset
-
- command must have either a corresponding
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformCommand
-\end_layout
-
-\end_inset
-
- or a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformOption
-\end_layout
-
-\end_inset
-
- command in the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Format
-\end_layout
-
-\end_inset
-
- section.
- Otherwise the transformation will not be supported by that format.
-\end_layout
-
-\begin_layout Subsection
-The Format section
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Format
-\begin_inset Space ~
-\end_inset
-
-LaTeX|PDFLaTeX|PlainText|DocBook
-\end_layout
-
-\end_inset
-
- The primary document file format that this format definition is for.
- Not every template has a sensible representation in all document file formats.
- Please define nevertheless a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Format
-\end_layout
-
-\end_inset
-
- section for all formats.
- 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.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformCommand
-\begin_inset Space ~
-\end_inset
-
-Rotate
-\begin_inset Space ~
-\end_inset
-
-RotationLatexCommand
-\end_layout
-
-\end_inset
-
- This command specifies that the built in LaTeX command should be used for
- rotation.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformCommand
-\begin_inset Space ~
-\end_inset
-
-Resize
-\begin_inset Space ~
-\end_inset
-
-ResizeLatexCommand
-\end_layout
-
-\end_inset
-
- This command specifies that the built in LaTeX command should be used for
- resizing.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformOption
-\begin_inset Space ~
-\end_inset
-
-Rotate
-\begin_inset Space ~
-\end_inset
-
-RotationLatexOption
-\end_layout
-
-\end_inset
-
- This command specifies that rotation is done via an optional argument.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformOption
-\begin_inset Space ~
-\end_inset
-
-Resize
-\begin_inset Space ~
-\end_inset
-
-ResizeLatexOption
-\end_layout
-
-\end_inset
-
- This command specifies that resizing is done via an optional argument.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformOption
-\begin_inset Space ~
-\end_inset
-
-Clip
-\begin_inset Space ~
-\end_inset
-
-ClipLatexOption
-\end_layout
-
-\end_inset
-
- This command specifies that clipping is done via an optional argument.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformOption
-\begin_inset Space ~
-\end_inset
-
-Extra
-\begin_inset Space ~
-\end_inset
-
-ExtraLatexOption
-\end_layout
-
-\end_inset
-
- This command specifies that an extra optional argument is used.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Product
-\begin_inset Space ~
-\end_inset
-
-<text>
-\end_layout
-
-\end_inset
-
- The text that is inserted in the exported document.
- This is actually the most important command and can be quite complex.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-UpdateFormat
-\begin_inset Space ~
-\end_inset
-
-<format>
-\end_layout
-
-\end_inset
-
- The file format of the converted file.
- This must be the name of a format that is known to LyX (see the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references:Conversion
-\end_layout
-
-\end_inset
-
- dialog).
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-UpdateResult
-\begin_inset Space ~
-\end_inset
-
-<filename>
-\end_layout
-
-\end_inset
-
- The file name of the converted file.
- The file name must be absolute.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ReferencedFile
-\begin_inset Space ~
-\end_inset
-
-<format>
-\begin_inset Space ~
-\end_inset
-
-<filename>
-\end_layout
-
-\end_inset
-
- This command denotes files that are created by the conversion process and
- are needed for a particular export format.
- If the filename is relative, it is interpreted relative to the master document.
- This command may be given zero or more times.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Requirement
-\begin_inset Space ~
-\end_inset
-
-<package>
-\end_layout
-
-\end_inset
-
- The name of a required LaTeX package.
- The package is included via
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-
-\backslash
-usepackage{}
-\end_layout
-
-\end_inset
-
- in the LaTeX preamble.
- This command may occur zero or more times.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Preamble
-\begin_inset Space ~
-\end_inset
-
-<name>
-\end_layout
-
-\end_inset
-
- This command specifies a preamble snippet that will be included in the
- LaTeX preamble.
- It has to be defined using
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-PreambleDef
-\end_layout
-
-\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-PreambleDefEnd
-\end_layout
-
-\end_inset
-
-.
- This command may occur zero or more times.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Option
-\begin_inset Space ~
-\end_inset
-
-<name>
-\begin_inset Space ~
-\end_inset
-
-<value>
-\end_layout
-
-\end_inset
-
- This command defines an additional macro
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$<name>
-\end_layout
-
-\end_inset
-
- for substitution in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Product
-\end_layout
-
-\end_inset
-
-.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-<value>
-\end_layout
-
-\end_inset
-
- itself may contain substitution macros.
- The advantage over using
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-<value>
-\end_layout
-
-\end_inset
-
- directly in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Product
-\end_layout
-
-\end_inset
-
- is that the substituted value of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$<name>
-\end_layout
-
-\end_inset
-
- is sanitized so that it is a valid optional argument in the document format.
- This command may occur zero or more times.
-\end_layout
-
-\begin_layout Subsection
-Preamble definitions
-\end_layout
-
-\begin_layout Standard
-The external template configuration file may contain additional preamble
- definitions enclosed by
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-PreambleDef
-\end_layout
-
-\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-PreambleDefEnd
-\end_layout
-
-\end_inset
-
-.
- They can be used by the templates in the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Format
-\end_layout
-
-\end_inset
-
- section.
-\end_layout
-
-\begin_layout Section
-The substitution mechanism
-\end_layout
-
-\begin_layout Standard
-When the external material facility invokes an external program, it is done
- on the basis of a command defined in the template configuration file.
- These commands can contain various macros that are expanded before execution.
- Execution always take place in the directory of the containing document.
-\end_layout
-
-\begin_layout Standard
-Also, whenever external material is to be displayed, the name will be produced
- by the substitution mechanism, and most other commands in the template
- definition support substitution as well.
-\end_layout
-
-\begin_layout Standard
-The available macros are the following:
-\end_layout
-
-\begin_layout Description
-$$FName The filename of the file specified in the external material dialog.
- This is either an absolute name, or it is relative to the LyX document.
-\end_layout
-
-\begin_layout Description
-$$Basename The filename without path and without the extension.
-\end_layout
-
-\begin_layout Description
-$$Extension The file extension (including the dot).
-\end_layout
-
-\begin_layout Description
-$$FPath The path part of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$FName
-\end_layout
-
-\end_inset
-
- (absolute name or relative to the LyX document).
-\end_layout
-
-\begin_layout Description
-$$AbsPath The absolute file path.
-\end_layout
-
-\begin_layout Description
-$$RelPathMaster The file path, relative to the master LyX document.
-\end_layout
-
-\begin_layout Description
-$$RelPathParent The file path, relative to the LyX document.
-\end_layout
-
-\begin_layout Description
-$$AbsOrRelPathMaster The file path, absolute or relative to the master LyX
- document.
-\end_layout
-
-\begin_layout Description
-$$AbsOrRelPathParent The file path, absolute or relative to the LyX document.
-\end_layout
-
-\begin_layout Description
-$$Tempname A name and full path to a temporary file which will be automatically
- deleted whenever the containing document is closed, or the external material
- insertion deleted.
-\end_layout
-
-\begin_layout Description
-$$Contents(
-\begin_inset Quotes eld
-\end_inset
-
-filename.ext
-\begin_inset Quotes erd
-\end_inset
-
-) This macro will expand to the contents of the file with the name
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-filename.ext
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-$$Sysdir This macro will expand to the absolute path of the system directory.
- This is typically used to point to the various helper scripts that are
- bundled with LyX.
-\end_layout
-
-\begin_layout Standard
-All path macros contain a trailing directory separator, so you can construct
- e.g.
- the absolute filename with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$AbsPath$$Basename$$Extension
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-The macros above are substituted in all commands unless otherwise noted.
- The command
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Product
-\end_layout
-
-\end_inset
-
- supports additionally the following substitutions if they are enabled by
- the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Transform
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformCommand
-\end_layout
-
-\end_inset
-
- commands:
-\end_layout
-
-\begin_layout Description
-$$ResizeFront The front part of the resize command.
-\end_layout
-
-\begin_layout Description
-$$ResizeBack The back part of the resize command.
-\end_layout
-
-\begin_layout Description
-$$RotateFront The front part of the rotation command.
-\end_layout
-
-\begin_layout Description
-$$RotateBack The back part of the rotation command.
-\end_layout
-
-\begin_layout Standard
-The value string of the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Option
-\end_layout
-
-\end_inset
-
- command supports additionally the following substitutions if they are enabled
- by the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Transform
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TransformOption
-\end_layout
-
-\end_inset
-
- commands:
-\end_layout
-
-\begin_layout Description
-$$Clip The clip option.
-\end_layout
-
-\begin_layout Description
-$$Extra The extra option.
-\end_layout
-
-\begin_layout Description
-$$Resize The resize option.
-\end_layout
-
-\begin_layout Description
-$$Rotate The rotation option.
-\end_layout
-
-\begin_layout Standard
-You may ask why there are so many path macros.
- There are mainly two reasons:
-\end_layout
-
-\begin_layout Standard
-First, relative and absolute file names should remain relative or absolute,
- respectively.
- Users may have reasons to prefer either form.
- Relative names are useful for portable documents that should work on different
- machines, for example.
- Absolute names may be required by some programs.
-\end_layout
-
-\begin_layout Standard
-Second, LaTeX treats relative file names differently than LyX and other
- programs in nested included files.
- For LyX, a relative file name is always relative to the document that contains
- the file name.
- For LaTeX, it is always relative to the master document.
- These two definitions are identical if you have only one document, but
- differ if you have a master document that includes part documents.
- That means that relative filenames must be transformed when presented to
- LaTeX.
- Fortunately LyX does this automatically for you if you choose the right
- macros.
-\end_layout
-
-\begin_layout Standard
-So which path macro should be used in new template definitions? The rule
- is not difficult:
-\end_layout
-
-\begin_layout Itemize
-Use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$AbsPath
-\end_layout
-
-\end_inset
-
- if an absolute path is required.
-\end_layout
-
-\begin_layout Itemize
-Use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$AbsOrRelPathMaster
-\end_layout
-
-\end_inset
-
- if the substituted string is some kind of LaTeX input.
-\end_layout
-
-\begin_layout Itemize
-Else use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-$$AbsOrRelPathParent
-\end_layout
-
-\end_inset
-
- in order to preserve the user's choice.
-\end_layout
-
-\begin_layout Standard
-There are special cases where this rule does not work and e.g.
-\begin_inset Space ~
-\end_inset
-
-relative names are needed, but normally it will work just fine.
- One example for such a case is the command
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
-\end_layout
-
-\end_inset
-
- in the XFig template above: We can't use the absolute name because the
- copier for
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.pstex_t
-\end_layout
-
-\end_inset
-
- files needs the relative name in order to rewrite the file content.
-\end_layout
-
-\begin_layout Section
-Security discussion
-\end_layout
-
-\begin_layout Standard
-\begin_inset Note Note
-status collapsed
-
-\begin_layout PlainLayout
-This section is outdated
-\end_layout
-
-\end_inset
-
-The external material feature interfaces with a lot of external programs
- and does so automatically, so we have to consider the security implications
- of this.
- In particular, since you have the option of including your own filenames
- and/or parameter strings and those are expanded into a command, it seems
- that it would be possible to create a malicious document which executes
- arbitrary commands when a user views or prints the document.
- This is something we definately want to avoid.
-\end_layout
-
-\begin_layout Standard
-However, since the external program commands are specified in the template
- configuration file only, there are no security issues if LyX is properly
- configured with safe templates only.
- This is so because the external programs are invoked with the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-execvp
-\end_layout
-
-\end_inset
-
--system call rather than the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-system
-\end_layout
-
-\end_inset
-
- system-call, so it's not possible to execute arbitrary commands from the
- filename or parameter section via the shell.
-\end_layout
-
-\begin_layout Standard
-This also implies that you are restricted in what command strings you can
- use in the external material templates.
- In particular, pipes and redirection are not readily available.
- This has to be so if LyX should remain safe.
- If you want to use some of the shell features, you should write a safe
- script to do this in a controlled manner, and then invoke the script from
- the command string.
- In the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lib/scripts
-\end_layout
-
-\end_inset
-
- directory of the LyX installation, you can find a safe wrapper script
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-general_command_wrapper.py
-\end_layout
-
-\end_inset
-
- that supports redirection of input and output.
- That can serve as an example for how to write safe template scripts.
- For a more advanced example that uses
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-fork
-\end_layout
-
-\end_inset
-
- and friends, take a look at the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-pic2ascii.py
-\end_layout
-
-\end_inset
-
- converter script.
-\end_layout
-
-\begin_layout Standard
-It is possible to design a template that interacts directly with the shell,
- but since this would allow a malicious user to execute arbitrary commands
- by writing clever filenames and/or parameters, we generally recommend that
- you only use safe scripts that work with the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-execvp
-\end_layout
-
-\end_inset
-
- system call in a controlled manner.
- Of course, for use in a controlled environment, it can be tempting to just
- fall back to use ordinary shell scripts.
- If you do so, be aware that you
-\emph on
-will
-\emph default
- provide an easily exploitable security hole in your system.
- Of course it stands to reason that such unsafe templates will never be
- included in the standard LyX distribution, although we do encourage people
- to submit new templates in the open source tradition.
- But LyX as shipped from the official distribution channels will never have
- unsafe templates.
-\end_layout
-
-\begin_layout Standard
-Including external material provides a lot of power, and you have to be
- careful not to introduce security hazards with this power.
- A subtle error in a single line in an innocent looking script can open
- the door to huge security problems.
- So if you do not fully understand the issues, we recommend that you consult
- a knowledgable security professional or the LyX development team if you
- have any questions about whether a given template is safe or not.
- And do this before you use it in an uncontrolled environment.
-\end_layout
-
-\begin_layout Chapter
-The LyX Server
-\end_layout
-
-\begin_layout Section
-Introduction
-\end_layout
-
-\begin_layout Standard
-The LyX server is a method implemented in LyX that will enable other programs
- to talk to LyX, invoke LyX commands, and retrieve information about the
- LyX internal state.
- This is only intended for advanced users, but they should find it useful.
- Please note that, at present,
-\emph on
-the server does not work on Windows
-\emph default
-.
-\end_layout
-
-\begin_layout Section
-Starting the LyX Server
-\end_layout
-
-\begin_layout Standard
-The LyX server works through the use of a pair of named pipes.
- These are usually located in your home directory and have the names
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.lyxpipe.in
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.lyxpipe.out
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- External programs write into
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.lyxpipe.in
-\end_layout
-
-\end_inset
-
- and read back data from
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.lyxpipe.out
-\end_layout
-
-\end_inset
-
-.
- The stem of the pipe names can be defined in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
-\end_layout
-
-\end_inset
-
- dialog, for example
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-"/home/myhome/.lyxpipe"
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-LyX will add the '
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.in
-\end_layout
-
-\end_inset
-
-' and '
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.out
-\end_layout
-
-\end_inset
-
-' to create the pipes.
- The above setting also has the effect of activating the LyX server.
- If one of the pipes already exists, LyX will assume that another LyX process
- is already running and will not start the server.
- To have several LyX processes with servers at the same time, you have to
- change the configuration between the start of the programs.
-\end_layout
-
-\begin_layout Standard
-If you are developing a client program, you might find it useful to enable
- debugging information from the LyX server.
- Do this by starting LyX as lyx -dbg lyxserver.
-\end_layout
-
-\begin_layout PlainLayout
-Warning: if LyX crashes, it may not manage to remove the pipes; in this
- case you must remove them manually.
- If LyX starts and the pipes exist already, it will not start any server.
-\end_layout
-
-\begin_layout PlainLayout
-Other than this, there are a few points to consider:
-\end_layout
-
-\begin_layout Itemize
-Both server and clients must run on UNIX or OS/2 machines.
- Communications between LyX on UNIX and clients on OS/2 or vice versa is
- not possible right now.
-\end_layout
-
-\begin_layout Itemize
-On OS/2, only one client can connect to LyXServer at a time.
-\end_layout
-
-\begin_layout Itemize
-On OS/2, clients must open inpipe with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-O_WRONLY
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-mode.
-\end_layout
-
-\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-development/server_monitor.c
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Section
-Normal communication
-\end_layout
-
-\begin_layout Standard
-To issue a LyX call, the client writes a line of ASCII text into the input
- pipe.
- This line has the following format:
-\end_layout
-
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-argument
-\end_layout
-
-\begin_layout Standard
-Here
-\emph on
-clientname
-\emph default
- is a name that the client can choose arbitrarily.
- Its only use is that LyX will echo it if it sends an answer - so a client
- can dispatch results from different requesters.
-\end_layout
-
-\begin_layout Standard
-
-\emph on
-function
-\emph default
- is the function you want LyX to perform.
- It is the same as the commands you'd use in the minibuffer.
-\end_layout
-
-\begin_layout Standard
-
-\emph on
-argument
-\emph default
- is an optional argument which is meaningful only to some functions (for
- instance
-\begin_inset Quotes eld
-\end_inset
-
-self-insert
-\begin_inset Quotes erd
-\end_inset
-
- which will insert the argument as text at the cursor position.)
-\end_layout
-
-\begin_layout Standard
-The answer from LyX will arrive in the output pipe and be of the form
-\end_layout
-
-\begin_layout Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-data
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-clientname
-\emph default
- and
-\emph on
-function
-\emph default
- are just echoed from the command request, while
-\emph on
-data
-\emph default
- is more or less useful information filled according to how the command
- execution worked out.
- Some commands will return information about the internal state of LyX,
- such as
-\begin_inset Quotes eld
-\end_inset
-
-font-state
-\begin_inset Quotes erd
-\end_inset
-
-, while other will return an empty data-response.
- This means that the command execution went fine.
-\end_layout
-
-\begin_layout Standard
-In case of errors, the response from LyX will have this form
-\end_layout
-
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-error message
-\end_layout
-
-\begin_layout Standard
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
-\end_layout
-
-\begin_layout Standard
-Examples:
-\end_layout
-
-\begin_layout LyX-Code
-echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
-\end_layout
-
-\begin_layout LyX-Code
-echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
-\newline
-read a <~/.lyxpipe.out
-\newline
-echo $a
-\end_layout
-
-\begin_layout Section
-Notification
-\end_layout
-
-\begin_layout Standard
-LyX can notify clients of events going on asynchronously.
- Currently it will only do this if the user binds a key sequence with the
- function
-\begin_inset Quotes eld
-\end_inset
-
-notify
-\begin_inset Quotes erd
-\end_inset
-
-.
- The format of the string LyX sends is as follows:
-\end_layout
-
-\begin_layout Quote
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-NOTIFY:
-\end_layout
-
-\end_inset
-
-
-\emph on
-key-sequence
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-key-sequence
-\emph default
- is the printed representation of the key sequence that was actually typed
- by the user.
-\end_layout
-
-\begin_layout Standard
-This mechanism can be used to extend LyX's command set and implement macros:
- bind some key sequence to
-\begin_inset Quotes eld
-\end_inset
-
-notify
-\begin_inset Quotes erd
-\end_inset
-
-, start a client that listens on the out pipe, dispatches the command according
- to the sequence and starts a function that may use LyX calls and LyX requests
- to issue a command or a series of commands to LyX.
-\end_layout
-
-\begin_layout Section
-The simple LyX Server Protocol
-\end_layout
-
-\begin_layout Standard
-LyX implements a simple protocol that can be used for session management.
- All messages are of the form
-\end_layout
-
-\begin_layout Quote
-LYXSRV:
-\emph on
-clientname
-\emph default
-:
-\emph on
-protocol message
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-protocol message
-\emph default
- can be
-\begin_inset Quotes eld
-\end_inset
-
-hello
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-bye
-\begin_inset Quotes erd
-\end_inset
-
-.
- If
-\begin_inset Quotes eld
-\end_inset
-
-hello
-\begin_inset Quotes erd
-\end_inset
-
- is received from a client, LyX will report back to inform the client that
- it's listening to it's messages, while
-\begin_inset Quotes eld
-\end_inset
-
-bye
-\begin_inset Quotes erd
-\end_inset
-
- sent from LyX will inform clients that LyX is closing.
-\end_layout
-
-\begin_layout Chapter
-\start_of_appendix
-Bindings
-\end_layout
-
-\begin_layout Standard
-This appendix is a huge cross-reference to all the English language keybindings.
- Originally, we simply wanted to list all of the key bindings followed by
- the function it's bound to.
- That way, a user can look up a key to find out what it does.
- We then decided, what the hey, why not include the default toolbar and
- menu bindings, too.
- Please note this section is likely to be very out of date.
-\end_layout
-
-\begin_layout Standard
-The form is really self-explanatory, but here are a few tips: all entries
- are arranged roughly alphabetically for a given modifier (
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-a
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-b
-\end_layout
-
-\end_inset
-
-, etc.).
- For the general keyboard layout, simpler prefixes precede the more complex
- (
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-s
-\end_layout
-
-\end_inset
-
- before
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-S-c
-\end_layout
-
-\end_inset
-
-).
- All entries were gleaned from the default user interface and binding files
- located in the directories
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-\SpecialChar \ldots{}
-/share/lyx/ui
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-\SpecialChar \ldots{}
-/share/lyx/bind
-\end_layout
-
-\end_inset
-
-; they should be treated as the final word on the bindings.
-\end_layout
-
-\begin_layout Standard
-As a final note, be aware that some window managers (such as FVWM) take
- control of some of the function keys or motion keys.
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-right
-\end_layout
-
-\end_inset
-
- is listed here as generating
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-word-forward
-\end_layout
-
-\end_inset
-
-, but FVWM grabs it and uses it to change virtual desktops instead.
- Very annoying unless you instruct your window manager to stop intercepting
- such sequences.
-\end_layout
-
-\begin_layout Section
-Toolbar
-\end_layout
-
-\begin_layout LyX-Code
-Toolbar
-\end_layout
-
-\begin_layout LyX-Code
- Layouts
-\end_layout
-
-\begin_layout LyX-Code
- Icon "buffer-open"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "buffer-write"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "buffer-print"
-\end_layout
-
-\begin_layout LyX-Code
- Separator
-\end_layout
-
-\begin_layout LyX-Code
- Icon "cut"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "copy"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "paste"
-\end_layout
-
-\begin_layout LyX-Code
- Separator
-\end_layout
-
-\begin_layout LyX-Code
- Icon "font-emph"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "font-noun"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "font-free"
-\end_layout
-
-\begin_layout LyX-Code
- Separator
-\end_layout
-
-\begin_layout LyX-Code
- Icon "tex-mode"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "math-mode"
-\end_layout
-
-\begin_layout LyX-Code
- Separator
-\end_layout
-
-\begin_layout LyX-Code
- Icon "footnote-insert"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "marginpar-insert"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "depth-next"
-\end_layout
-
-\begin_layout LyX-Code
- Separator
-\end_layout
-
-\begin_layout LyX-Code
- Icon "figure-insert"
-\end_layout
-
-\begin_layout LyX-Code
- Icon "dialog-tabular-insert"
-\end_layout
-
-\begin_layout LyX-Code
-End
-\end_layout
-
-\begin_layout Section
-Menu
-\end_layout
-
-\begin_layout Standard
-Note that the following bindings are for LyX with English menus.
- The second character of the binding depends on the menu language.
- For example
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i r
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- is with German menus
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e q
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- To find out the shortcuts of your language press the Meta (Alt)-key and
- press then the keys of the underlined characters of the menu names.
-\end_layout
-
-\begin_layout Subsection
-File
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-write-as
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-c
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-close
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-d
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-reload
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-e
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-file_export submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-f
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-export fax
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-file_import submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-n
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-new
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-o
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-open
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-p
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-print
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-s
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-write
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-new-template
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-v
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-file_vc submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-h
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vc-history
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vc-check-in
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-l
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vc-revert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-o
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vc-check-out
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-r
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vc-register
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-u
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-vc-undo-last
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-f
-\begin_inset Space ~
-\end_inset
-
-x
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lyx-quit
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-Edit
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-paste
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-c
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-cut
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-d
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-redo
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-e
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-error-remove-all
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-f
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-find-replace
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-h
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-chktex
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-edit_floats submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature append-row
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-b
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature toggle-line-bottom
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-c
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature align-center
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-d
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature delete-column
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-e
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature align-left
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature align-right
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-l
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature toggle-line-left
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-m
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature multicolumn
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-n
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature valign-center
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-o
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature valign-top
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-r
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature toggle-line-right
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature toggle-line-top
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-u
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature append-column
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-v
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature valign-bottom
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-w
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-tabular-feature delete-row
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-l
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-math-panel
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_deeper
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-floats-operate openfoot
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-c
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-floats-operate closefoot
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-f
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-floats-operate openfig
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-m
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-melt
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-o
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-open-stuff
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-floats-operate closefig
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\end_deeper
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-o
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-copy
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-p
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-dialog-preferences
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-r
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-reconfigure
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-s
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-spellchecker
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-edit_tabular submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-u
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-undo
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-e
-\begin_inset Space ~
-\end_inset
-
-x
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-edit_paste submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-l
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-primary-selection-paste
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-p
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-primary-selection-paste paragraph
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-Insert
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-insert_floats submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-float-insert algorithm
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-d
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-float-insert wide-tab
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-f
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-float-insert figure
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-float-insert table
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-w
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-float-insert wide-fig
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-b
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-dialog-tabular-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-c
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-citation-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-d
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-math-display
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-e
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-buffer-child-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-f
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-footnote-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-g
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-figure-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-h
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-math-mode
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-index-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-l
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-label-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-m
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-marginpar-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-n
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-note-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-o
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-insert_toc submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-a
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-loa-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-b
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-bibtex-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-c
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-toc-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-f
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lof-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-index-print
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-t
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lot-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-r
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-reference-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
-
-s
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-insert_special submenu
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-b
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-protected-space-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-e
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-end-of-sentence-period-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-h
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-hfill-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-i
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-dots-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-l
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-break-line
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-m
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-menu-separator-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-p
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-hyphenation-point-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-q
-\end_layout
-
-\end_inset
-