-#LyX 1.6.0alpha1 created this file. For more info see http://www.lyx.org/
-\lyxformat 321
+#LyX 1.6.0rc1 created this file. For more info see http://www.lyx.org/
+\lyxformat 340
\begin_document
\begin_header
-\textclass book
+\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
%
\ifpdf % if pdflatex is used
% set fonts for nicer pdf view
- \IfFileExists{lmodern.sty}{\usepackage{lmodern}}{}
-
- % link all cross references and URLs in pdf output
- \usepackage[colorlinks=true, bookmarks, bookmarksnumbered,
- linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,
- pdfpagelayout=OneColumn, pdfnewwindow=true,
- pdfstartview=XYZ, plainpages=false, pdfpagelabels,
- pdfauthor={LyX Team}, pdftex,
- pdftitle={Customizing LyX: Features for the Advanced User},pdfsubject={LyX-documentation Customization},
- pdfkeywords={LyX, documentation}
-]{hyperref}
-
-\else % if dvi or ps is produced
-
- % link all cross references and URLs in dvi output
- \usepackage[ps2pdf]{hyperref}
+ \IfFileExists{lmodern.sty}
+ {\usepackage{lmodern}}{}
\fi % end if pdflatex is used
- % the pages of the TOC are numbered roman
- % and a pdf-bookmark for the TOC is added
- \pagenumbering{roman}
- \let\myTOC\tableofcontents
- \renewcommand\tableofcontents{%
- \pdfbookmark[1]{Contents}{}
- \myTOC
- \cleardoublepage
- \pagenumbering{arabic} }
+% the pages of the TOC is numbered roman
+% and a pdf-bookmark for the TOC is added
+\let\myTOC\tableofcontents
+\renewcommand\tableofcontents{%
+ \frontmatter
+ \pdfbookmark[1]{\contentsname}{}
+ \myTOC
+ \mainmatter }
% redefine the \LyX macro for PDF bookmarks
\def\LyX{\texorpdfstring{%
\usepackage{multicol}
\usepackage{inputenc}
\end_preamble
+\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
\begin_modules
logicalmkup
\end_modules
End
\end_local_layout
\language english
-\inputencoding default
+\inputencoding auto
\font_roman default
\font_sans default
\font_typewriter default
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
+
\graphics none
-\paperfontsize default
+\paperfontsize 12
\spacing single
-\use_hyperref false
+\use_hyperref true
+\pdf_title "LyX Configuration Manual"
+\pdf_author "LyX Team"
+\pdf_subject "LyX-documentation Customization"
+\pdf_keywords "LyX, documentation, customization"
+\pdf_bookmarks true
+\pdf_bookmarksnumbered true
+\pdf_bookmarksopen true
+\pdf_bookmarksopenlevel 1
+\pdf_breaklinks false
+\pdf_pdfborder false
+\pdf_colorlinks true
+\pdf_backref false
+\pdf_pagebackref false
+\pdf_pdfusetitle false
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
\papersize default
\use_geometry false
\use_amsmath 0
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
+\branch OutDated
+\selected 0
+\color #f5fae7
+\end_branch
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\output_changes false
\author ""
\author ""
-\extra_embedded_files ""
\end_header
\begin_body
\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\noindent
-Principal maintainer of this file is
-\noun on
-Mike Ressler
-\noun default
+If you have comments or error corrections, please send them to the LyX Documenta
+tion mailing list,
+\begin_inset CommandInset href
+LatexCommand href
+target "lyx-docs@lists.lyx.org"
+type "mailto:"
+
+\end_inset
+
.
- If you have comments or error corrections, please send them to the LyX
- Documentation mailing list, <lyx-docs@lists.lyx.org>.
\end_layout
\end_inset
for some of the more obscure ones.
\end_layout
+\begin_layout Standard
+\begin_inset Branch OutDated
+status collapsed
+
+\begin_layout Standard
+Information from previous versions of this document that now seems to be
+ outdated is contained in the OutDated branch of this document.
+ By default, this information will not appear in the LaTeX output.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
\begin_layout Chapter
LyX configuration files
\end_layout
This chapter aims to help you to find your way through the LyX configuration
files.
Before continuing to read this chapter, you should find out where your
- LyX library directory is by using
+ LyX library and user directories are by using
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
H
\bar default
elp\SpecialChar \menuseparator
About
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
Ly
\end_inset
.
- This directory is the place where LyX places its system-wide configuration
- files, and we will simply name it
+ The library directory is the place where LyX places its system-wide configurati
+on files; the user directory is where you can place your modified versions.
+ We will call the former
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir
\end_layout
+\end_inset
+
+ and the latter
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
+\end_layout
+
\end_inset
in the remainder of this document.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
T
\end_inset
dialog.
- Most customization that you might want to do to LyX is possible through
+ Most customization that you will want to do in LyX is possible through
this dialog.
However, many other inner aspects of LyX can be customized by modifying
the files in
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir
\end_layout
\end_inset
.
- They fall in different categories, described in the following subsections.
+ These files fall in different categories, described in the following subsection
+s.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-These files are generated when you configure LyX.
+The files, which are to be found in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
+\end_layout
+
+\end_inset
+
+, are generated when you configure LyX.
They contain various default values that are guessed by inspection.
In general, it is not a good idea to modify them, since they might be overwritt
en at any time.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
lyxrc.defaults
\end_layout
contains defaults for various commands.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
packages.lst
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
H
a
\bar default
TeX
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
Configuration
.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
textclass.lst
\end_layout
\end_inset
- is the list of text classes that have been found in your
+ the list of text classes that have been found in your
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+layout/
+\end_layout
+
+\end_inset
+
+ directories, along with the associated LaTeX document class and their descripti
+on.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxmodules.lst
+\end_layout
+
+\end_inset
+
+ the list of layout modules found in your
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
layout/
\end_layout
\end_inset
- directory, along with the associated LaTeX document class and their description.
+ directories
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+*files.lst
+\end_layout
+
+\end_inset
+
+ lists of various sorts of LaTeX-related files found on your system
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
doc/LaTeXConfig.lyx
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LaTeXConfig.lyx.in
\end_layout
\end_inset
.
+ It contains information on your LaTeX configuration.
\end_layout
\begin_layout Subsection
Directories
\end_layout
-\begin_layout List
+\begin_layout Standard
+These directories are duplicated between
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
+\end_layout
+
+\end_inset
+
+.
+ If a particular files exists in both places, the one in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
+\end_layout
+
+\end_inset
+
+ will be used.
+\end_layout
+
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
bind/
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
.bind
\end_layout
\end_inset
that define the keybindings used in LyX (see section
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
$LANG_xxx.bind
\end_layout
, that will be used first.
See Chapter
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
for details.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
clipart/
\end_layout
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
doc/
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LaTeXConfig.lyx
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
$LANG_
\end_layout
prepended to the name, that will be used first.
See Chapter
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
for details.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
examples/
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Examples
\end_layout
button to get there.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
images/
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Document
\end_layout
and the banners that can be shown when LyX is launched.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
kbd/
\end_layout
contains keyboard keymapping files.
See Chapter
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
for details.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
layouts/
\end_layout
\end_inset
- contains the text class files described in Chapter
-\begin_inset Space ~
+ contains the text class and module files described in Chapter
+\begin_inset space ~
\end_inset
.
\end_layout
-\begin_layout List
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyx2lyx
+\end_layout
+
+\end_inset
+
+ contains the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyx2lyx
+\end_layout
+
+\end_inset
+
+ Python scripts used to convert between LyX versions.
+ These can be run from the command line if, say, you want to batch-convert
+ files.
+\end_layout
+
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
scripts/
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
External
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
Template
\end_inset
feature.
+ Also contains some scripts used by LyX itself.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
templates/
\end_layout
\end_inset
contains the standard LyX template files described in Chapter
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-tex/
-\end_layout
-
-\end_inset
-
- contains some LaTeX cls files distributed with LyX.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
+\begin_layout Plain Layout
ui/
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
.ui
\end_layout
that define the user interface to LyX.
That is, the files define which items appear in which menus and the items
appearing on the toolbar.
- See Chapter
-\begin_inset Space ~
-\end_inset
-
-
+ See
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:ui"
modify them unless you are a developer.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
CREDITS
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
H
\bar default
elp\SpecialChar \menuseparator
About
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
LyX
.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
chkconfig.ltx
\end_layout
Do not run directly.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-configure
+\begin_layout Plain Layout
+configure.py
\end_layout
\end_inset
Other files needing a line or two...
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
encodings
\end_layout
mapped to unicode
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
external_templates
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
External
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
Template
feature.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
languages
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
H
\bar default
elp\SpecialChar \menuseparator
About
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
LyX
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
T
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
preferences
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
T
\end_inset
-, LyX runs
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-configure
-\end_layout
-
-\end_inset
-
- and the resulting files are written in your local configuration directory
- (see section
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:autodetected"
-
-\end_inset
-
- to have a list of the
+, LyX runs the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-preferences
+\begin_layout Plain Layout
+configure.py
\end_layout
\end_inset
- settings affected by this section).
+ script, and the resulting files are written in your local configuration
+ directory.
This means that any additional text class file that you might have added
in
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir/layouts
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
-L
+D
\bar default
-ayout\SpecialChar \menuseparator
+ocument\SpecialChar \menuseparator
\bar under
-D
+S
\bar default
-ocument
+ettings
\end_layout
\end_inset
dialog.
\end_layout
-\begin_layout Itemize
-Similarly, if you have installed some LaTeX document classes in your home
- directory, that LaTeX can find with your
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-TEXINPUTS
-\end_layout
-
-\end_inset
-
- path, they will show up in your list of text classes.
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-as long as LyX or yourself have a
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.layout
-\end_layout
-
-\end_inset
-
- file for it, of course.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Itemize
If you get some updated documentation from LyX ftp site and cannot install
it because you do not have sysadmin rights on your system, you can just
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir/doc/
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
H
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-userdir
\end_layout
<some directory>
\emph default
instructs the program to read the configuration from that directory, and
- not from the default directory (you can determine the default directory
- by running LyX without this switch as described above).
- If this directory does not exist, LyX offers to create it for you, just
- like it does for the default directory on the first time you run the program.
- You can modify the configuration options in this additional
+ not from the default directory.
+ (You can determine the default directory by running LyX without the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Userdir
+\begin_layout Plain Layout
+-userdir
\end_layout
\end_inset
+ switch.) If the specified directory does not exist, LyX offers to create
+ it for you, just like it does for the default directory on the first time
+ you run the program.
+ You can modify the configuration options in this additional user directory
exactly as you would for the default directory.
These directories are completely independent (but read on).
Note that setting the environment variable
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-LYX_USERDIR_15x
+\begin_layout Plain Layout
+LYX_USERDIR_16x
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Userdir/layouts
+\begin_layout Plain Layout
+NewUserDir/layouts
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-which you want available from all your configurations, you must add it to
- each directory separately.
+ which you want available from all your configurations, you must add it
+ to each directory separately.
You can avoid this with the following trick: after LyX creates the additional
directory, most of the subdirectories (see above) are empty.
If you want the new configuration to mirror an existing one, replace the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
doc/
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
T
\bar under
R
\bar default
-econfigure
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:autodetected"
-
-\end_inset
-
-)
+econfigure
\end_layout
\end_inset
- which is configuration-specific.
+) which is configuration-specific.
\end_layout
\begin_layout Chapter
-The
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Preferences
-\end_layout
-
-\end_inset
-
- dialog
+The Preferences dialog
\end_layout
\begin_layout Section
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir/preferences
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
LyXDir/lyxrc.defaults
\end_layout
\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
- are just comments and not interpreted.
+ are just comments and are not interpreted.
However, only system administrators should edit
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-LyXDir/lyxrc
+\begin_layout Plain Layout
+LyXDir/lyxrc.defaults
\end_layout
\end_inset
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
T
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
UserDir/preferences
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
T
\end_inset
dialog will be largely self-explanatory.
- Almost all the commands have an associated comment, so you shouldn't have
- too much trouble modifying it to taste.
+ Most things in the dialog have associated `tool tips': hover your mouse
+ pointer over something for more information.
Before we highlight a few of the more important commands below, however,
a word of warning:
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Apply
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Save
\end_layout
\end_layout
\begin_layout Section
-On-screen fonts
+Look and Feel
+\end_layout
+
+\begin_layout Subsection
+Screen fonts
\end_layout
\begin_layout Standard
The font used to display your documents on the LyX screen is very important,
since you'll be reading all your documents with this font.
- Therefore it is important that the font is as readable and good-looking
+ Therefore it is important that the font be as readable and good-looking
as possible.
The LyX team tried to provide the best possible default font for you, but
- since practically all X11 systems are different, it's likely that the default
+ since systems can be so different, it's quite possible that the default
fonts will be sub-optimal on your system.
Fortunately, you can do something about this.
- Before we explain how to do this, you should learn a bit more about fonts
- so that you are better prepared for choosing your fonts, because it is
- a trade-off that is specific to your preferences and the capabilities of
- your system.
+ Before we explain how, you should learn a bit more about fonts so that
+ you are better prepared for choosing your fonts.
+ There are trade-offs that are specific to your preferences and the capabilities
+ of your system.
\end_layout
\begin_layout Standard
\emph on
quality
\emph default
- of the scaling, and the
+ of the scaling and the
\emph on
speed
\emph default
This means that each glyph is defined using mathematical curves that are
well suited for scaling to any requested size.
This mathematical definition is interpreted by the font renderer and turned
- into a small picture composed of pixels according to which size and glyph,
- the programmer requests.
- This means that scalable fonts will look pretty good in all sizes.
- Well, almost all sizes.
- Since scalable fonts are defined in an abstract way, it can be hard to
- provide a good rendering at small sizes, where each pixel has to be very
- carefully computed to provide a good image.
+ into a small picture composed of pixels according to which size and glyph
+ (or symbol) the programmer requests.
+ This means that scalable fonts will look pretty good in most sizes.Since
+ scalable fonts are defined in an abstract way, it can be hard to provide
+ a good rendering at small sizes, where each pixel has to be very carefully
+ computed to provide a good image.
Technically it is possible to do this from the mathematical definition,
but in order to keep the rendering reasonably fast, tradeoffs have to be
made, and the result is that scalable fonts can be difficult to read at
start, so they will look good at all the sizes they are meant for.
However, they don't scale well, because in order to scale a glyph, each
pixel is enlarged into several pixels.
- It is the same effect that happens if you try to enlarge a picture in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xv
-\end_layout
-
-\end_inset
-
- or any other picture manipulation program.
+ It is the same effect that happens if you try to enlarge a picture in an
+ image manipulation program.
In order to relieve this effect, bitmap fonts are typically provided in
several fixed sizes typically from around 8 pixels high up to 34 pixels
or so high in steps according to what is believed to be useful.
\end_layout
\begin_layout Standard
-The net result of all this, is that bitmap fonts are generally best for
- the small sizes, where they are available, while scalable fonts are generally
+The net result of all this is that bitmap fonts are generally best for the
+ small sizes, where they are available, while scalable fonts are generally
best for large sizes.
The logical conclusion would thus be to use bitmap fonts for the small
sizes, and scalable fonts for the large sizes.
what suits you.
\end_layout
-\begin_layout Standard
-By default, LyX uses non-scalable bitmap fonts (when using the XForms frontend).
- For serif fonts,
-\emph on
-times
-\emph default
- is used, for sans serif fonts,
-\emph on
-helvetica
-\emph default
- is used, while
-\emph on
-courier
-\emph default
- is used as the monospaced/typewriter font.
-\end_layout
-
\begin_layout Standard
In the following, we will describe what to do if the text does not look
good in LyX.
We'll start with the most important parameters: DPI and font zoom.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
DPI setting and Font Zoom
\end_layout
\begin_layout Standard
In order for this to work on all systems, it relies on the screen DPI (dots
per inch) setting to be correct.
- The DPI setting for your system is autodetected by LyX using the information
- the X server can provide.
+ The DPI setting for your system is autodetected by LyX using information
+ provided by your system.
You can check what LyX autodetects the DPI setting to, by running LyX as
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
lyx -dbg 2
\end_layout
\end_layout
\begin_layout Standard
-On many systems, X is not set up correctly, so you should check that it
- is correct by hand.
- Run
+On many systems, this will not be correct, so you should check that it is
+ correct by hand.
+ On X11 systems, you can run
\begin_inset Quotes eld
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
xdpyinfo | more
\end_layout
the number of pixels in the width by the width of the screen-image on the
monitor.
If this number is more than, say, 5 DPI from the detected value, you should
- either fix the X setup, or at least tell LyX that the DPI is different
+ either fix your system setup, or at least tell LyX that the DPI is different
than the detected value.
\end_layout
\begin_layout Standard
-If you can't fix the X setup (which of course is best since other programs
+If you can't fix system setup (which of course is best since other programs
than LyX will benefit from this as well), you can tell LyX the correct
DPI using the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Preferences
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Font
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Preferences
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
A
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\bar under
S
than merely size.
\end_layout
-\begin_layout Subsection
+\begin_layout Subsubsection
Font definition commands
\end_layout
\begin_layout Standard
-As mentioned, LyX uses non-scalable bitmap fonts by default with the XForms
- frontend.
- For serif fonts,
-\emph on
-times
-\emph default
- is used, for sans serif fonts,
-\emph on
-helvetica
-\emph default
- is used, while
-\emph on
-courier
-\emph default
- is used as the monospaced/typewriter font.
-\end_layout
-
-\begin_layout Standard
-You can change all of these from within the
+You can change LyX's screen fonts from within the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Preferences
\end_layout
\end_inset
dialog.
- The number of fonts that are available on different systems vary, but the
- program
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xfontsel
+ The number of fonts that are available on different systems vary.
+
\end_layout
-\end_inset
-
- should be available everywhere.
- Use that program to find candidate fonts.
- When you've found a font that you like, try to insert the first two elements
- of the name (called
+\begin_layout Standard
+Before you go about scrapping a bitmap font because the larger sizes look
+
\begin_inset Quotes eld
\end_inset
-fndry
+blocky
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+, you should toggle the
+\begin_inset Flex CharStyle:Code
+status collapsed
-fmly
-\begin_inset Quotes erd
-\end_inset
-
- in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xfontsel
-\end_layout
-
-\end_inset
-
-) in the appropriate field in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Preferences
-\end_layout
-
-\end_inset
-
- dialog and press
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-A
-\bar default
-pply
-\end_layout
-
-\end_inset
-
-.
- LyX will then reformat your document using the new font, and if you like
- the font, you should
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-
-\bar under
-S
-\bar default
-ave
-\end_layout
-
-\end_inset
-
- it.
- One place to start for a new font is to see if the scalable font
-\begin_inset Quotes eld
-\end_inset
-
-utopia
-\begin_inset Quotes erd
-\end_inset
-
- is available.
- Tip: You can see whether a font is a bitmap font or a scalable font by
- checking the
-\begin_inset Quotes eld
-\end_inset
-
-resx
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-resy
-\begin_inset Quotes erd
-\end_inset
-
- fields in
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xfontsel
-\end_layout
-
-\end_inset
-
-.
- If the value 0 is available, the font is scalable.
- If the value 0 isn't available, the font is a bitmap font.
+\begin_layout Plain Layout
+Use scalable fonts
\end_layout
-\begin_layout Standard
-Before you go about scrapping a bitmap font because the larger sizes look
-
-\begin_inset Quotes eld
-\end_inset
-
-blocky
-\begin_inset Quotes erd
-\end_inset
-
-, you should toggle the
-\begin_inset Quotes eld
-\end_inset
-
-Use scalable fonts
-\begin_inset Quotes erd
\end_inset
button.
This is only useful if you use bitmap fonts, because only these don't scale
well.
If you define this flag, LyX will only use the fixed font sizes that are
- available, and this guarantees that all bitmap fonts look well.
- (You can see which individual font sizes are available with the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-xlsfonts
-\end_layout
-
-\end_inset
-
- command.
- Try
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-man xlsfonts
-\end_layout
-
-\end_inset
-
-.) However, the prize is that the difference between the size of the fonts
- on screen and the size of fonts on paper will be larger because LyX will
- have to be satisfied with the closest available size, and not try to scale
- a size to fit.
+ available, and this guarantees that all bitmap fonts look good.
+ However, the downside is that there will be a greater difference between
+ the size of the fonts on screen and the size of fonts on paper because
+ LyX will have to be satisfied with the closest available size, and not
+ try to scale a size to fit.
Also, you can risk that some logically different sizes, such as
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Large
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Larger
\end_layout
, will be mapped to the same screen font, making it hard for you to see
the difference on screen.
- We've decided not to use scalable fonts by default because of these artifacts,
- but since LyX is a WYSIWYM system, many people like to use the flag anyways,
- well-knowing that the font size on the screen can't be trusted.
- But remember that this flag only makes a difference when you use bitmap
- fonts.
- Scalable fonts won't be affected for reasons you should understand by now.
+
\end_layout
\begin_layout Standard
-One final note regarding this flag: you should know that there is nothing
- wrong with using bitmap and scalable fonts at the same time for different
- purposes.
+One final note regarding the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Use scalable fonts
+\end_layout
+
+\end_inset
+
+ flag: you should know that there is nothing wrong with using bitmap and
+ scalable fonts at the same time for different purposes.
For instance, it's common to use the scalable
\begin_inset Quotes eld
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
lyx -dbg 513
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Preferences
\end_layout
This will of course make your scalable fonts look weird, so use with care.
\end_layout
-\begin_layout Subsection
+\begin_layout Standard
+\begin_inset Branch OutDated
+status collapsed
+
+\begin_layout Subsubsection
Font encoding
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
xfontsel
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Table
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
of
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
Contents
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-*-helvetica-medium-r
\end_layout
while using a different set of fonts to look good on paper.
\end_layout
-\begin_layout Section
-Bindings
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:bindings"
-
\end_inset
\end_layout
-\begin_layout Standard
-Bindings are used to, well, bind a function to a key.
- Several prepackaged binding files are available: a CUA set of bindings
- (familiar as the typical set of PC and CDE set of keyboard shortcuts),
- an Emacs set of bindings, for those of us who follow the One True Way and
- refuse to lower our standards,
-\begin_inset Foot
-status collapsed
-
-\begin_layout PlainLayout
-I'm kidding here, of course!
-\end_layout
+\begin_layout Subsection
+User Interface
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:ui"
\end_inset
- as well as specialty bindings (broadway and hollywood) and other languages
- (French, German, etc.).
+
\end_layout
\begin_layout Standard
-If, however, you'd like to customise the keybindings to your own exacting
- tastes, then copy the best-fit file in
-\begin_inset Flex CharStyle:Code
+The appearance of both the menu and toolbar may both be changed using the
+
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-LyXDir/bind/
+\begin_layout Plain Layout
+Preferences
\end_layout
\end_inset
- to your own
+ dialog.
+ Simply select a different
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-UserDir/bind/
+\begin_layout Plain Layout
+.ui
\end_layout
\end_inset
- and modify that.
- Don't forget to load this new file into LyX using the
+ file in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Preferences
-\end_layout
-
-\end_inset
-
- dialog.
- (For the moment you'll have to restart LyX for these changes to take effect.)
+\begin_layout Plain Layout
+Look & Feel\SpecialChar \menuseparator
+User Interface
\end_layout
-\begin_layout Standard
-LyX supports internationalization of the user interface (see Chapter
-\begin_inset Space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "chap:i18n"
-
\end_inset
-).
- If your
-\emph on
-locale
-\emph default
- is set, with the environment variable
+ section.
+ You can customize the interface by copying one of the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-$LANG
+\begin_layout Plain Layout
+.ui
\end_layout
\end_inset
-, LyX will try to use bindfiles by prepending
+ files from
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-$LANG_
+\begin_layout Plain Layout
+LyXDir/ui/
\end_layout
\end_inset
- to their name.
- For example, you can put a translated copy of some standard bind file in
- your personal
+ to
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-bind/
+\begin_layout Plain Layout
+UserDir/ui/
\end_layout
\end_inset
- directory, and LyX will use it automatically.
+.
+ You may have to restart LyX for these changes to take effect.
\end_layout
\begin_layout Standard
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-.bind
-\end_layout
-
-\end_inset
-
- files is straightforward:
-\end_layout
-
-\begin_layout Standard
-
-\backslash
-bind <key combination> <lyx-function>
-\end_layout
-
-\begin_layout Standard
-Both key combination and lyx-function (including any arguments) must be
- enclosed in "double quotes".
- All the LyX functions are listed in the
-\emph on
-Reference Guide
-\emph default
-.
+\begin_layout Plain Layout
+.ui
\end_layout
-\begin_layout Section
-User Interface
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:ui-1"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-The appearance of both the menu and toolbar may both be changed using the
-
-\begin_inset Flex CharStyle:MenuItem
+ files is straightforward: have a look at
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Preferences
+\begin_layout Plain Layout
+default.ui
\end_layout
\end_inset
- dialog.
- Simply change the
+.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-.ui
+\begin_layout Plain Layout
+Menubar
\end_layout
\end_inset
- file in
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-LyXDir/ui/
+\begin_layout Plain Layout
+Menu
\end_layout
\end_inset
-.
- For the moment, only one file exists,
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-default.ui
+\begin_layout Plain Layout
+Toolbar
\end_layout
\end_inset
-, but feel free to experiment.
- Just copy the file to the
+ entries must be ended with an explicit
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-UserDir/ui/
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
- directory and play! Note that, for the moment, you'll have to restart LyX
- for these changes to take effect.
-\end_layout
-
-\begin_layout Standard
-The syntax of the
+.
+ They may contain
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-.ui
+\begin_layout Plain Layout
+Submenu
\end_layout
\end_inset
- files is straightforward: have a look at default.ui.
- The
+s,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Menubar
+\begin_layout Plain Layout
+Item
\end_layout
\end_inset
-,
+s,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Menu
+\begin_layout Plain Layout
+OptItem
\end_layout
\end_inset
- and
+s,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Toolbar
+\begin_layout Plain Layout
+Separator
\end_layout
\end_inset
- entries must be ended with an explicit
+s,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-End
-\end_layout
-
-\end_inset
-
-.
- They may contain
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Submenu
-\end_layout
-
-\end_inset
-
-s,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Item
-\end_layout
-
-\end_inset
-
-s,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-OptItem
-\end_layout
-
-\end_inset
-
-s,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Separator
-\end_layout
-
-\end_inset
-
-s,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Icon
+\begin_layout Plain Layout
+Icon
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Lastfiles
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Submenu
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Menubar
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Menu
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Menu
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Submenu
\end_layout
\end_inset
s.
+ A
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Submenu
\end_layout
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:converters-etc"
+\end_inset
+
+ tag is used to insert context-dependent information that is generated by
+ LyX itself.
+ Unfortunately, the available tags are not documented outside the source
+ code.
+\end_layout
+
+\begin_layout Standard
+Note that, as of LyX 1.6, there are extensive context menus, normally accessed
+ via a right click.
+ These are defined in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.ui
+\end_layout
\end_inset
-Converters, Formats, and Copiers
+ files.
+\end_layout
+
+\begin_layout Section
+Editing
\end_layout
\begin_layout Standard
-LyX has a powerful mechanism to convert to and from any file format using
- external programs.
-
+The settings in this section are used to customise the behavior of the LyX
+ editor.
\end_layout
\begin_layout Subsection
-Formats
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:bindings"
+
+\end_inset
+
+Shortcuts
\end_layout
\begin_layout Standard
-The first step is to define your file formats if they are not already defined.
- To do so, open the
-\begin_inset Flex CharStyle:MenuItem
+Bindings are used to associate a LyX function to a key.
+ Several prepackaged binding files are available: a CUA set of bindings
+ (familiar as the typical set of PC and CDE set of keyboard shortcuts),
+ an Emacs set of bindings, for those of us who follow the One True Way and
+ refuse to lower our standards,
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-Tools\SpecialChar \menuseparator
-Preferences:Converters
+\begin_layout Plain Layout
+I'm kidding here, of course!
\end_layout
\end_inset
- dialog.
- Enter a new format name; a new GUI name (used in e.
-\begin_inset Space \thinspace{}
-\end_inset
-
-g.
-\begin_inset Space ~
-\end_inset
-
-the
+ as well as specialty bindings (broadway and hollywood) and bindings for
+ languages other than English.
+ You can select your binding in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-View
+\begin_layout Plain Layout
+Editing\SpecialChar \menuseparator
+Shortcuts
\end_layout
\end_inset
- and
+ section of the
+\bar under
+
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Export
+\begin_layout Plain Layout
+
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references
\end_layout
\end_inset
- menus); and a file extension.
- These are required.
+
+\bar default
+ dialog.
\end_layout
\begin_layout Standard
-The
-\begin_inset Flex CharStyle:MenuItem
+If, however, you'd like to customise the bindings to your own exacting tastes,
+ then there are two ways to proceed.
+ The first, and older method, is to copy a file from
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Document format
+\begin_layout Plain Layout
+LyXDir/bind/
\end_layout
\end_inset
- option tells LyX that a format is suitable for document export.
- If this is is set and if a suitable conversion route exists, the format
- will appear in the
-\begin_inset Flex CharStyle:MenuItem
+ to your own
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-File\SpecialChar \menuseparator
-Export
+\begin_layout Plain Layout
+UserDir/bind/
\end_layout
\end_inset
- menu.
- The format will also appear in the
+ and modify that in a text editor.
+ Don't forget to select this file in
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-View
+\begin_layout Plain Layout
+Editing\SpecialChar \menuseparator
+Shortcuts
\end_layout
\end_inset
- menu if it has a specified viewer.
- Pure image formats, e.
-\begin_inset Space \thinspace{}
-\end_inset
+.
+ The second method is to use the shortcut editor, which you will also find
+ at
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-g.
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+Editing\SpecialChar \menuseparator
+Shortcuts
+\end_layout
+\end_inset
+.
+ The changes you make here will be stored at
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-png
+\begin_layout Plain Layout
+UserDir/bind/user.bind
\end_layout
\end_inset
-, should not use this option.
- Formats that can both represent vector graphics and documents like e.
-\begin_inset Space \thinspace{}
-\end_inset
+.
+\end_layout
-g.
-\begin_inset Space ~
+\begin_layout Standard
+LyX supports internationalization of the user interface (see Chapter
+\begin_inset space ~
\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:i18n"
+
+\end_inset
+
+).
+ If your
+\emph on
+locale
+\emph default
+ is set, LyX will try to use bindfiles by prepending the standard language
+ code to their name.
+ For example, you can put a translated copy of some standard bind file in
+ your personal
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-pdf
+\begin_layout Plain Layout
+bind/
\end_layout
\end_inset
- should use it.
+ directory, and LyX will use it automatically.
\end_layout
\begin_layout Standard
-The option
-\begin_inset Flex CharStyle:MenuItem
+The syntax of the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Vector graphics format
+\begin_layout Plain Layout
+.bind
\end_layout
\end_inset
- tells LyX that a format can contain vector graphics.
- This information is used to determine the target format of included graphics
- for
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ files is straightforward:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+bind ``<key combination>'' ``<lyx-function>
+\begin_inset Quotes erd
+\end_inset
+
-\begin_layout PlainLayout
-pdflatex
\end_layout
+\begin_layout Standard
+Both key combination and lyx-function (including any arguments) must be
+ enclosed in "double quotes".
+ The LyX functions are partially documented on listed on the
+\begin_inset CommandInset href
+LatexCommand href
+name "LyXWiki"
+target "http://wiki.lyx.org/LyX/LyxFunctions"
+
\end_inset
- export.
- Included graphics may need to be converted to either
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+.
+ A major effort is presently underway to improve this documentation.
+\end_layout
-\begin_layout PlainLayout
-pdf
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:converters-etc"
+
+\end_inset
+
+File Handling
+\end_layout
+
+\begin_layout Standard
+LyX has a powerful mechanism to convert to and from any file format using
+ external programs.
+
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Formats"
+
\end_inset
-,
+Formats
+\end_layout
+
+\begin_layout Standard
+The first step is to define your file formats if they are not already defined.
+ To do so, open the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-png
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File Formats
\end_layout
\end_inset
-, or
+ dialog.
+ Press the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-jpg
+\begin_layout Plain Layout
+New\SpecialChar \ldots{}
+
\end_layout
\end_inset
-, since
+ button to define your new format.
+ The
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdflatex
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
- cannot handle other image formats.
- If an included graphic is not already in
+ field contains the named used to identify the format in the GUI.
+ The
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdf
+\begin_layout Plain Layout
+Short Name
\end_layout
\end_inset
-,
+ is used to identify the format interally.
+ You will also need to enter a file extension.
+ These are all required.
+ The optional
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-png
+\begin_layout Plain Layout
+Shortcut
\end_layout
\end_inset
-, or
+ field is used to provide a keyboard shortcut on the menus.
+ (For example, pressing
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-jpg
+\begin_layout Plain Layout
+Alt-V D
\end_layout
\end_inset
- format, it is converted to
+ will
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdf
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+DVI
\end_layout
\end_inset
- if the vector format option is set, and otherwise to
+.)
+\end_layout
+
+\begin_layout Standard
+A Format can have a
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-png
+\begin_layout Plain Layout
+Viewer
\end_layout
\end_inset
-.
+ and
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Editor
\end_layout
-\begin_layout Standard
-A Format can have a Viewer and Editor program associated with it.
+\end_inset
+
+ associated with it.
For example, you might want to use
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Ghostview
\end_layout
\end_inset
to view PostScript files.
- You can enter the program call and its options to the corresponding fields.
- For the call you can use the four variable listed in the next section.
+ You can enter the command needed to start the program in the corresponding
+ fields.
+ In defining this command, you can use the four variables listed in the
+ next section.
The viewer is launched when you view an image in LyX or use the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
View
\end_layout
\end_inset
menu.
- If the operating system has a default viewer associated to a format, this
- viewer is used instead of the one defined here when you enter in the Viewer
- field
-\begin_inset Quotes eld
-\end_inset
-
-
+ The editor is for example launched when you press the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-auto
+\begin_layout Plain Layout
+Edit
\end_layout
\end_inset
+ button in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Graphics
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- The editor is for example launched when you press the
+ or the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Edit
+\begin_layout Plain Layout
+External material
\end_layout
\end_inset
- button in the
+ dialog.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Graphics
+\begin_layout Plain Layout
+Document format
\end_layout
\end_inset
- or the
+ option tells LyX that a format is suitable for document export.
+ If this is is set and if a suitable conversion route exists (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Converters"
+
+\end_inset
+
+), the format will appear in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-External material
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Export
\end_layout
\end_inset
- dialog.
-\end_layout
+ menu.
+ The format will also appear in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Subsection
-Copiers
+\begin_layout Plain Layout
+View
\end_layout
-\begin_layout Standard
-Each format can have a Copier associated with it.
- These are defined in the
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+ menu if a viewer is specified for the format.
+ Pure image formats, such as
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Tools\SpecialChar \menuseparator
-Preferences:Copiers
+\begin_layout Plain Layout
+png
\end_layout
\end_inset
- dialog.
- Since all conversions from one format to another take place in LyX's temporary
- directory, it is sometimes necessary to modify a file before copying it
- to the temporary directory in order that the conversion may be performed.
-\begin_inset Foot
+, should not use this option.
+ Formats that can both represent vector graphics and documents like
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-For example, the file may refer to other files---images, for example---using
- relative filenames, and these may become invalid when the file is copied
- to the temporary directory.
+\begin_layout Plain Layout
+pdf
\end_layout
\end_inset
- This is done by the Copier: It copies a file to (or from) the temporary
- directory and may modify it in the process.
+ should use it.
\end_layout
\begin_layout Standard
-Copiers may also be used for other purposes.
- For example, if appropriate converters are found, LyX will automatically
- install copiers for the
+The option
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-HTML
+\begin_layout Plain Layout
+Vector graphics format
\end_layout
\end_inset
- and
+ tells LyX that a format can contain vector graphics.
+ This information is used to determine the target format of included graphics
+ for
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-HTML
-\begin_inset Space ~
+\begin_layout Plain Layout
+pdflatex
+\end_layout
+
\end_inset
-(MS Word)
+ export.
+ Included graphics may need to be converted to either
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+pdf
\end_layout
\end_inset
- formats.
- When these formats are exported, the copier sees that not just the main
- HTML file but various associated files (style files, images, etc.) are also
- copied.
- All these files are written to a subdirectory of the directory in which
- the original LyX file was found.
-\begin_inset Foot
+,
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-This copier can be customized.
- The optional
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+png
+\end_layout
--e
-\begin_inset Quotes erd
\end_inset
- argument takes a comma-separated list of extensions to be copied; if it
- is omitted, all files will be copied.
- The
-\begin_inset Quotes eld
-\end_inset
+, or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+jpg
+\end_layout
--t
-\begin_inset Quotes erd
\end_inset
- argument determines the extension added to the generated directory.
- By default, it is
-\begin_inset Quotes eld
+, since
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+pdflatex
+\end_layout
+
\end_inset
+ cannot handle other image formats.
+ If an included graphic is not already in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+pdf
+\end_layout
+
+\end_inset
+,
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-LyXconv
+\begin_layout Plain Layout
+png
\end_layout
\end_inset
+, or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+jpg
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, so HTML generated from
+ format, it is converted to
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-/path/to/filename.lyx
+\begin_layout Plain Layout
+pdf
\end_layout
\end_inset
- will end up in
+ if the vector format option is set, and otherwise to
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-/path/to/filename.html.LyXconv
+\begin_layout Plain Layout
+png
\end_layout
\end_inset
.
-
\end_layout
-\end_inset
+\begin_layout Subsection
+Copiers
+\end_layout
+
+\begin_layout Standard
+Since all conversions from one format to another take place in LyX's temporary
+ directory, it is sometimes necessary to modify a file before copying it
+ to the temporary directory in order that the conversion may be performed.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For example, the file may refer to other files---images, for example---using
+ relative filenames, and these may become invalid when the file is copied
+ to the temporary directory.
+\end_layout
+\end_inset
+ This is done by a Copier: It copies a file to (or from) the temporary directory
+ and may modify it in the process.
\end_layout
\begin_layout Standard
The definitions of the copiers may use four variables:
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$s The LyX system directory (e.
-\begin_inset Space \thinspace{}
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$s
+\end_layout
+
+\end_inset
+
+ The LyX system directory (e.
+\begin_inset space \thinspace{}
\end_inset
g.
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
/usr/share/lyx
\end_layout
).
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$i The input file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$i
+\end_layout
+
+\end_inset
+
+ The input file
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$o The output file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$o
+\end_layout
+
+\end_inset
+
+ The output file
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$l The `LaTeX name'
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$l
+\end_layout
+
+\end_inset
+
+ The `LaTeX name'
\end_layout
\begin_layout Standard
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
/home/you/pdf/
\end_layout
inline false
status open
-\begin_layout PlainLayout
+\begin_layout Plain Layout
+
#!/bin/bash
\end_layout
-\begin_layout PlainLayout
+\begin_layout Plain Layout
+
FROMFILE=$1
\end_layout
-\begin_layout PlainLayout
+\begin_layout Plain Layout
+
TOFILE=`basename $2`
\end_layout
-\begin_layout PlainLayout
+\begin_layout Plain Layout
+
cp $FROMFILE /home/you/pdf/$TOFILE
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
/home/you/.lyx/scripts/pdfcopier.sh
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Tools\SpecialChar \menuseparator
Preferences:Copiers
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
PDF(pdflatex)
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
pdfcopier.sh $$i $$o
\end_layout
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Copier
\end_layout
\end_layout
-\begin_layout Subsection
-Converters
+\begin_layout Standard
+Copiers are used by LyX in various of its own conversions.
+ For example, if appropriate programs are found, LyX will automatically
+ install copiers for the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+HTML
\end_layout
-\begin_layout Standard
-To define a new converter, select an existing one, select a different format
- in the
+\end_inset
+
+ and
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-From
-\begin_inset Space ~
+\begin_layout Plain Layout
+HTML
+\begin_inset space ~
\end_inset
-format
+(MS Word)
\end_layout
\end_inset
- and
-\begin_inset Space \thinspace{}
-\end_inset
+ formats.
+ When these formats are exported, the copier sees that not just the main
+ HTML file but various associated files (style files, images, etc.) are also
+ copied.
+ All these files are written to a subdirectory of the directory in which
+ the original LyX file was found.
+\begin_inset Foot
+status collapsed
-/
-\begin_inset Space \thinspace{}
+\begin_layout Plain Layout
+This copier can be customized.
+ The optional
+\begin_inset Quotes eld
\end_inset
-or
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+-e
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-To
-\begin_inset Space ~
+ argument takes a comma-separated list of extensions to be copied; if it
+ is omitted, all files will be copied.
+ The
+\begin_inset Quotes eld
\end_inset
-format
-\end_layout
+-t
+\begin_inset Quotes erd
+\end_inset
+ argument determines the extension added to the generated directory.
+ By default, it is
+\begin_inset Quotes eld
\end_inset
- drop-down list, modify the
+
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Converter
+\begin_layout Plain Layout
+LyXconv
\end_layout
\end_inset
- field, and press the
+
+\begin_inset Quotes erd
+\end_inset
+
+, so HTML generated from
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Add
+\begin_layout Plain Layout
+/path/to/filename.lyx
\end_layout
\end_inset
- button.
-\end_layout
-
-\begin_layout Standard
-You do not have to define converters between all the formats between which
- you want to convert.
- For example, you will note that there is no `LyX to PostScript' converter,
- but LyX will export PostScript.
- It does so by first creating a LaTeX file (no converter needs to be defined
- for this) which is then converted to DVI using the `LaTeX to DVI' converter,
- and finally converts the resulting DVI file to PostScript.
- LyX finds such `chains' of converters automatically, and it will always
- choose the shortest possible chain.
- You can, though, still define multiple conversion methods between file
- formats.
- For example, the standard LyX configuration provides three ways to convert
- LaTeX to PDF: Directly, using
+ will end up in
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdflatex
+\begin_layout Plain Layout
+/path/to/filename.html.LyXconv
+\end_layout
+
+\end_inset
+
+.
+
\end_layout
\end_inset
-; via (DVI and) PostScript, using
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-\begin_layout PlainLayout
-ps2pdf
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Converters"
+
\end_inset
-; or via DVI, using
+Converters
+\end_layout
+
+\begin_layout Standard
+You can define your own Converters to, uhh, convert files between different
+ formats.
+ This is done in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-dvipdfm
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
\end_inset
-.
- To define such alternate chains, you must define multiple target `file
- formats', as described in the next section.
- For example in the standard configuration the formats named
+ dialog.
+\end_layout
+
+\begin_layout Standard
+To define a new converter, select the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdf
+\begin_layout Plain Layout
+From
+\begin_inset space ~
+\end_inset
+
+format
\end_layout
\end_inset
-,
+ and
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdf2
+\begin_layout Plain Layout
+To
+\begin_inset space ~
+\end_inset
+
+format
\end_layout
\end_inset
-, and
+ from the drop-down lists, enter the command needed for the conversion,
+ and then press the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-pdf3
+\begin_layout Plain Layout
+Add
\end_layout
\end_inset
- are defined, all of which share the extension
-\begin_inset Flex CharStyle:MenuItem
+ button.
+ Several variables can be used in the definition of converters:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-.pdf
+\begin_layout Plain Layout
+$$s
\end_layout
\end_inset
-.
+ The LyX system directory
\end_layout
-\begin_layout Standard
-Several variables can be used in the definition of converters:
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$i
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-$$s The LyX system directory
+\end_inset
+
+ The input file
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$i The input file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$o
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-$$o The output file
+\end_inset
+
+ The output file
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$b The base filename of the input file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$b
+\end_layout
+
+\end_inset
+
+ The base filename of the input file (i.e., without the extension)
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-$$p The path to the input file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$p
+\end_layout
+
+\end_inset
+
+ The path to the input file
\end_layout
\begin_layout Standard
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
Extra
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
Flag
field you can enter the following flags, separated by commas:
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-latex This converter runs some form of LaTeX.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+latex
+\end_layout
+
+\end_inset
+
+ This converter runs some form of LaTeX.
This will make LyX's LaTeX error logs available.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-needaux Needs the LaTeX
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+needaux
+\end_layout
+
+\end_inset
+
+ Needs the LaTeX
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
.aux
\end_layout
file for the conversion.
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-xml Output is XML.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+xml
+\end_layout
+
+\end_inset
+
+ Output is XML.
\end_layout
\begin_layout Standard
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
key
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
=
-\begin_inset Space ~
+\begin_inset space ~
\end_inset
value
format:
\end_layout
-\begin_layout List
+\begin_layout Labeling
\labelwidthstring 00.00.0000
-parselog If set, the converter's standard error will be redirected to a
- file
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-infile.out
+\begin_layout Plain Layout
+parselog
\end_layout
\end_inset
-, and the script given as argument will be run as:
+ If set, the converter's standard error will be redirected to a file
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-script <infile.out >infile.log
+\begin_layout Plain Layout
+infile.out
\end_layout
\end_inset
-.
- The argument may contain $$s.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-resultdir The name of the directory in which the
-\emph on
-converter
-\emph default
- will dump the generated files.
- LyX will not create this directory, and it does not copy anything into
- it, though it will copy this directory to the destination.
- The argument may contain $$b, which will be replaced by the basename of
- the input and output files, respectively, when the directory is copied.
-\newline
-Note
- that resultdir and usetempdir make no sense together.
- The latter will be ignored if the former is given.
-\end_layout
+, and the script given as argument will be run as:
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout List
-\labelwidthstring 00.00.0000
-resultfile Determines the output filename and may, contain $$b.
- Sensible only with resultdir, and optional even then; if not given, it
- defaults to `index'.
+\begin_layout Plain Layout
+script <infile.out >infile.log
\end_layout
-\begin_layout Standard
-None of these last three are presently used in any of the converters that
- are installed with LyX.
- But see section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:LyX-and-Literate"
-
\end_inset
- of the Extended Features guide for some examples of how you might use parselog.
-\end_layout
-
-\begin_layout Section
-BibTeX and makeindex
-\end_layout
-
-\begin_layout Standard
-Both the bibliography generating command (default
+.
+ The argument may contain
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-bibtex
+\begin_layout Plain Layout
+$$s
\end_layout
\end_inset
-) and the index generating command (default
+.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-makeindex
+\begin_layout Plain Layout
+resultdir
\end_layout
\end_inset
- with options
+ The name of the directory in which the converter will dump the generated
+ files.
+ LyX will not create this directory, and it does not copy anything into
+ it, though it will copy this directory to the destination.
+ The argument may contain
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
--c
+\begin_layout Plain Layout
+$$b
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
+, which will be replaced by the basename of the input and output files,
+ respectively, when the directory is copied.
+\begin_inset Newline newline
+\end_inset
-\begin_layout PlainLayout
--q
+Note that resultdir and usetempdir make no sense together.
+ The latter will be ignored if the former is given.
\end_layout
-\end_inset
-
-) can be changed.
- As an alternative for
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-makeindex
+\begin_layout Plain Layout
+resultfile
\end_layout
\end_inset
-,
+ Determines the output filename and may, contain
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-xindy
+\begin_layout Plain Layout
+$$b
\end_layout
\end_inset
- can be recommended.
-
+.
+ Sensible only with resultdir and optional even then; if not given, it defaults
+ to `index'.
\end_layout
\begin_layout Standard
-The command to enter is
+None of these last three are presently used in any of the converters that
+ are installed with LyX.
+
\end_layout
-\begin_layout Quote
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+You do not have to define converters between all the formats between which
+ you want to convert.
+ For example, you will note that there is no `LyX to PostScript®' converter,
+ but LyX will export PostScript®.
+ It does so by first creating a LaTeX file (no converter needs to be defined
+ for this) which is then converted to DVI using the `LaTeX to DVI' converter,
+ and finally converting the resulting DVI file to PostScript®.
+ LyX finds such `chains' of converters automatically, and it will always
+ choose the shortest possible chain.
+ You can, though, still define multiple conversion methods between file
+ formats.
+ For example, the standard LyX configuration provides three ways to convert
+ LaTeX to PDF: Directly, using
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-makeindex.sh -m $$lang
+\begin_layout Plain Layout
+pdflatex
\end_layout
\end_inset
+; via (DVI and) PostScript®, using
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+ps2pdf
\end_layout
-\begin_layout Standard
-where the placeholder
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+; or via DVI, using
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-$$lang
+\begin_layout Plain Layout
+dvipdfm
\end_layout
\end_inset
+.
+ To define such alternate chains, you must define multiple target `file
+ formats', as described in section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Formats"
-\end_layout
-
-\begin_layout Quote
-will be replaced by the chosen document (babel) language.
- For this, you must
-\end_layout
+\end_inset
-\begin_layout Standard
-have installed the packages
-\begin_inset Flex CharStyle:Code
+.
+ For example, in the standard configuration, the formats named
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-xindy
+\begin_layout Plain Layout
+pdf
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-make-rules
+\begin_layout Plain Layout
+pdf2
\end_layout
\end_inset
- (
-\begin_inset Flex CharStyle:Code
+, and
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-xindy-make-rules
+\begin_layout Plain Layout
+pdf3
\end_layout
\end_inset
-).
- Type
-\begin_inset Flex CharStyle:Code
+ are defined, all of which share the extension
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-makeindex.sh
+\begin_layout Plain Layout
+.pdf
\end_layout
\end_inset
- at a shell prompt for a help page.
+, and which correspond to the conversion methods just mentioned.
\end_layout
\begin_layout Section
-Plain text export options
+Output
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
+The settings in this section affect the output LyX produces.
+\end_layout
+\begin_layout Subsection
+Plain text export options
\end_layout
\begin_layout Standard
\end_inset
exported plain text files.
- Note that LyX automatically detects and uses the best settings for your
- system at installation time, but you can modify them if you disagree with
- its interpretation.
+ Note that LyX automatically detects and tries to use the best settings
+ for your system at installation time, but you can modify them in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Output\SpecialChar \menuseparator
+Plain Text
+\end_layout
+
+\end_inset
+
+ dialog if you disagree with its interpretation.
\end_layout
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Plain text
-\begin_inset Space ~
-\end_inset
-
-roff
+\begin_layout Plain Layout
+roff command
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
groff/troff/nroff
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Plain text
-\begin_inset Space ~
-\end_inset
-
-line
-\begin_inset Space ~
-\end_inset
-
-length
+\begin_layout Plain Layout
+Output line length
\end_layout
\end_inset
With this command you can set the default line length of the plain text
output file.
- Setting it to 0 means endless lines.
+ Setting it to 0 means that no line breaks will be inserted except between
+ paragraphs and the like.
\end_layout
\begin_layout Section
-Printer
+The rest
\end_layout
\begin_layout Standard
-There are a bunch of configuration options that are used for interaction
- with the external print command from LyX.
- Normally the defaults are fine: if, however, your print command takes different
- option names, you can modify them here.
-\end_layout
+There are many other configuration options that can be used to customize
+ LyX behavior.
+ Most of them are sufficiently self-explanatory that we have not felt it
+ necessary to document them here.
+ Please ask on the
+\begin_inset CommandInset href
+LatexCommand href
+name "mailing lists"
+target "http://www.lyx.org/mailing.php"
-\begin_layout Subsection
-Changing Colors
+\end_inset
+
+ if you need some more information.
\end_layout
-\begin_layout Standard
-You can change the colors used by LyX on-screen using the new
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-Preferences
-\end_layout
+\begin_layout Chapter
+Internationalizing LyX
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:i18n"
\end_inset
- dialog.
- Alternatively, if you're feeling particularly perverse you could use the
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-set-color
\end_layout
-\end_inset
-
- bindable function (see the
+\begin_layout Standard
+LyX supports using a translated interface.
+ Last time we checked, LyX provided text in thirty languages.
+ The language of choice is called your
\emph on
-Reference Guide
+locale
\emph default
-).
- Input would have the format:
-\end_layout
+.
+ (For further reading on locale settings, see also the documentation for
+ locale that comes with your operating system.
+ For Linux, the manual page for
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-set-color LyXName X11Color
+\begin_layout Plain Layout
+locale(5)
\end_layout
-\begin_layout Standard
-Here is a (partial) list of the functions and default colors:
+\end_inset
+
+ could be a good place to start).
\end_layout
\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="10" columns="3">
-<features>
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<row>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+Notice that these translations will work, but do contain a few flaws.
+ In particular, all dialogs have been designed with the English text in
+ mind, which means that some of the translated text will be too large to
+ fit within the space allocated.
+ This is only a display problem and will not cause any harm.
+ Also, you will find that some of the translations do not define shortcut
+ keys for everything.
+ Sometimes, there are simply not enough free letters to do it.
+ Other times, the translator just hasn't got around to doing it yet.
+ Our localization team, which you may wish to join,
+\begin_inset Foot
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-LyX Name
+\begin_layout Plain Layout
+If you are a fluent speaker of a language other than English, joining these
+ teams is a great way to give back to the LyX community!
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ will of course try to fix these shortcomings in future versions of LyX.
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Purpose
+\begin_layout Section
+Translating LyX
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Subsection
+Translating the graphical user interface (text messages).
+\end_layout
-\begin_layout PlainLayout
+\begin_layout Standard
+LyX uses the GNU
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Default Color (X11)
+\begin_layout Plain Layout
+gettext
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ library to handle the internationalization of the interface.
+ To have LyX speak your favorite language in all menus and dialogs, you
+ need a
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-background
+\begin_layout Plain Layout
+po
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+-file for that language.
+ When this is available, you'll have to generate a
+\begin_inset Flex CharStyle:Code
+status open
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-text background
+\begin_layout Plain Layout
+mo
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+-file from it and install the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-black
+\begin_layout Plain Layout
+mo
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+-file.
+ The process of doing all of this is explained in the documentation for
+ GNU
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-foreground
+\begin_layout Plain Layout
+gettext
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+.
+ It is possible to do this just for yourself, but if you're going to do
+ it, you might as well share the results of your labors with the rest of
+ the LyX community.
+ Send a message to the LyX developers' list for more information about how
+ to proceed.
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-text foreground
+\begin_layout Standard
+In short, this is what you should do (xx denotes the language code):
\end_layout
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Itemize
+Check out the LyX source code.
+ (See the
+\begin_inset CommandInset href
+LatexCommand href
+name "information on the web"
+target "http://www.lyx.org/devel/cvs.php"
-\begin_layout PlainLayout
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-linen
+.)
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+\begin_layout Itemize
+Copy the file
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-latex
+\begin_layout Plain Layout
+lyx.pot
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ to the folder of the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-LaTeX code
+\begin_layout Plain Layout
+**.po
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ files.
+ Then rename it to
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-DarkRed
+\begin_layout Plain Layout
+xx.po
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+.
+ (If
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-math
+\begin_layout Plain Layout
+lyx.pot
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ doesn't exist anywhere, it can be remade with the console command
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mathed formulae
+\begin_layout Plain Layout
+make lyx.pot
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ in that directory, or you can use an existing po-file for some other language
+ as a template).
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-DarkBlue
+\begin_layout Itemize
+Edit
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+xx.po
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+.
+\begin_inset Foot
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-mathline
+\begin_layout Plain Layout
+This is just a text file, so it can be edited in any text editor.
+ But there are also specialized programs that support such editing, such
+ as
+\family typewriter
+Poedit
+\family default
+ (for all platforms) or
+\family typewriter
+KBabel
+\family default
+ (for KDE).
+
+\family typewriter
+Emacs
+\family default
+ contains a `mode' for editing
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+po
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-fraction Lines, brackets, etc.
+ files, as well.
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Blue
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+ For some menu- and widget-labels, there are also shortcut keys that should
+ be translated.
+ Those keys are marked after a `|', and should be translated according to
+ the words and phrases of the language.
+ You should also fill also out the information at the beginning of the new
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-mathbg
+\begin_layout Plain Layout
+po
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+-file with your email-address, etc., so people know where to reach you with
+ suggestions and entertaining flames.
\end_layout
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+If you are just doing this on your own, then:
+\end_layout
-\begin_layout PlainLayout
+\begin_layout Itemize
+Generate
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-AntiqueWhite
+\begin_layout Plain Layout
+xx.mo
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+.
+ This can be done with
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-mathframe
+\begin_layout Plain Layout
+msgfmt -o xx.mo < xx.po
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+.
\end_layout
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+\begin_layout Itemize
+Copy the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Magenta
+\begin_layout Plain Layout
+mo
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+-file to your locale-tree, at the correct directory for application messages
+ for the language
+\series bold
+
+\series default
+xx, and under the name
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-mathcursor
+\begin_layout Plain Layout
+lyx.mo
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
+ (e.g.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+/usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout PlainLayout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-black
+\series bold
+.
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
+\begin_layout Standard
+As said, however, it would be best if the new
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-selection
+\begin_layout Plain Layout
+po
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout PlainLayout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-selection background
+-file could be added to the LyX distribution, so others can use it.
+ Adding it involves making additional changes to LyX.
+ So send an email to the developers' mailing list if you're interested in
+ doing that.
\end_layout
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Subsubsection
+Ambigous messages
+\end_layout
-\begin_layout PlainLayout
+\begin_layout Standard
+Sometimes it turns out that one English message needs to be translated into
+ different messages in the target language.
+ One example is the message
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-LightBlue
+\begin_layout Plain Layout
+To
\end_layout
\end_inset
-</cell>
-</row>
-</lyxtabular>
+ which has the German translation
+\lang german
+Nach
+\lang english
+ or
+\lang german
+Bis
+\lang english
+, depending upon exactly what the English
+\begin_inset Quotes eld
\end_inset
+to
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ means.
+ GNU
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Section
-The autodetected settings
+\begin_layout Plain Layout
+gettext
\end_layout
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:autodetected-1"
-
\end_inset
-There are several items that are detected for you when you run
-\begin_inset Flex CharStyle:MenuItem
+ does not handle such ambigous translations.
+ Therefore you have to add some context information to the message: Instead
+ of
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\bar under
-T
-\bar default
-ools
-\bar under
-\SpecialChar \menuseparator
-R
-\bar default
-econfigure
+\begin_layout Plain Layout
+To
\end_layout
\end_inset
-.
- In this section, we list those which pertain to the user preferences.
-\end_layout
-
-\begin_layout Description
+ it becomes
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-plaintext_roff_command
+\begin_layout Plain Layout
+To[[as in 'From format x to format y']]
\end_layout
\end_inset
- uses either
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-groff
+\begin_layout Plain Layout
+To[[as in 'From page x to page y']].
\end_layout
\end_inset
- or
+ Now the two occurences of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-nroff
+\begin_layout Plain Layout
+To
\end_layout
\end_inset
-+
+ are different for
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-tbl
+\begin_layout Plain Layout
+gettext
\end_layout
\end_inset
-, depending on what is available.
+ and can be translated correctly to
+\lang german
+Nach
+\lang english
+ and
+\lang german
+Bis
+\lang english
+, respectively.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Of course the context information needs to be stripped off the original
+ message when no translation is used.
+ Therefore you have to put it in double square brackets at the end of the
+ message (see the example above).
+ The translation mechanism of LyX ensures that everything in double square
+ brackets at the end of messages is removed before displaying the message.
+\end_layout
+
+\begin_layout Subsection
+Translating the documentation.
+\end_layout
+
+\begin_layout Standard
+The online documentation (in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\backslash
-chktex_command
+\bar under
+H
+\bar default
+elp
\end_layout
\end_inset
- is set to
-\begin_inset Flex CharStyle:Code
+-menu) can (and should!) be translated.
+ If there are translated versions of the documentation available
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-chktex
+\begin_layout Plain Layout
+As of March 2008, at least some of the documents have been translated into
+ fourteen languages, with the Tutorial available in a few more.
\end_layout
\end_inset
- plus a bunch of options.
-\end_layout
-
-\begin_layout Description
+ and the locale is set accordingly, these will be used automagically by
+ LyX.
+ LyX looks for translated versions as
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-print_spool_command
+\begin_layout Plain Layout
+LyXDir/doc/xx_DocName.lyx
\end_layout
\end_inset
- is set to
+, where
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lp
+\begin_layout Plain Layout
+xx
\end_layout
\end_inset
- on systems (so-called System V) who have this command, and
+ is the code for the language currently in use.
+ If there are no translated documents, the default English versions will
+ be displayed.
+ Note that the translated versions must have the same filenames (
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lpr
+\begin_layout Plain Layout
+DocName
\end_layout
\end_inset
- otherwise (BSD systems).
+ above) as the original.
+ If you feel up to translating the documentation (an excellent way to proof-read
+ the original documentation by the way!), there are a few things you should
+ do right away:
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+Read
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-print_spool_printerprefix
+\begin_layout Plain Layout
+DocStyle.lyx
\end_layout
\end_inset
- is set to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
--d
+, the guide to writing LyX documentation.
+ Pay special attention to the translator's section.
\end_layout
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
--P
-\end_layout
+\begin_layout Itemize
+Check out the documentation translation web page at
+\begin_inset CommandInset href
+LatexCommand href
+name "http://www.devel.lyx.org"
+target "http://www.devel.lyx.org"
\end_inset
-, depending on whether
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-lp
+.
+ That way, you can find out which (if any) documents have already been translate
+d into your language.
+ You can also find out who (if anyone) is organizing the effort to translate
+ the documentation into your language.
+ If no one is organizing the effort, please let us know that you're interested.
\end_layout
-\end_inset
+\begin_layout Standard
+Once you get to actually translating, here's a few hints for you that may
+ save you trouble:
+\end_layout
- or
+\begin_layout Itemize
+Join the documentation team! There is information on how to do that in
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lpr
+\begin_layout Plain Layout
+Intro.lyx
\end_layout
\end_inset
- was found.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ (
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\backslash
-font_encoding
+\bar under
+H
+\bar default
+elp\SpecialChar \menuseparator
+
+\bar under
+I
+\bar default
+ntroduction
\end_layout
\end_inset
- is set to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-T1
+), which by the way is the first document you should translate.
\end_layout
-\end_inset
+\begin_layout Itemize
+Learn the typographic conventions for the language you are translating to.
+ Typography is an ancient art and over the centuries, a great variety of
+ conventions have developed throughout different parts of the world.
+ Also study the professional terminology amongst typographers in your country.
+ Inventing your own terminology will only confuse the users.
+
+\emph on
+(Warning! Typography is addictive!)
+\end_layout
- if the
+\begin_layout Itemize
+Make a copy of the document.
+ This will be your working copy.
+ You can use this as your personal translated help-file by placing it in
+ your
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-ec
+\begin_layout Plain Layout
+UserDir/doc/
\end_layout
\end_inset
- fonts are found and LaTeX has support for these fonts built-in.
- You can set it manually if you only have the so-called
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-dc
+ directory.
\end_layout
-\end_inset
+\begin_layout Itemize
+Sometimes the original document (from the LyX-team) will be updated.
+ Use the source viewer at
+\begin_inset CommandInset href
+LatexCommand href
+name "http://www.lyx.org/trac/timeline"
+target "http://www.lyx.org/trac/timeline"
- fonts.
-\end_layout
+\end_inset
-\begin_layout Section
-The rest
+ to see what has been changed.
+ That way you can easily see which parts of the translated document need
+ to be updated.
\end_layout
\begin_layout Standard
-There are many other configuration options that can be used to customize
- LyX behavior.
- We still need to document them here, but again, most should be fairly obvious.
- Please ask on the mailing lists if you need some more information; it may
- even prompt us to expand this section.
+If you ever find an error in the original document, fix it and notify the
+ rest of the documentation team of the changes! (You didn't forget to join
+ the documentation team, did you?)
\end_layout
-\begin_layout Chapter
-Internationalizing LyX
-\begin_inset CommandInset label
-LatexCommand label
-name "chap:i18n"
-
-\end_inset
-
+\begin_layout Standard
+\begin_inset Branch OutDated
+status collapsed
+\begin_layout Section
+International Keyboard Support
\end_layout
\begin_layout Standard
-LyX supports using a translated interface.
- Last time we checked, LyX provided text in 14 languages together with the
- default English text.
- The language of choice is called your
+
\emph on
-locale
+[Editor's Note: The following section is by
\emph default
+
+\shape smallcaps
+\emph on
+Ivan Schreter
+\shape default
.
- (For further reading on locale settings, see also the documentation for
- locale that comes with your operating system.
- For Linux, the manual page for locale(5) could be a good place to start).
+ It needs to be fixed to conform to the new Documentation Style sheet and
+ to make use of the new v1.0 features.
+ The whole thing also needs to be merged with the section following it.-jw
+ It may also be badly out of date.-rh (2008)]
+\end_layout
+
+\begin_layout Subsection
+Defining Own Keymaps: Keymap File Format
\end_layout
\begin_layout Standard
-Notice that these translations will work, but do contain a few flaws.
- In particular, all dialogs have been designed with the English text in
- mind, which means that some of the translated text will be too large to
- fit within the space allocated.
- This is only a display problem and will not cause any harm.
- Also, you will find that some of the translations do not define short-cut
- keys for everything.
- Sometimes, there are simply not enough free letters to do it.
- Other times, the translator just hasn't got around to doing it yet.
- Our localization team -- which you may wish to join -- will try to fix
- these shortcomings in future versions of LyX.
+Let's look at a keyboard definition file a little closer.
+ It is a plain text file defining
\end_layout
-\begin_layout Section
-Selecting an alternative language for the user interface
+\begin_layout Itemize
+key-to-key or key-to-string translations
\end_layout
-\begin_layout Standard
-This feature is disabled by default, meaning that system default language
- will be used.
- To enable an alternative language, you have to set an appropriate environment
- variable.
- Use
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Itemize
+dead keys
+\end_layout
-\begin_layout PlainLayout
-"setenv LANG xx"
+\begin_layout Itemize
+dead keys exceptions
\end_layout
-\end_inset
+\begin_layout Standard
+To define key-to-key or key-to-string translation, use this command:
+\end_layout
-
-\family roman
-for csh class shells
-\family default
- or
+\begin_layout Quotation
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-"export LANG=xx"
+\begin_layout Plain Layout
+
+\backslash
+kmap
\end_layout
\end_inset
-\family roman
-for sh class shells
-\family default
-.
- Substitute the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-xx
+\begin_layout Plain Layout
+key
\end_layout
\end_inset
- with the two letter code (or four letter code, like
+ outstring
+\end_layout
+
+\begin_layout Standard
+where
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-en_GB
+\begin_layout Plain Layout
+key
\end_layout
\end_inset
- for British English) for the language you want.
- For instance,
+ is the key to be translated and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-no
+\begin_layout Plain Layout
+outstring
\end_layout
\end_inset
- is Norwegian.
- Besides the user interface texts being translated, also the appropriate
- manuals will be presented under the Help menu -- if available.
+ is the string to be inserted into the document.
+ To define dead keys, use:
\end_layout
-\begin_layout Standard
-On some systems, you may have to redefine
+\begin_layout Quotation
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-LC_ALL
+\begin_layout Plain Layout
+
+\backslash
+kmod
\end_layout
\end_inset
- or
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-LC_MESSAGES
+\begin_layout Plain Layout
+key
\end_layout
\end_inset
- instead of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LANG
+ deadkey
\end_layout
-\end_inset
-
-, to override the system settings; their preference is in this order
-\begin_inset Foot
+\begin_layout Standard
+where
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-The shell variable LANGUAGE has been disabled in LyX for technical reasons.
- Don't use it.
+\begin_layout Plain Layout
+key
\end_layout
\end_inset
-, which corresponds to the way GNU
+ is a keyboard key and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-gettext
+\begin_layout Plain Layout
+deadkey
\end_layout
\end_inset
- does it.
- Consult your system documentation.
- Normally, you'll want to put the appropriate line in a shell script run
- on start-up, so that the translation is on by default.
- Remember that this affects
-\emph on
-all
-\emph default
- localized packages, not only LyX!
+ is dead key name.
+ The following dead keys are supported (shortcut name is in parentheses):
\end_layout
-\begin_layout Standard
-If LyX is configured and compiled with
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
-status collapsed
+\emph on
+Name
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout PlainLayout
---disable-nls
+Example
\end_layout
+\begin_layout Quotation
+acute (acu)
+\begin_inset space \hfill{}
\end_inset
+áéíóú
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Quotation
+grave (gra)
+\begin_inset space \hfill{}
\end_inset
-, this mechanism will not work.
+àèìòù
\end_layout
-\begin_layout Section
-Translating LyX
-\end_layout
+\begin_layout Quotation
+macron (mac)
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Subsection
-Translating the graphical user interface (text messages).
+ ō
\end_layout
-\begin_layout Standard
-LyX uses the GNU
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Quotation
+tilde (til)
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout PlainLayout
-gettext
+ñÑ
\end_layout
+\begin_layout Quotation
+underbar (underb)
+\begin_inset space \hfill{}
\end_inset
- library to handle the internationalization of the interface.
- To have LyX speak your favorite language in all menus and dialogs, you
- need a
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-po
-\end_layout
+\begin_inset ERT
+status open
-\end_inset
+\begin_layout Plain Layout
--file for that language.
- When this is available, you'll have to generate a mo-file from it and install
- the
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-mo
+\backslash
+b o
\end_layout
\end_inset
--file.
- The process of doing all of this is explained in the documentation for
- GNU
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-gettext
\end_layout
+\begin_layout Quotation
+cedilla (ced)
+\begin_inset space \hfill{}
\end_inset
-.
- You should also read the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-LYX-SOURCE-DIR/README.localisation
+çÇ
\end_layout
+\begin_layout Quotation
+underdot (underd)
+\begin_inset space \hfill{}
\end_inset
- file, but in short, this is what you do (
-\series bold
-xx
-\series default
- denotes the language code):
-\end_layout
-\begin_layout Standard
\begin_inset ERT
status open
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\backslash
-begin{sloppypar}
+d o
\end_layout
\end_inset
\end_layout
-\begin_layout Itemize
-Copy
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Quotation
+circumflex (circu)
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout PlainLayout
-LYX-SOURCE-DIR/po/lyx.pot
+âêîôû
\end_layout
+\begin_layout Quotation
+circle (circl)
+\begin_inset space \hfill{}
\end_inset
- to
-\series bold
-xx
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-.po
+ÅůŮ
\end_layout
+\begin_layout Quotation
+tie (tie)
+\begin_inset space \hfill{}
\end_inset
- (if
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-lyx.pot
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+t o
\end_layout
\end_inset
- doesn't exist, it can be remade with
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-make lyx.pot
\end_layout
+\begin_layout Quotation
+breve (bre)
+\begin_inset space \hfill{}
\end_inset
- in that directory, or you can use an existing po-file for some other language
- as a template).
-\end_layout
+ă
+\begin_inset ERT
+status open
-\begin_layout Itemize
-Edit
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Plain Layout
-\begin_layout PlainLayout
-xx.po
-\begin_inset Foot
-status collapsed
-\begin_layout PlainLayout
-We recommend that you use Emacs to do this, since the
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+u o
+\end_layout
+
+\end_inset
+
-\begin_layout PlainLayout
-gettext
\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
- distribution includes a nice mode that supports you in doing this.
+äöü
\end_layout
+\begin_layout Quotation
+dot (dot)
+\begin_inset space \hfill{}
\end_inset
-.
- For some menu- and widget-labels, there are also shortcut keys that should
- be translated.
- Those keys are marked after a `|', and should be translated according to
- the words and phrases of the
-\series bold
-xx
-\series default
--language.
- You should also fill also out the information at the beginning of the new
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+ż
+\begin_inset ERT
+status open
-\begin_layout PlainLayout
-po
+\begin_layout Plain Layout
+
+
+\backslash
+.s
\end_layout
\end_inset
--file with your email-address, etc., so people know where to reach you with
- suggestions and entertaining flames.
+
\end_layout
-\begin_layout Itemize
-Generate
-\series bold
-xx
-\series default
+\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
-.mo
+\begin_layout Plain Layout
+
+\backslash
+kxmod
\end_layout
\end_inset
-.
- This can be done with
+ deadkey key outstring
+\end_layout
+
+\begin_layout Standard
+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
-msgfmt -o
+\begin_layout Plain Layout
+
+\backslash
+kxmod
\end_layout
\end_inset
-
-\series bold
-xx
-\series default
+ caron o "
+\backslash
+^o"
+\end_layout
+
+\begin_layout Standard
+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 Standard
+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
-.mo <
+\begin_layout Plain Layout
+#
\end_layout
\end_inset
+ have different meaning.
-\series bold
-xx
-\series default
-.po
-\end_layout
-
-\begin_layout Itemize
-Copy the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-mo
+\begin_layout Plain Layout
+#
\end_layout
\end_inset
-
-\series bold
--
-\series default
-file to your locale-tree, at the correct directory for application messages
- for the language
-\series bold
- xx
-\series default
-, and under the name
+ 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
-lyx.mo
+\begin_layout Plain Layout
+
+\backslash
+"
\end_layout
\end_inset
- (e.g.
-
+, to enter
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-/usr/local/share/locale/
+\begin_layout Plain Layout
+#
\end_layout
\end_inset
-
-\series bold
-xx
+, use
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-/LC_MESSAGES/lyx.mo
+\begin_layout Plain Layout
+
+\backslash
+#
\end_layout
\end_inset
-)
+.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+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 PlainLayout
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
\backslash
-end{sloppypar}
+kinclude filename
\end_layout
\end_inset
-\end_layout
-
-\begin_layout Standard
-Adding a new po-file to the
\emph on
-distribution
-\emph default
- of LyX involves altering the configure scripts and more, but the way
+
+\begin_inset space \hfill{}
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-gettext
+\begin_layout Plain Layout
+include
\end_layout
\end_inset
- works, you don't actually need the source-code of LyX to translate it---having
-
+ another file
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lyx.pot
+\begin_layout Plain Layout
+
+\backslash
+kprog program
\end_layout
\end_inset
- (or an existing
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-po
-\end_layout
+\emph on
+\begin_inset space \hfill{}
\end_inset
--file) and the
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-gettext
+\begin_layout Plain Layout
+define
\end_layout
\end_inset
- tools suffices.
-\end_layout
-
-\begin_layout Standard
-If you've written a translation file for a language that LyX does not currently
- support, feel free to submit it for inclusion by sending a patch.
-
-\end_layout
-
-\begin_layout Subsubsection
-Ambigous messages
+ an external keymap translation program
\end_layout
\begin_layout Standard
-Sometimes it turns out that one english message needs to be translated into
- different messages in the target language.
- One example is the message
+Also, it should look into
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-To
+\begin_layout Plain Layout
+lyxrc
\end_layout
\end_inset
- which has the german translation
-\lang german
-Nach
-\lang english
- or
+ file for defaults, too (for example, a
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\lang german
-Bis
+\backslash
+kinclude
\end_layout
\end_inset
-.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-gettext
+ option to include default keyboard).
\end_layout
\end_inset
- does not handle such ambigous translations.
- Therefore you have to add some context information to the message: Instead
- of
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-To
\end_layout
-\end_inset
-
- it becomes
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-To[[as in 'From format x to format y']]
-\end_layout
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:keymap"
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-To[[as in 'From page x to page y']].
+International Keymap Stuff
\end_layout
-\end_inset
-
- Now the two occurences of
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+\begin_inset Note Note
+status open
-\begin_layout PlainLayout
-To
+\begin_layout Plain Layout
+In doing the revisions on this document in March 2008, I did not look over
+ this stuff, as I do not understand it.
+ It would be good if someone else could do so.
\end_layout
\end_inset
- are different for
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-gettext
\end_layout
-\end_inset
-
- and can be translated correctly to
+\begin_layout Standard
+The next two sections describe the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\lang german
-Nach
+\shape up
+.kmap
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\lang german
-Bis
+\shape up
+.cdef
\end_layout
\end_inset
-, respectively.
-\end_layout
-
-\begin_layout Standard
-Of course the context information needs to be stripped off the original
- message when no translation is used.
- Therefore you have to put it in double square brackets at the end of the
- message (see the example above).
- The translation mechanism of LyX ensures that everything in double square
- brackets at the end of messages is removed before displaying the message.
+ 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
-Translating the documentation.
+The .kmap File
\end_layout
\begin_layout Standard
-The online documentation (in the
-\begin_inset Flex CharStyle:MenuItem
+A
+\shape up
+.
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\bar under
-H
-\bar default
-elp
+\begin_layout Plain Layout
+kmap
\end_layout
\end_inset
--menu) can (and should!) be translated.
- If there are translated versions of the documentation available
-\begin_inset Foot
+ 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
-As of February 2003, almost all of the docs have been translated into German
- and French.
- The
-\emph on
-Tutorial
-\emph default
- has been translated into at least 12 other languages, with other translations
- in progress.
- The library of translated documents is growing rapidly.
+\begin_layout Plain Layout
+.kmap
\end_layout
\end_inset
-, and the locale is set accordingly, these will be used automagically by
- LyX.
- LyX looks for translated versions as
+
+\shape default
+ file keywords
+\shape up
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-LyXDir/doc/
-\series bold
-xx
-\series default
-_DocName.lyx
+\begin_layout Plain Layout
+
+\shape up
+kmap
\end_layout
\end_inset
-, where
+
+\shape default
+,
+\shape up
+
+\shape default
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\series bold
-xx
+\shape up
+kmod
\end_layout
\end_inset
- denotes the language as set by the environmental variable
+,
+\shape up
+
+\shape default
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-$LANG
+\begin_layout Plain Layout
+
+\shape up
+ksmod
\end_layout
\end_inset
-.
- If there are none, the default English versions will be displayed.
- Note that the translated versions must have the same filenames (
+, and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-DocName
+\begin_layout Plain Layout
+
+\shape up
+kcomb
\end_layout
\end_inset
- above) as the original.
- If you feel up to translating the documentation (an excellent way to proof-read
- the original documentation BTW!), there are a few things you should do
- right away:
+ are described in this section.
\end_layout
-\begin_layout Itemize
-Read
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-DocStyle.lyx
+\begin_layout Plain Layout
+
+\shape up
+kmap
\end_layout
\end_inset
-, the guide to writing LyX documentation.
- Pay special attention to the translator's section.
+ Map a character to a string
\end_layout
-\begin_layout Itemize
-Check out the documentation translation web page at
-\begin_inset Flex URL
-status collapsed
-
-\begin_layout PlainLayout
+\begin_layout LyX-Code
-http://www.devel.lyx.org
+\backslash
+kmap
+\family roman
+\emph on
+char
+\family default
+\emph default
+
+\family roman
+\emph on
+string
\end_layout
-\end_inset
+\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
.
- That way, you can find out which (if any) documents have already been translate
-d into your language.
- You can also find out who (if anyone) is organizing the effort to translate
- the documentation into your language.
- If no one is organizing the effort, please let us know that you're interested.
\end_layout
\begin_layout Standard
-Once you get to actually translating, here's a few hints for you that may
- save you trouble:
+An example of a
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+
+\shape up
+kmap
\end_layout
-\begin_layout Itemize
-Join the documentation team! There is information on how to do that in
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ statement to cause the symbol
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-Intro.lyx
+\begin_layout Plain Layout
+
+\shape up
+/
\end_layout
\end_inset
- (
+ to be output for the keystroke
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
+\begin_layout Plain Layout
-\bar under
-I
-\bar default
-ntroduction
+\shape up
+&
\end_layout
\end_inset
-), which by the way is the first document you should translate.
+ is:
\end_layout
-\begin_layout Itemize
-Learn the typographic conventions for the language you are translating to.
- Typography is an ancient art and over the centuries, a great variety of
- conventions have developed throughout different parts of the world.
- Also study the professional terminology amongst typographers in your country.
- Inventing your own terminology will only confuse the users.
-
-\emph on
-(Warning! Typography is addictive!)
-\end_layout
-
-\begin_layout Itemize
-Make a copy of the document.
- This will be your working copy.
- You can use this as your personal translated help-file by placing it in
- your
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-~/.lyx/doc/
-\end_layout
-
-\end_inset
+\begin_layout LyX-Code
--directory.
+\backslash
+kmap & /
\end_layout
-\begin_layout Itemize
-Sometimes the original document (from the LyX-team) will be updated.
- Use the ViewCVS tool available at
-\begin_inset Flex URL
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-http://www.lyx.org/viewcvs.cgi/lyxdoc/
-\end_layout
-
-\end_inset
-
- to see what has been changed
-\begin_inset Foot
-status collapsed
+\begin_layout Plain Layout
-\begin_layout PlainLayout
-Alternatively, you can keep a copy of the latest version of the English
- document which you've translated.
+\shape up
+kmod
\end_layout
\end_inset
-.
- That way you can easily see which parts of the translated document need
- to be updated.
+ Specify an accent character
\end_layout
-\begin_layout Itemize
-If you ever find an error in the original document, fix it and notify the
- rest of the documentation team of the changes! (You didn't forget to join
- the documentation team did you?)
-\end_layout
+\begin_layout LyX-Code
-\begin_layout Section
-International Keyboard Support
+\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
-[Editor's Note: The following section is by
+char
+\family default
\emph default
-\shape smallcaps
+\family roman
+\shape up
\emph on
-Ivan Schreter
+be an accent
+\family default
\shape default
-.
- It needs to be fixed to conform to the new Documentation Style sheet and
- to make use of the new v1.0 features.
- The whole thing also needs to be merged with the section following it.-jw]
-\end_layout
-
-\begin_layout Subsection
-Defining Own Keymaps: Keymap File Format
-\end_layout
-
-\begin_layout Standard
-Let's look at a keyboard definition file a little closer.
- It is a plain text file defining
-\end_layout
+\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 Itemize
-key-to-key or key-to-string translations
+\begin_layout Plain Layout
+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
-\begin_layout Itemize
-dead keys
-\end_layout
+\end_inset
-\begin_layout Itemize
-dead keys exceptions
+ mechanism.
+
\end_layout
\begin_layout Standard
-To define key-to-key or key-to-string translation, use this command:
-\end_layout
+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.
-\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
+\family default
+ Note that a
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\backslash
-kmap
+\shape up
+Backspace
\end_layout
\end_inset
+ cancels a dead key, so if
+\family roman
+you hit
+\family default
-\begin_inset Flex CharStyle:Code
+\family roman
+\emph on
+char
+\family default
+\emph default
+
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-key
+\begin_layout Plain Layout
+
+\shape up
+\emph on
+Backspace
\end_layout
\end_inset
- outstring
+, 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
-where
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-key
-\end_layout
-
-\end_inset
-
- is the key to be translated and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-outstring
+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
-\end_inset
+\begin_layout LyX-Code
- is the string to be inserted into the document.
- To define dead keys, use:
+\backslash
+kmod ' acute aeiouAEIOU
\end_layout
-\begin_layout Quotation
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-kmod
+\begin_layout Plain Layout
+ksmod
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-key
+ Specify an exception to the accent character
\end_layout
-\end_inset
+\begin_layout LyX-Code
- deadkey
+\backslash
+kxmod
+\family roman
+\emph on
+accent char result
\end_layout
-\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
-
+\begin_layout Standard
+This defines an exce
+\family roman
+ption for
+\family default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-quote-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-s
-\end_layout
-
-\end_inset
-
+\family roman
+\emph on
+accent
+\family default
+\emph default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-command-sequence math-insert ^;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
-u
-\end_layout
-
-\end_inset
-
+\family roman
+on
+\family default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-command-sequence math-insert _;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
-
-t
-\end_layout
-
-\end_inset
-
+\family roman
+\emph on
+char
+\emph default
+.
+ T
+\shape up
+he
+\family default
+\shape default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-insert_file 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
-
+\family roman
+\shape up
+\emph on
+accent
+\family default
+\shape default
+\emph default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-file-insert-plaintext
-\end_layout
-
-\end_inset
-
- lines
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-p
-\end_layout
-
-\end_inset
-
+\family roman
+\shape up
+must
+\family default
+\shape default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-file-insert-plaintext paragraphs
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-x
-\end_layout
-
-\end_inset
-
+\shape up
+have been assigned a keystroke with a previous
+\shape default
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-file-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Plain Layout
-\begin_layout PlainLayout
-M-i
-\begin_inset Space ~
-\end_inset
+\shape up
-u
+\backslash
+kmo
+\shape default
+d
\end_layout
\end_inset
+ declar
+\family roman
+ation and
+\family default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-url-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
-
-w
-\end_layout
-
-\end_inset
-
+\family roman
+\emph on
+char
+\family default
+\emph default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-index-insert-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-i
-\begin_inset Space ~
-\end_inset
-
-x
-\end_layout
-
-\end_inset
-
+\family roman
+must not belong in the
+\family default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-external-insert
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-Layout
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
-
-a
-\end_layout
-
-\end_inset
-
+\family roman
+\emph on
+allowed
+\family default
+\emph default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-appendix
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
-
-b
-\end_layout
-
-\end_inset
-
+\family roman
+set of
+\family default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-font-bold
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
-
-c
-\end_layout
-
-\end_inset
-
+\family roman
+\emph on
+accent
+\emph default
+.
+ When
+\family default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout-character
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
-
-d
-\end_layout
-
-\end_inset
-
+\family roman
+\shape up
+you enter the
+\family default
+\shape default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout-document
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
-
-e
-\end_layout
-
-\end_inset
-
+\family roman
+\shape up
+\emph on
+accent char
+\family default
+\shape default
+\emph default
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-font-emph
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-l
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-l
+\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
-layout-preamble
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Plain Layout
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
+\shape up
-n
+\backslash
+kmod
\end_layout
\end_inset
+ declaration.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-font-noun
\end_layout
-\end_inset
-
-
+\begin_layout Standard
+The following command produces causes äi to be produced when you enter acute-i
+ ('i):
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
+\backslash
+kxmod acute i "
+\backslash
-p
-\end_layout
+\backslash
+'{
+\backslash
-\end_inset
+\backslash
+i}"
+\end_layout
-
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout-paragraph
+\begin_layout Plain Layout
+kcomb
\end_layout
\end_inset
-
+ Combine two accent characters
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
+\begin_layout LyX-Code
-s
+\backslash
+kcomb
+\family roman
+\emph on
+accent1 accent2 allowed
\end_layout
-\end_inset
-
+\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
-layout-save-default
-\end_layout
-
-\end_inset
+\begin_layout Plain Layout
+\shape up
+\backslash
+kmod
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
\end_inset
-t
+ 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
-\end_inset
-
-
+\begin_layout Standard
+Consider this example from the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout-tabular
+\begin_layout Plain Layout
+
+\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 List
-\labelwidthstring 00.00.0000
+\begin_layout Standard
+This allows you to press
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-l
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-v
+\shape up
+;:i
\end_layout
\end_inset
-
+ and get the effect of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-depth-increment
-\end_layout
-
-\end_inset
+\begin_layout Plain Layout
+\shape up
+\backslash
+'{
+\backslash
+"{i}}
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\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
-M-l
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-x
+\shape up
+;: Backspace i
\end_layout
\end_inset
-
+ you get
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-tex-mode
-\end_layout
-
-\end_inset
-
-
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsubsection
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\shape up
-\begin_layout PlainLayout
-Layout\SpecialChar \menuseparator
-Character
+\backslash
+'{i}
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Subsection
+The .cdef File
+\end_layout
+
+\begin_layout Standard
+After the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-b
+\shape up
+.kmap
\end_layout
\end_inset
-
+ mapping is performed, a
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-bold
+\begin_layout Plain Layout
+
+\shape up
+.cde
+\shape default
+f
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ 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
-M-c
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-c
+\shape up
+iso8859-1.cdef
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-noun
+\begin_layout Plain Layout
+
+\shape up
+iso8859-2.cdef
\end_layout
\end_inset
-
+ files.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+In general the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-e
+\shape up
+.cdef
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-font-emph
+ file is a sequence of declarations of the form
\end_layout
-\end_inset
-
+\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 List
-\labelwidthstring 00.00.0000
+\begin_layout Standard
+For example, in order to map
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\shape up
-m
+\backslash
+'{e}
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-math-mode
+ to the corresponding character in the iso-8859-1 set (233), the following
+ declaration is used
\end_layout
-\end_inset
-
+\begin_layout LyX-Code
+233 "
+\backslash
+\backslash
+'{e}"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+with
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\backslash
-p
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-code
+\begin_layout Plain Layout
+"
\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 Plain Layout
+i
+\shape up
+so-8859-7.cdef
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
\end_inset
-r
+ file you have
\end_layout
-\end_inset
+\begin_layout LyX-Code
+192 "
+\backslash
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+'{
+\backslash
-\begin_layout PlainLayout
-font-roman
-\end_layout
+\backslash
+\backslash
+"{i}}"
+\begin_inset Newline newline
\end_inset
+192 "
+\backslash
+
+\backslash
+
+\backslash
+"{
+\backslash
+\backslash
+'{i}}"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\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 PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
+\begin_layout Subsection
+Dead Keys
+\end_layout
-s
+\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
-
-\begin_inset Flex CharStyle:Code
+.
+ You could bind the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-font-sans
+\begin_layout Plain Layout
+^
\end_layout
\end_inset
+-key [a.k.a.
+\begin_inset space ~
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
-
-u
+\begin_layout Plain Layout
+Shift-6
\end_layout
\end_inset
-
+] to the LyX command
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-underline
+\begin_layout Plain Layout
+accent-circumflex
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ in your
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
-
-space
+\begin_layout Plain Layout
+lyxrc
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ file.
+ Now, whenever you type the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-font-default
+\begin_layout Plain Layout
+^
\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
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
-
-Down
+\begin_layout Plain Layout
+^e
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-word-lowcase
-\end_layout
+\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
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
+\begin_layout Plain Layout
+^t
+\end_layout
+
\end_inset
-Up
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
-\begin_inset Flex CharStyle:Code
+, 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
-word-upcase
+\begin_layout Plain Layout
+t
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
+ never takes a circumflex accent.
+ Hitting
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-c
-\begin_inset Space ~
-\end_inset
-
-Right
+\begin_layout Plain Layout
+Space
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ 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
-word-capitalize
+\begin_layout Plain Layout
+,-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 List
-\labelwidthstring 00.00.0000
+\begin_layout Standard
+One common way to bind dead-keys is to use
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Meta-
+\end_layout
+
\end_inset
-h
+,
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Ctrl-
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+, and
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-font-size huge
+\begin_layout Plain Layout
+Shift-
\end_layout
\end_inset
+ in combination with an accent, like
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-l
+\begin_layout Plain Layout
+~
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-font-size large
-\end_layout
+\begin_inset Quotes erd
\end_inset
+ or
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-n
+\begin_layout Plain Layout
+,
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-font-size normal
-\end_layout
+\begin_inset Quotes erd
\end_inset
+ or
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+^
+\end_layout
+
\end_inset
-s
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+.
+ Another way involves using
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size small
+\begin_layout Plain Layout
+xmodmap
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-t
+\begin_layout Plain Layout
+xkeycaps
\end_layout
\end_inset
-
+ to set up the special
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size tiny
+\begin_layout Plain Layout
+Mode_Switch
\end_layout
\end_inset
+ key.
+ The
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Mode_Switch
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\end_inset
+
+ acts in some ways just like
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-0
+\begin_layout Plain Layout
+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
-font-size huger
+\begin_layout Plain Layout
+usldead_cedilla
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and then binding this symbolic key to the corresponding LyX command.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+Note from
+\noun on
+John Weiss
+\noun default
+: This is exactly what I do in my
+\begin_inset Flex CharStyle:Code
+status collapsed
-1
+\begin_layout Plain Layout
+~/.lyx/lyxrc
\end_layout
\end_inset
-
+ and my
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size tiny
+\begin_layout Plain Layout
+~/.xmodmap
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+ files.
+ I have my
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Scroll
+\begin_inset space ~
\end_inset
-2
+Lock
\end_layout
\end_inset
-
+ key set up as
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size smallest
+\begin_layout Plain Layout
+Mode_Shift
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
+ and a bunch of these
+\begin_inset Quotes eld
\end_inset
-3
-\end_layout
-
-\end_inset
-
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size smaller
+\begin_layout Plain Layout
+usldead_*
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
+ symbolic keys bound such things as
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Scroll
+\begin_inset space ~
\end_inset
-4
+Lock-^
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-font-size small
-\end_layout
-
+\begin_layout Plain Layout
+Scroll
+\begin_inset space ~
\end_inset
-
+Lock-~
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
\end_inset
-5
+.
+ 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
-font-size normal
+\begin_layout Plain Layout
+Mode_Switch
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+ key: One of the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-6
+\begin_layout Plain Layout
+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
-font-size large
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:savlang"
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
\end_inset
-7
-\end_layout
+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
-\end_inset
+\begin_layout Plain Layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\bar under
+E
+\bar default
+dit\SpecialChar \menuseparator
-\begin_layout PlainLayout
-font-size larger
+\bar under
+P
+\bar default
+references
\end_layout
\end_inset
-
+ dialog.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Chapter
+Installing New Document Classes, Layouts, and Templates
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:textclass"
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
\end_inset
-8
-\end_layout
-
-\end_inset
-
-\begin_inset Flex CharStyle:Code
+\begin_inset OptArg
status collapsed
-\begin_layout PlainLayout
-font-size largest
+\begin_layout Plain Layout
+Installing New Document Classes
\end_layout
\end_inset
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-s
-\begin_inset Space ~
-\end_inset
-
-9
+\begin_layout Plain Layout
+.cls
\end_layout
\end_inset
-
+ or
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size huge
+\begin_layout Plain Layout
+.sty
\end_layout
\end_inset
+) that describes the format of a document such as an article, report, journal
+ preprint, etc, and all the commands needed to realize that format.
+ A layout file is a LyX file that corresponds to a LaTeX document class
+ and that tells LyX how to
+\begin_inset Quotes eld
+\end_inset
+
+draw
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ 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
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+text class
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
+ which is the internal construct LyX uses to render the screen display.
+
+\begin_inset Quotes eld
\end_inset
-S-H
-\end_layout
+Layout
+\begin_inset Quotes erd
+\end_inset
+ and
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+text class
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-font-size huger
+ can be used somewhat interchangeably, but it is better to refer to the
+ file as the layout, and the thing living in LyX's memory as the text class.
+ A template file is simply a LyX document that contains a set of predefined
+ entries for a given document class---entries that are generally required
+ for that class.
+ Templates are especially useful for things like journal manuscripts that
+ are to be submitted electronically.
\end_layout
-\end_inset
+\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.
+ On some systems, you may have a GUI for installing such packages: MikTeX
+ on Windows®, for example.
+\end_layout
+\begin_layout Standard
+If you don't have such a GUI, then you can follow these steps.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Enumerate
+Get the package from
+\begin_inset CommandInset href
+LatexCommand href
+name "CTAN"
+target "http://www.ctan.org/"
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
\end_inset
-S-L
+ or wherever.
\end_layout
-\end_inset
-
-
+\begin_layout Enumerate
+You can install this package in several different places.
+ If you want it to be available for all users on your system, then you should
+ install it in your `local' TeX tree; if you want (or need) it to be available
+ just for you, then you can install it in your own `user' TeX tree.
+ Where these should be created, if they do not already exist, depends upon
+ the details of your system.
+ To find out, look in the file
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size larger
+\begin_layout Plain Layout
+texmf.cnf
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-S-S
-\end_layout
-
-\end_inset
-
-
+\begin_layout Plain Layout
+This usually lives in the directory
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size smaller
+\begin_layout Plain Layout
+$TEXMF/web2c
\end_layout
\end_inset
+, though you can run
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+kpsewhich texmf.cnf
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
\end_inset
-plus
+ to locate it.
\end_layout
\end_inset
-
+ The location of the `local' TeX tree is defined by
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size increase
+\begin_layout Plain Layout
+TEXMFLOCAL
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+; this is usually somewhere like
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-s
-\begin_inset Space ~
-\end_inset
-
-minus
+\begin_layout Plain Layout
+/usr/local/share/texmf/
\end_layout
\end_inset
-
+.
+ The `user' TeX tree is defined by
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-size decrease
+\begin_layout Plain Layout
+TEXMFHOME
\end_layout
\end_inset
+ and is commonly at
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+$HOME/texmf/
\end_layout
-\begin_layout Subsection
-View
-\end_layout
-
-\begin_layout Subsection
-Navigate
-\end_layout
-
-\begin_layout Subsection
-Help
-\end_layout
-
-\begin_layout Subsection
-Paragraph Style
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-a
+.
+ (If these variables are not predefined, you can define them.) You'll probably
+ need root permissions to create or modify the `local' tree; but your `user'
+ tree shouldn't have such limitations.
\end_layout
-\end_inset
-
-
+\begin_layout Enumerate
+Make sure
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Abstract
+\begin_layout Plain Layout
+TEXMF
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ includes the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-b
+\begin_layout Plain Layout
+TEXMFLOCAL
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Itemize
+\begin_layout Plain Layout
+TEXMFHOME
\end_layout
\end_inset
+ variables; e.g.
+
+\begin_inset Newline newline
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-c
+\begin_layout Plain Layout
+TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-layout LyX-Code
-\end_layout
+\begin_inset Newline newline
+\end_inset
+But, again, most of this will
+\begin_inset Quotes eld
\end_inset
+just work
+\begin_inset Quotes erd
+\end_inset
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Enumerate
+Create your local
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-d
+\begin_layout Plain Layout
+We'll assume henceforth that you're defining `local' TeX tree.
+ If you're defining a user tree, just adjust as necessary.
\end_layout
\end_inset
-
+ TeX tree.
+ You must follow the directory structure of your existing
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Description
+\begin_layout Plain Layout
+texmf
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ directory, which will be found at
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-e
+\begin_layout Plain Layout
+TEXMFMAIN
\end_layout
\end_inset
-
+.
+ For example, latex packages should go under
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Enumerate
+\begin_layout Plain Layout
+$TEXMFLOCAL/tex/latex/
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Enumerate
+Install the package.
+ For example, you would unpack the FoilTeX tarball and copy it to
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-f
+\begin_layout Plain Layout
+$TEXMFLOCAL/tex/latex/foiltex
\end_layout
\end_inset
-
+.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout ShortFoilhead
+\begin_layout Plain Layout
+foiltex
\end_layout
\end_inset
-
+ directory contains various files.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Enumerate
+Run:
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-i
+\begin_layout Plain Layout
+texhash
\end_layout
\end_inset
-
+.
+ This should create
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Itemize
+\begin_layout Plain Layout
+$TEXMFLOCAL/ls-R
\end_layout
\end_inset
-
+ amongst others.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Standard
+Your package is now installed and available to LaTeX.
+ To make it available to LyX, you need to create a Layout file, if one is
+ not already available.
+ (See the next section.) Once you have a layout file, you need only reconfigure
+ (
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
-l
+\bar under
+R
+\bar default
+econfigure
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+) and then restart LyX.
+ You should then see your new package---for example
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-layout List
+\begin_layout Plain Layout
+slides (FoilTeX)
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+---under
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-n
+\bar under
+S
+\bar default
+ettings
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-layout Enumerate
+\begin_layout Plain Layout
+Document Class
\end_layout
\end_inset
-
+ drop box.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Layouts"
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-q
+Layouts
\end_layout
-\end_inset
-
-
+\begin_layout Standard
+This section describes how to write and install your own LyX layout files
+ and walks through the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Quote
+\begin_layout Plain Layout
+article
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ text class format as an example.
+ The
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-r
+\begin_layout Plain Layout
+.layout
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout ShortRotatefoilhead
+ files describe what paragraph and character 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
+\begin_inset CommandInset href
+LatexCommand href
+name "section on the LyX wiki"
+target "http://wiki.lyx.org/Layouts/Layouts"
+
\end_inset
-
+ for this kind of material.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-p
-\begin_inset Space ~
-\end_inset
-
-s
+\begin_layout Plain Layout
+Style
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Standard
+\begin_layout Plain Layout
+style
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-t
+\begin_layout Plain Layout
+StYlE
\end_layout
\end_inset
-
+ are really the same command.
+ The possible values are printed in brackets after the feature's name.
+ The default value if a feature isn't specified inside a text class-description
+ is typeset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Title
+\begin_layout Plain Layout
+
+\emph on
+emphasized
\end_layout
\end_inset
+.
+ If the argument has a datatype like
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
+string
+\begin_inset Quotes erd
\end_inset
-v
-\end_layout
+ 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
-layout Verse
+\begin_layout Plain Layout
+float=
+\emph on
+default
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Layout-modules"
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-space
+Layout modules
\end_layout
-\end_inset
-
-
+\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
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-drop-layouts-choice
+\begin_layout Plain Layout
+stdsections.inc
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+---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
-M-p
-\noun on
+\begin_layout Plain Layout
-\begin_inset Space ~
-\end_inset
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-0
+\bar under
+S
+\bar default
+ettings
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout Part
+ dialog.
\end_layout
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
+\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
-M-p
-\noun on
-
-\begin_inset Space ~
-\end_inset
-
-1
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
+.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout Chapter
\end_layout
-\end_inset
-
-
+\begin_layout Standard
+The module declaration should then be followed by lines like the following:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout LyX-Code
+#DescriptionBegin
+\end_layout
-2
+\begin_layout LyX-Code
+#Adds an endnote command, in addition to footnotes.
+
\end_layout
-\end_inset
+\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.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout Section
\end_layout
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
+\begin_layout Standard
+The description is used in
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-3
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
-
+ to provide the user with information about what the module does.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Subsection
+\begin_layout Plain Layout
+Requires
\end_layout
\end_inset
+ line is used to identify other modules with which this one must be used;
+ the
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Excludes
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-4
+ 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 Plain Layout
+somemodule
\end_layout
\end_inset
-
+ is really
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Subsubsection
+\begin_layout Plain Layout
+somemodule.module
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Standard
+After creating a new module, you will need to reconfigure and then restart
+ LyX for the module to appear in the menu.
+ However, changes you make to the module will be seen immediately, if you
+ open
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-5
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout Paragraph
-\end_layout
+, 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,
+\emph on
+it is strongly recommended that you not attempt to edit modules while simultaneo
+usly working on documents
+\emph default
+.
+ Though of course the developers strive to keep LyX stable in such situations,
+ syntax errors and the like in your module file could cause strange behavior.
+\end_layout
+\begin_layout Subsection
+Supporting new document classes
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+There are two situations you are likely to encounter when wanting to support
+ a new LaTeX document class, involving LaTeX2e class (
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-6
+\begin_layout Plain Layout
+.cls
\end_layout
\end_inset
-
+) and style (
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Subparagraph
+\begin_layout Plain Layout
+.sty
\end_layout
\end_inset
-
+) files.
+ Supporting a style file is usually fairly easy.
+ Supporting a new document class is a bit harder.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Subsection
+A layout for a
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+sty
+\end_layout
-asterisk
-\begin_inset Space ~
\end_inset
-0
+ file
\end_layout
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+\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
-layout Part*
+\begin_layout Plain Layout
+myclass.sty
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+ and it is meant to be used with
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+report.cls
+\end_layout
-asterisk
-\begin_inset Space ~
\end_inset
-1
+, which is a standard class---start by copying the existing class's layout
+ file into your local directory:
\end_layout
-\end_inset
+\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
-layout Chapter*
+\begin_layout Plain Layout
+myclass.layout
\end_layout
\end_inset
-
+ and change the line:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout LyX-Code
-asterisk
-\begin_inset Space ~
-\end_inset
+\backslash
+DeclareLaTeXClass{report}
+\end_layout
-2
+\begin_layout Standard
+to read
\end_layout
-\end_inset
+\begin_layout LyX-Code
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
+\end_layout
-\begin_layout PlainLayout
-layout Section*
+\begin_layout Standard
+Then add:
\end_layout
+\begin_layout LyX-Code
+Preamble
+\begin_inset Newline newline
\end_inset
+
+\backslash
+usepackage{myclass}
+\begin_inset Newline newline
+\end_inset
+EndPreamble
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\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
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-asterisk
-\begin_inset Space ~
-\end_inset
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
-3
+\bar under
+R
+\bar default
+econfigure
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+.
+ Then restart LyX and try creating a new document.
+ You should see "
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-layout Subsection*
+\begin_layout Plain Layout
+report (myclass)
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+" as a document class option in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-asterisk
-\begin_inset Space ~
-\end_inset
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-4
+\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
-layout Subsubsection*
+\begin_layout Plain Layout
+report
\end_layout
\end_inset
-
+ in this example---so you can fiddle around with the settings for the different
+ sections if you wish.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Subsection
+Layout for a
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+cls
+\end_layout
-asterisk
-\begin_inset Space ~
\end_inset
-5
+ file
\end_layout
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+\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
-layout Paragraph*
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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:
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-asterisk
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+And it will be easiest if you save the file to
+\begin_inset Flex CharStyle:Code
+status collapsed
-6
+\begin_layout Plain Layout
+thesis.layout
\end_layout
\end_inset
+: LyX assumes that the document class has the same name as the layout file.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout Subparagraph*
\end_layout
\end_inset
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout LyX-Code
-S-A
+\backslash
+DeclareLaTeXClass[thesis,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
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+roll your own
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-layout Author
+ 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
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+Lines in a layout file which begin with a
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-S-B
+\begin_layout Plain Layout
+#
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-layout Bibliography
+ are comments.
+ There is one exception to this rule: all layouts should begin with lines
+ like:
\end_layout
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-p
-\begin_inset Space ~
-\end_inset
-
-S-C
+\begin_layout Plain Layout
+chkconfig.ltx
\end_layout
\end_inset
-
+, in a special mode where
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Comment
+\begin_layout Plain Layout
+#
\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 Plain Layout
+article.layout
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-S-D
+, then they define a text class of name
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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
-layout Date
+\begin_layout Plain Layout
+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
-\end_layout
+article
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
+ that appears above is used as a description of the text class in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-S-F
+\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
-layout Foilhead
+\begin_layout Plain Layout
+article.cls
\end_layout
\end_inset
+ document class, but where you changed the appearance of the section headings.
+ If you put it in a file
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+myarticle.layout
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-S-L
+, the header of this file should be:
\end_layout
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout PlainLayout
-layout LaTeX
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\end_inset
-
+\begin_layout LyX-Code
+\size small
+#
+\backslash
+DeclareLaTeXClass[article]{article (with my own headings)}
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+This declares a text class
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-S-Q
+\begin_layout Plain Layout
+myarticle
\end_layout
\end_inset
-
+, associated with the LaTeX document class
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Quotation
+\begin_layout Plain Layout
+article.cls
\end_layout
\end_inset
+ and described as
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
+article (with my own headings)
+\begin_inset Quotes erd
\end_inset
-S-R
+.
+ If your text class depends on several packages, you can declare it as:
\end_layout
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout PlainLayout
-layout Rotatefoilhead
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\end_inset
-
+\begin_layout LyX-Code
+\size small
+#
+\backslash
+DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\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 PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
+\begin_layout LyX-Code
-C-a
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\end_inset
+\begin_layout LyX-Code
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\size small
+#
+\backslash
+DeclareDocBookClass[article]{SGML (DocBook article)}
+\end_layout
-\begin_layout PlainLayout
-layout RightAddress
+\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
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+When the text class has been modified to your taste, all you have to do
+ is to copy it either to
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-M-a
+\begin_layout Plain Layout
+LyXDir/layouts/
\end_layout
\end_inset
-
+ or to
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Address
+\begin_layout Plain Layout
+UserDir/layouts
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+, run
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-M-c
-\end_layout
-
-\end_inset
+\begin_layout Plain Layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
-\begin_layout PlainLayout
-layout Caption
+\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 List
-\labelwidthstring 00.00.0000
+\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
-M-p
-\begin_inset Space ~
+\begin_layout Plain Layout
+layout-reload
+\end_layout
+
\end_inset
-Left
-\end_layout
+.
+ 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.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-depth-decrement
+\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
-\end_inset
-
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-Right
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-depth-increment
+\begin_layout Plain Layout
+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 format 7.
+\end_layout
+\begin_layout Subsection
+General text class parameters
\end_layout
\begin_layout Standard
-These ones are kept for backwards compatibility, but only make sense on
- a qwerty keyboard:
+These are the general parameters which describe the form of the entire document:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
-\end_inset
-
-S-at
+\begin_layout Plain Layout
+AddToPreamble
\end_layout
\end_inset
-
+ Adds information to the document preamble.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Section*
+\begin_layout Plain Layout
+EndPreamble
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
+\begin_inset Quotes erd
\end_inset
-S-dollar
+.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Subsubsection*
+\begin_layout Plain Layout
+ClassOptions
\end_layout
\end_inset
+ Describes various global options supported by the document class.
+ See Section
+\begin_inset space ~
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:classoptions"
-\begin_layout PlainLayout
-M-p
-\begin_inset Space ~
\end_inset
-S-numbersign
-\end_layout
-
+ for a description.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout Subsection*
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Section
-Keyboard
+.
\end_layout
-\begin_layout Subsection
-Specific to
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-emacs.bind
+\begin_layout Plain Layout
+Columns
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-a
+\begin_layout Plain Layout
+
+\emph on
+1
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-line-begin
+\begin_layout Plain Layout
+2
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+] Whether the class should default to having one or two columns.
+ Can be changed in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-C-b
+\begin_layout Plain Layout
+
+\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
-char-backward
+\begin_layout Plain Layout
+Counter
\end_layout
\end_inset
+ This sequence defines a new counter.
+ See Section
+\begin_inset space ~
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:counter"
-\begin_layout PlainLayout
-C-d
-\end_layout
+\end_inset
+ for details.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-delete-forward
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-C-e
+.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-line-end
+\begin_layout Plain Layout
+DefaultFont
\end_layout
\end_inset
+ Sets the default font used to display the document.
+ See Section
+\begin_inset space ~
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:fonts"
-\begin_layout PlainLayout
-C-f
-\end_layout
+\end_inset
+ for how to declare fonts.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-char-forward
+\begin_layout Plain Layout
+EndFont
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-g
+\begin_layout Plain Layout
+DefaultStyle
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-cancel
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+] This is the style that will be assigned to new paragraphs, usually
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-C-h
+\begin_layout Plain Layout
+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
-hyphenation-point-insert
+\begin_layout Plain Layout
+Float
\end_layout
\end_inset
+ Defines a new float.
+ See Section
+\begin_inset space ~
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:floats"
-\begin_layout PlainLayout
-C-i
-\end_layout
+\end_inset
+ for details.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-hfill-insert
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-k
+\begin_layout Plain Layout
+Input
\end_layout
\end_inset
-
+ As its name implies, this command allows you to include another layout
+ definition file within yours to avoid duplicating commands.
+ Common examples are the standard layout files, for example,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-line-delete-forward
+\begin_layout Plain Layout
+stdclass.inc
\end_layout
\end_inset
-
+, which contains most of the basic layouts.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-l
+\begin_layout Plain Layout
+InsetLayout
\end_layout
\end_inset
-
+ This section (re-)defines the layout of an inset.
+ It can be applied to an existing inset 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 more information.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-recenter
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-m
+\begin_layout Plain Layout
+LeftMargin
\end_layout
\end_inset
-
+ [[FIXME]]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-mark-toggle
+\begin_layout Plain Layout
+NoFloat
\end_layout
\end_inset
-
+ This command deletes an existing float.
+ This is particularly useful when you want to suppress a float that has
+ be defined in an input file.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-n
+\begin_layout Plain Layout
+NoStyle
\end_layout
\end_inset
-
+ This command deletes an existing style.
+ This is particularly useful when you want to suppress a style that has
+ be defined in an input file.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-down
+\begin_layout Plain Layout
+OutputType
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-o
+\begin_layout Plain Layout
+
+\series medium
+PageStyle
\end_layout
\end_inset
-
+ [
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-open-stuff
+\begin_layout Plain Layout
+
+\emph on
+plain
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\emph default
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-p
+\begin_layout Plain Layout
+empty
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-up
+\begin_layout Plain Layout
+headings
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+] The class default pagestyle.
+ Can be changed in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-C-q
-\end_layout
-
-\end_inset
+\begin_layout Plain Layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-\begin_layout PlainLayout
-quote-insert
+\bar under
+S
+\bar default
+ettings
\end_layout
\end_inset
-
+ dialog.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
+\begin_layout Plain Layout
+Preamble
\end_layout
\end_inset
-
+ Sets the preamble for the LaTeX document.
+ Note that this will completely override any prior
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-find-replace
+\begin_layout Plain Layout
+Premable
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ or
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-u
+\begin_layout Plain Layout
+AddToPreamble
\end_layout
\end_inset
-
+ declarations.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-underline
+\begin_layout Plain Layout
+EndPreamble
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-C-v
+.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-down
+\begin_layout Plain Layout
+Provides
\end_layout
\end_inset
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Provides"
-\end_layout
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+[
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-w
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
-
+] [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-cut
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-y
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
+] Whether the class already provides the feature
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paste
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+ A feature is in general the name of a package (
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Y
+\begin_layout Plain Layout
+amsmath
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout-paste
+\begin_layout Plain Layout
+makeidx
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+, \SpecialChar \ldots{}
+) or a macro (
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-a
+\begin_layout Plain Layout
+url
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-auto-save
+\begin_layout Plain Layout
+boldsymbol
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,\SpecialChar \ldots{}
+); the complete list of supported features is unfortunately not documented
+ outside the LyX source code---but see
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-b
+\begin_layout Plain Layout
+LaTeXFeatures.cpp
\end_layout
\end_inset
+ if you're interested.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-buffer-previous
+\begin_layout Plain Layout
+
+\bar under
+H
+\bar default
+elp\SpecialChar \menuseparator
+
+\bar under
+L
+\bar default
+aTeX Configuration
\end_layout
\end_inset
-
+ also gives an overview of the supported packages.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-c
+\begin_layout Plain Layout
+Requires
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lyx-quit
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+] Whether the class requires the feature
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+ string
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-d
+.
+ Multiple features must be separated by commas.
+ Note that you can only request supported features.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-new
+\begin_layout Plain Layout
+RightMargin
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-?
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+SecNumDepth
+\end_layout
-C-x
-\begin_inset Space ~
\end_inset
-f
+ [[FIXME]]
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-open
+\begin_layout Plain Layout
+Sides
\end_layout
\end_inset
+ [
+\emph on
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-g
+\emph on
+1
\end_layout
\end_inset
-
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-view-ps
+\begin_layout Plain Layout
+2
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+] 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
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-k
+\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
-buffer-close
+\begin_layout Plain Layout
+Style
\end_layout
\end_inset
+ This sequence defines a new paragraph style.
+ If the style already exists, it will redefine some of its parameters instead.
+ See Section
+\begin_inset space ~
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:style"
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-p
-\end_layout
-
+ for details.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-view
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-r
+\begin_layout Plain Layout
+TitleLatexName
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-typeset
+\begin_layout Plain Layout
+string="maketitle"
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] The name of the command or environment to be used with
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-?
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+TitleLatexType
+\end_layout
-C-x
-\begin_inset Space ~
\end_inset
-s
+.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-write
+\begin_layout Plain Layout
+TitleLatexType
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
-t
+\emph on
+CommandAfter
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-typeset
+\begin_layout Plain Layout
+Environment
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] Indicates what kind of markup is used to define the title of a document.
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-u
+\begin_layout Plain Layout
+CommandAfter
\end_layout
\end_inset
-
+ means that the macro with name
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-undo
+\begin_layout Plain Layout
+TitleLatexName
\end_layout
\end_inset
+ will be inserted after the last layout which has
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+InTitle 1
+\end_layout
-v
-\begin_inset Space ~
\end_inset
-c
-\end_layout
+\begin_inset Quotes erd
\end_inset
+.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-vc-undo-last
+\begin_layout Plain Layout
+Environment
\end_layout
\end_inset
+ corresponds to the case where the block of paragraphs which have
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+InTitle 1
+\end_layout
-v
-\begin_inset Space ~
\end_inset
-h
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+ should be enclosed into the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-vc-history
+\begin_layout Plain Layout
+TitleLatexName
\end_layout
\end_inset
-
+ environment.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+TocDepth
+\end_layout
-v
-\begin_inset Space ~
\end_inset
-i
+ [[FIXME]]
\end_layout
-\end_inset
-
-
+\begin_layout Subsection
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-vc-register
+\begin_layout Plain Layout
+ClassOptions
\end_layout
\end_inset
-
+ section
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:classoptions"
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-v
-\begin_inset Space ~
-\end_inset
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
-u
+\begin_layout Plain Layout
+ClassOptions
\end_layout
\end_inset
-
+ section can contain the following entries:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-vc-revert
+\begin_layout Plain Layout
+FontSize
\end_layout
\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+string="10|11|12"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-v
-\begin_inset Space ~
+] The list of available font sizes for the document's main font, separated
+ by
+\begin_inset Quotes eld
\end_inset
-v
-\end_layout
-
-\end_inset
-
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-vc-check-in
+\begin_layout Plain Layout
+|
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-?
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+Header
+\end_layout
-C-x
-\begin_inset Space ~
\end_inset
-w
+ [[FIXME]]
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-write-as
+\begin_layout Plain Layout
+PageStyle
\end_layout
\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+string="empty|plain|headings|fancy"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-bracketleft
-\end_layout
-
+] The list of available page styles, separated by
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-up
+\begin_layout Plain Layout
+|
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
+\begin_layout Plain Layout
+Other
+\end_layout
+
\end_inset
-bracketright
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
-
+] Some document class options, separated by a comma, that will be added
+ to the optional part of the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-down
+\begin_layout Plain Layout
+
+\backslash
+documentclass
\end_layout
\end_inset
-
+ command.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+The
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-a
+\begin_layout Plain Layout
+ClassOptions
\end_layout
\end_inset
-
+ section must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-auto-save
+\begin_layout Plain Layout
+End
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Paragraph Styles
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:style"
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-C-b
+A paragraph style description looks like this:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this will either define a new layout or modify an existing one.
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-menu-open Documents
\end_layout
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+where the following commands are allowed:
+\end_layout
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-C-c
+\begin_layout Plain Layout
+Align
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lyx-quit
+\begin_layout Plain Layout
+
+\emph on
+block
+\emph default
+, left, right, center
\end_layout
\end_inset
-
+] Paragraph alignment.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-d
+\begin_layout Plain Layout
+AlignPossible
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-new
+\begin_layout Plain Layout
+
+\emph on
+block
+\emph default
+, left, right, center
\end_layout
\end_inset
-
+] A comma separated list of permitted alignments.
+ (Some LaTeX styles prohibit certain alignments, since those wouldn't make
+ sense.
+ For example a right-aligned or centered enumeration isn't possible.)
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-f
+\begin_layout Plain Layout
+BottomSep
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-open
+\begin_layout Plain Layout
+float=0
\end_layout
\end_inset
+]
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+Note that a `float' here is a real number, such as: 1.5.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
\end_inset
-C-g
+ The vertical space with which the last of a chain of paragraphs with this
+ layout is separated from the following paragraph.
+ If the next paragraph has another layout, the separations are not simply
+ added, but the maximum is taken.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-view-ps
+\begin_layout Plain Layout
+Category
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-p
+\begin_layout Plain Layout
+[string]
\end_layout
\end_inset
+ The category for this style.
+ This is used to group related styles in the Layout combobox on the toolbar.
+ Any string can be used, but you may want to use existing categories with
+ your own styles.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-view
+\begin_layout Plain Layout
+CommandDepth
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-q
+\begin_layout Plain Layout
+CopyStyle
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:CopyStyle"
+
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-toggle-read-only
+\begin_layout Plain Layout
+[string]
\end_layout
\end_inset
-
+ Copies all the features of an existing style into the current one.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-s
+\begin_layout Plain Layout
+DependsOn
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ The name of a style whose preamble should be output
+\emph on
+before
+\emph default
+ this one.
+ This allows to ensure some ordering of the preamble snippets when macros
+ definitions depend on one another.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-buffer-write
+\begin_layout Plain Layout
+Note that, besides that functionality, there is no way to ensure any ordering
+ of preambles.
+ The ordering that you see in a given version of LyX may change without
+ warning in later versions.
\end_layout
\end_inset
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-t
+\begin_layout Plain Layout
+EndLabeltype
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-typeset
+\begin_layout Plain Layout
+
+\emph on
+No_Label
+\emph default
+, Box, Filled_Box, Static
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] The type of label that stands at the end of the paragraph (or sequence
+ of paragraphs if
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
-\begin_inset Space ~
-\end_inset
-
-C-w
+\begin_layout Plain Layout
+LatexType
\end_layout
\end_inset
-
+ is
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-write-as
+\begin_layout Plain Layout
+Environment
\end_layout
\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Item_Environment
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Home
+\begin_layout Plain Layout
+List_Environment
\end_layout
\end_inset
+).
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-begin
+\begin_layout Plain Layout
+No_Label
\end_layout
\end_inset
+ means
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+nothing
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-End
+\begin_layout Plain Layout
+Box
\end_layout
\end_inset
-
+ (resp.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-end
-\end_layout
-
+\begin_layout Plain Layout
+\begin_inset space ~
\end_inset
-
+Filled_Box
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-S-Home
-\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
-line-begin-select
+\begin_layout Plain Layout
+Static
\end_layout
\end_inset
-
+ is an explicit text string.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-End
+\begin_layout Plain Layout
+EndLabelString
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-line-end-select
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] The string used for a label with a
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Up
+\begin_layout Plain Layout
+Static
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-up-select
+\begin_layout Plain Layout
+EndLabelType
\end_layout
\end_inset
-
+.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Down
+\begin_layout Plain Layout
+Fill_Bottom
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-down-select
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] Similar to
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Next
+\begin_layout Plain Layout
+Fill_Top
\end_layout
\end_inset
-
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-down-select
+\begin_layout Plain Layout
+Fill_Top
\end_layout
\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\emph on
+0
+\emph default
+,1
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\end_inset
+
+] With this parameter the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-S-Prior
+\begin_layout Plain Layout
+Fill
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ 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
-screen-up-select
-\end_layout
+\begin_layout Plain Layout
-\end_inset
+\bar under
+E
+\bar default
+dit\SpecialChar \menuseparator
+\bar under
+P
+\bar default
+aragraph
+\begin_inset space ~
+\end_inset
+Settings
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+ dialog can be set when initializing a paragraph with this style.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-S-Left
+\begin_layout Plain Layout
+
+\emph on
+Note from Jean-Marc:
+\emph default
+ I'm not sure that this setting has much use, and it should probably be
+ removed in later versions.
\end_layout
\end_inset
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-backward-select
+\begin_layout Plain Layout
+Font
\end_layout
+\end_inset
+
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
\end_inset
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:fonts"
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+.
+ Note that defining this font automatically defines the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Right
+\begin_layout Plain Layout
+LabelFont
\end_layout
\end_inset
-
+ to the same value.
+ So you should define this one first if you also want to define
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-forward-select
+\begin_layout Plain Layout
+LabelFont
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Up
+\begin_layout Plain Layout
+FreeSpacing
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:FreeSpacing"
+
+\end_inset
+
+[
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paragraph-up
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\emph default
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Down
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paragraph-down
+\begin_layout Plain Layout
+FreeSpacing
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-Left
+ can be enabled.
+ Note that LyX will create protected blanks for the additional blanks when
+ in another mode than LaTeX-mode.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-backward
+\begin_layout Plain Layout
+InnerTag
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Right
+\begin_layout Plain Layout
+InTitle
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-forward
+\begin_layout Plain Layout
+[1, 0]
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ If 1, marks the layout as being part of a title block (see also the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Delete
+\begin_layout Plain Layout
+TitleLatexType
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-delete-forward
+\begin_layout Plain Layout
+TitleLatexName
\end_layout
\end_inset
-
+ global entries).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-BackSpace
+\begin_layout Plain Layout
+ItemSep
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-delete-backward
+\begin_layout Plain Layout
+float=0
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] This provides extra space between paragraphs that have the same layout.
+ If you put other layouts into an environment, each is separated with the
+ environment's
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Return
+\begin_layout Plain Layout
+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
-break-line
+\begin_layout Plain Layout
+Itemsep
\end_layout
\end_inset
-
+.
+ Note that this is a
+\emph on
+ multiplier.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-period
+\begin_layout Plain Layout
+ItemTag
\end_layout
\end_inset
-
+ [[FIXME]]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-end-of-sentence-period-insert
+\begin_layout Plain Layout
+KeepEmpty
\end_layout
\end_inset
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:KeepEmpty"
-\end_layout
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+[
+\emph on
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-space
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
-
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-protected-space-insert
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a layout can be used
+ as some kind of break, which does not contain actual text.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-at
+\begin_layout Plain Layout
+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
-mark-on
+\begin_layout Plain Layout
+Top_Environment
\end_layout
\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Centered_Top_Environment
+\end_layout
+
+\end_inset
+).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-greater
+\begin_layout Plain Layout
+LabelCounter
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-label-goto
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
+]
+\begin_inset Newline newline
+\end_inset
+
+The name of the counter for automatic numbering (see Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:counter"
-\end_layout
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ for details).
+ This must be given if
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-less
+\begin_layout Plain Layout
+Labeltype
\end_layout
\end_inset
-
+ is
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-reference-back
+\begin_layout Plain Layout
+Counter
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-slash
+\begin_layout Plain Layout
+LabelFont
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout PlainLayout
-undo
-\end_layout
-\end_inset
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:fonts"
+\end_inset
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-underscore
+\begin_layout Plain Layout
+Labelsep
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-undo
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-quotedbl
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-quote-insert
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] The string used for a label with a
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Home
+\begin_layout Plain Layout
+Static
\end_layout
\end_inset
-
+ labeltype.
+ When
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-begin-select
+\begin_layout Plain Layout
+LabelCounter
\end_layout
\end_inset
+ is set, this string can be contain the special formatting commands described
+ in Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:counter"
-\end_layout
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-C-S-End
-\end_layout
-
-\end_inset
-
-
+\begin_layout Plain Layout
+For the sake of backwards compatibility, the string
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-end-select
+\begin_layout Plain Layout
+@
+\emph on
+style-name
+\emph default
+@
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ will be replaced by the expanded
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Up
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
-
+ of style
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paragraph-up-select
+\begin_layout Plain Layout
+
+\emph on
+style-name
\end_layout
\end_inset
+.
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:counter"
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\end_inset
-\begin_layout PlainLayout
-C-S-Down
+.
\end_layout
\end_inset
-
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paragraph-down-select
+\begin_layout Plain Layout
+LabelStringAppendix
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Left
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
-
+] This is used inside the appendix instead of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-backward-select
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+ Note that every
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Right
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
-
+ statement resets
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-forward-select
+\begin_layout Plain Layout
+LabelStringAppendix
\end_layout
\end_inset
-
+ too.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Escape
+\begin_layout Plain Layout
+Labeltype
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-meta-prefix
-\end_layout
+\begin_layout Plain Layout
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment,
+\begin_inset Newline newline
\end_inset
-
+Centered_Top_Environment, Sensitive, Counter
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-d
-\end_layout
+\end_inset
+]
+\begin_inset Newline newline
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-delete-forward
+\begin_layout Plain Layout
+Manual
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ means the label is the very first word (up to the first real blank).
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-M-w
+\begin_layout Plain Layout
+Use protected spaces if you want more than one word as the label.
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-copy
+\begin_layout Plain Layout
+Static
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ means it is defined in the layout (see
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-x
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
+).
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-command-execute
+\begin_layout Plain Layout
+Top_Environment
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-S-W
+\begin_layout Plain Layout
+Centered_Top_Environment
\end_layout
\end_inset
-
+ are special cases of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout-copy
+\begin_layout Plain Layout
+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 Plain Layout
+Abstract
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\end_inset
+
+ layout or the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-period
+\begin_layout Plain Layout
+Bibliography
\end_layout
\end_inset
-
+ layout.
+ This is also the case for
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-dots-insert
+\begin_layout Plain Layout
+Manual
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ labels with latex type
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-Return
+\begin_layout Plain Layout
+Environment
\end_layout
\end_inset
+, in order to make layouts for theorems work correctly.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-break-paragraph-keep-layout
+\begin_layout Plain Layout
+Sensitive
\end_layout
\end_inset
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+Figure
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-M-S-percent
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
+Table
+\begin_inset Quotes erd
\end_inset
+.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-find-replace
+\begin_layout Plain Layout
+Sensitive
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Subsection
-Specific to
+ means the (hardcoded) label string depends on the kind of float.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-cua.bind
+\begin_layout Plain Layout
+Counter
\end_layout
\end_inset
+ label type defines automatically numbered labels.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:counter"
+
+\end_inset
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-b
+\begin_layout Plain Layout
+LatexFooter
\end_layout
\end_inset
-
+ [[FIXME]]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-bold
+\begin_layout Plain Layout
+LatexHeader
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-c
+\begin_layout Plain Layout
+LatexName
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:LatexName"
+
+\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
-copy
+\begin_layout Plain Layout
+LatexParagraph
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-d
+\begin_layout Plain Layout
+LatexParam
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:LatexParam"
+
+\end_inset
+
+An optional parameter for the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-view
+\begin_layout Plain Layout
+LatexName
\end_layout
\end_inset
-
+ stuff.
+ This parameter cannot be changed from within LyX.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-e
+\begin_layout Plain Layout
+LatexType
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:LatexType"
+
+\end_inset
+
+[
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-emph
+\begin_layout Plain Layout
+
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
\end_layout
\end_inset
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+List_Environment
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+] How the layout should be translated into LaTeX.
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-f
+\begin_layout Plain Layout
+Paragraph
\end_layout
\end_inset
+ means nothing special.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-find-replace
+\begin_layout Plain Layout
+Command
\end_layout
\end_inset
+ means
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_layout
+\begin_layout Plain Layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\backslash
-\begin_layout PlainLayout
-C-g
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-error-next
+\begin_layout Plain Layout
+Environment
\end_layout
\end_inset
+ means
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_layout
+\begin_layout Plain Layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
-\begin_layout PlainLayout
-C-i
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
+.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-open-stuff
+\begin_layout Plain Layout
+Item_Environment
\end_layout
\end_inset
+ is the same as
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Environment
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+, except that a
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-k
+\begin_layout Plain Layout
+
+\backslash
+item
\end_layout
\end_inset
+ is generated for each paragraph of this environment.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-noun
+\begin_layout Plain Layout
+List_Environment
\end_layout
\end_inset
+ is the same as
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Item_Environment
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+, except that
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-l
+\begin_layout Plain Layout
+LabelWidthString
\end_layout
\end_inset
+ is passed as an argument to the environment.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-tex-mode
+\begin_layout Plain Layout
+LabelWidthString
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+ can be defined in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-C-m
+\begin_layout Plain Layout
+
+\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
-math-mode
+\begin_layout Plain Layout
+
+\emph on
+LatexType
\end_layout
\end_inset
-
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-n
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
\end_layout
-\end_inset
+\begin_layout LyX-Code
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
+\end_layout
-\begin_layout PlainLayout
-buffer-new
+\begin_layout Standard
+or:
\end_layout
-\end_inset
+\begin_layout LyX-Code
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+
+\backslash
+end{latexname}.
+\end_layout
+\begin_layout Standard
+depending upon the LaTex type.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-o
+\begin_layout Plain Layout
+LeftMargin
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-open
+\begin_layout Plain Layout
+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
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+ Note that this parameter is also used when the margin is defined as
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-p
+\begin_layout Plain Layout
+Manual
\end_layout
\end_inset
-
+ or
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-print
+\begin_layout Plain Layout
+Dynamic
\end_layout
\end_inset
+.
+ Then it is added to the manual or dynamic margin.
+
+\begin_inset Newline newline
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-q
-\end_layout
-
+The argument is passed as a string.
+ For example
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lyx-quit
+\begin_layout Plain Layout
+MM
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-r
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-reload
+\begin_layout Plain Layout
+MM
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-s
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ in the normal font.
+ You can get a negative width by prefixing the string with
+\begin_inset Quotes eld
\end_inset
-
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-write
+\begin_layout Plain Layout
+-
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-t
+\begin_layout Plain Layout
+Margin
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-view-ps
+\begin_layout Plain Layout
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
+]
+\begin_inset Newline newline
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+The kind of margin that the layout has on the left side.
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-u
+\begin_layout Plain Layout
+Static
\end_layout
\end_inset
+ just means a fixed margin.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-underline
+\begin_layout Plain Layout
+Manual
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+ means that the left margin depends on the string entered in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-C-v
+\begin_layout Plain Layout
+
+\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
-paste
+\begin_layout Plain Layout
+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
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-w
-\end_layout
+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
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+5.4.3.2.1
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-buffer-close
-\end_layout
+ plus the space) than
+\begin_inset Quotes eld
+\end_inset
+3.2 Very long headline
+\begin_inset Quotes erd
\end_inset
+, even if standard
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+word processors
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ are not able to do this.
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
+\begin_layout Plain Layout
+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
-cut
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-z
+\begin_layout Plain Layout
+NeedProtect
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:NeedProtect"
+
+\end_inset
+
+[
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-undo
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-space
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
+] Whether fragile commands in this layout should be
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-protected-space-insert
+\begin_layout Plain Layout
+
+\backslash
+protect
\end_layout
\end_inset
-
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether this command should itself be protected.)
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-C
+\begin_layout Plain Layout
+Newline
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout-copy
+\begin_layout Plain Layout
+0
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-D
+\begin_layout Plain Layout
+
+\emph on
+1
\end_layout
\end_inset
-
+] Whether newlines are translated into LaTeX newlines (
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-typeset
+\begin_layout Plain Layout
+
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-M
+\begin_layout Plain Layout
+NextNoIndent
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-display
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-N
+\begin_layout Plain Layout
+
+\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
-buffer-new-template
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ means that it is not allowed to do so;
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-P
+\begin_layout Plain Layout
+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
-font-code
+\begin_layout Plain Layout
+ObsoletedBy
\end_layout
\end_inset
-
+ [[FIXME]]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-S
+\begin_layout Plain Layout
+OptionalArgs
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-write-as
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-T
+\begin_layout Plain Layout
+ParIndent
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-typeset-ps
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Parindent
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-C-S-V
+\begin_layout Plain Layout
+NextNoIndent
\end_layout
\end_inset
-
+.
+ Also, Standard layout paragraphs inside environments use the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-layout-paste
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Z
+\begin_layout Plain Layout
+Parsep
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-redo
+\begin_layout Plain Layout
+float=0
\end_layout
\end_inset
-
+] The vertical space between two paragraphs of this layout.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Insert
+\begin_layout Plain Layout
+Parskip
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paste
+\begin_layout Plain Layout
+float=0
\end_layout
\end_inset
+] LyX allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+indent
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ or
+\begin_inset Quotes eld
+\end_inset
-\begin_layout PlainLayout
-S-Delete
-\end_layout
+skip
+\begin_inset Quotes erd
+\end_inset
+ to typeset a document.
+ When
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+indent
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-cut
-\end_layout
+ 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
-\end_layout
+Paragraph
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ layout is ignored and all paragraphs are separated by this parskip argument.
+ The vertical space is calculated with
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-period
+\begin_layout Plain Layout
+value
+\begin_inset space ~
+\end_inset
+
+* DefaultHeight
\end_layout
\end_inset
-
+ where
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-end-of-sentence-period-insert
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-greater
+\begin_layout Plain Layout
+PassThru
\end_layout
\end_inset
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-label-goto
-\end_layout
+\begin_inset CommandInset label
+LatexCommand label
+name "des:PassThru"
\end_inset
+[
+\emph on
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-less
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
-
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-reference-back
+\begin_layout Plain Layout
+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.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-minus
+\begin_layout Plain Layout
+Preamble
\end_layout
\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Preamble"
+
+\end_inset
+
+Information to be included in the LaTeX preamable when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-hyphenation-point-insert
+\begin_layout Plain Layout
+EndPreamble
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-quotedbl
+\begin_layout Plain Layout
+Requires
\end_layout
\end_inset
-
+[
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-quote-insert
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Requires"
-\end_layout
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+Whether the layout requires the feature
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-space
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
-
+.
+ See the description of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-protected-space-insert
+\begin_layout Plain Layout
+Provides
\end_layout
\end_inset
+ above (page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+) for information on `features'.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-x
+\begin_layout Plain Layout
+RightMargin
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-command-execute
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] Similar to
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Home
+\begin_layout Plain Layout
+LeftMargin
\end_layout
\end_inset
-
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-line-begin-select
+\begin_layout Plain Layout
+Spacing
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-End
+\begin_layout Plain Layout
+
+\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
-line-end-select
+\begin_layout Plain Layout
+single
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Up
+\begin_layout Plain Layout
+onehalf
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-up-select
+\begin_layout Plain Layout
+double
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ 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
-S-Down
+\begin_layout Plain Layout
+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
-down-select
+\begin_layout Plain Layout
+Spacing
\end_layout
\end_inset
+ implies the generation of specific LaTeX code, using the package
+\family roman
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Delete
+\begin_layout Plain Layout
+setspace.sty
\end_layout
\end_inset
-
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-cut
+\begin_layout Plain Layout
+TextFont
\end_layout
\end_inset
+ The font used for the text body .
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:fonts"
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\end_inset
-\begin_layout PlainLayout
-S-Insert
+.
\end_layout
-\end_inset
-
-
+\begin_layout Description
+Need
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paste
+\begin_layout Plain Layout
+
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Next
+\begin_layout Plain Layout
+TopSep
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-down-select
+\begin_layout Plain Layout
+float=0
\end_layout
\end_inset
-
+] The vertical space with which the very first of a chain of paragraphs
+ with this layout is separated from the previous paragraph.
+ If the previous paragraph has another layout, the separations are not simply
+ added, but the maximum is taken.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-S-Prior
+\begin_layout Subsection
+Floats
\end_layout
+\begin_layout Standard
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:floats"
+
\end_inset
-
-\begin_inset Flex CharStyle:Code
+Since version 1.3.0 of LyX, it is has been both possible and necessary to
+ define the floats (
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-screen-up-select
+\begin_layout Plain Layout
+figure
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+,
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-S-Left
+\begin_layout Plain Layout
+table
\end_layout
\end_inset
-
+, \SpecialChar \ldots{}
+) in the text class itself.
+ Standard floats are included in the file
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-backward-select
+\begin_layout Plain Layout
+stdfloats.inc
\end_layout
\end_inset
+, so you may have to do no more than add
+\end_layout
+\begin_layout LyX-Code
+Input stdfloats.inc
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+to your layout file.
+ If you want to implement a text class that proposes some other float types
+ (like the AGU class bundled with LyX), the information below will hopefully
+ help you:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-Right
+\begin_layout Plain Layout
+Extension
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-forward-select
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Home
+\begin_layout Plain Layout
+GuiName
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-begin
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-End
+\begin_layout Plain Layout
+LaTeXBuiltin
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-end
+\begin_layout Plain Layout
+
+\emph on
+0
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Up
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
+] Set to
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paragraph-up
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ if the float is already defined by the LaTeX document class.
+ If this is set to
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Down
+\begin_layout Plain Layout
+0
\end_layout
\end_inset
-
+, the float will be defined using the LaTeX package
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paragraph-down
+\begin_layout Plain Layout
+float
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Delete
+\begin_layout Plain Layout
+ListName
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-delete-forward
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-BackSpace
+\begin_layout Plain Layout
+NumberWithin
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-delete-backward
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+=
+\begin_inset Quotes erd
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-Insert
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+] This (optional) argument determines whether floats of this class will
+ be numbered within some sectional unit of the document.
+ For example, if within is equal to
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-copy
+\begin_layout Plain Layout
+chapter
\end_layout
\end_inset
-
+, the floats will be numbered within chapters.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Return
+\begin_layout Plain Layout
+Placement
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-break-line
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+=
+\begin_inset Quotes erd
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Quotes erd
+\end_inset
+
+] The default placement for the given class of floats.
+ The string should be as in standard LaTeX:
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Left
+\begin_layout Plain Layout
+t
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-backward
+\begin_layout Plain Layout
+b
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Right
+\begin_layout Plain Layout
+p
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-forward
+\begin_layout Plain Layout
+h
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-C-S-Down
+\begin_layout Plain Layout
+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
-paragraph-down-select
+\begin_layout Plain Layout
+H
\end_layout
\end_inset
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+here
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and nowhere else.
+ Note however that the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-End
+\begin_layout Plain Layout
+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 Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-end-select
+\begin_layout Plain Layout
+tbp
\end_layout
\end_inset
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Home
+\begin_layout Plain Layout
+Style
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-begin-select
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+=
+\begin_inset Quotes erd
+\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-S-Left
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+] The style used when defining the float using
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-backward-select
+\begin_layout Plain Layout
+
+\backslash
+newfloat
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-Right
+\begin_layout Plain Layout
+Type
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-word-forward-select
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+=
+\begin_inset Quotes erd
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-C-S-Up
-\end_layout
+] 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
-paragraph-up-select
+\begin_layout Plain Layout
+
+\backslash
+newfloat
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+, commands such as
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-quotedbl
+\begin_layout Plain Layout
+
+\backslash
+begin{program}
\end_layout
\end_inset
-
+ or
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-quote-insert
+\begin_layout Plain Layout
+
+\backslash
+end{algorithm*}
\end_layout
\end_inset
-
+ will be available.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+Note that defining a float with type
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-Return
+\begin_layout Plain Layout
+
+\emph on
+type
\end_layout
\end_inset
-
+ automatically defines the corresponding counter with name
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-break-paragraph-keep-layout
+\begin_layout Plain Layout
+
+\emph on
+type
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-period
+\begin_layout Subsection
+Inset layouts and Flex insets
\end_layout
+\begin_layout Standard
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:charstyle"
+
\end_inset
+LyX has supported character styles since version 1.4.0; since version 1.6.0
+ these are called Flex insets.
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-dots-insert
\end_layout
-\end_inset
-
+\begin_layout Standard
+Furthermore, it is possible to define the general layout of many different
+ types of insets.
+ Currently, InsetLayout can be used to customize the layout parameters
+ for footnotes, marginal notes, note insets, ERT insets, branches, listings,
+ indexes, boxes, tables, algorithms, URLs, and optional arguments, as well
+ as Flex insets.
+
+\end_layout
+\begin_layout Standard
+Flex insets come in three different kinds:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Itemize
+character style (
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-S-Right
+\begin_layout Plain Layout
+CharStyle
\end_layout
\end_inset
+): These define semantic markup corresponding to such LaTeX commands as
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-depth-increment
+\begin_layout Plain Layout
+
+\backslash
+noun
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-S-Left
+\begin_layout Plain Layout
+
+\backslash
+code
\end_layout
\end_inset
-
+.
+\end_layout
+
+\begin_layout Itemize
+user custom (
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-depth-decrement
+\begin_layout Plain Layout
+Custom
\end_layout
\end_inset
-
+): These can be used to define custom collapsable insets, similar to ERT,
+ footnote, and the like.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Itemize
+XML elements (
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Escape
+\begin_layout Plain Layout
+Element
\end_layout
\end_inset
-
+): For use with DocBook classes.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-cancel
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+where
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F2
+\begin_layout Plain Layout
+<Type>
\end_layout
\end_inset
-
+ can be
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-write
+\begin_layout Plain Layout
+Algorithm
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F3
+\begin_layout Plain Layout
+Branch
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-open
+\begin_layout Plain Layout
+Box
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F5
+\begin_layout Plain Layout
+ERT
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-screen-recenter
+\begin_layout Plain Layout
+Figure
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F7
+\begin_layout Plain Layout
+Foot
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-spellchecker
+\begin_layout Plain Layout
+Index
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F9
+\begin_layout Plain Layout
+Listings
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-meta-prefix
+\begin_layout Plain Layout
+Marginal
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-F4
+\begin_layout Plain Layout
+Note:Comment
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-buffer-close
+\begin_layout Plain Layout
+Note:Note
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-F4
+\begin_layout Plain Layout
+Note:GreyedOut
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-lyx-quit
+\begin_layout Plain Layout
+OptArg
\end_layout
\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Table
\end_layout
-\begin_layout Subsection
-Specific to
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-sciword.bind
+\begin_layout Plain Layout
+URL
\end_layout
\end_inset
+, or
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Flex
\end_layout
-\begin_layout Standard
-These are LyX keyboard definitions for mathematics, similar to those of
- Scientific Word.
-\end_layout
-
-\begin_layout Standard
-The bindings file and the present documentation were prepared by Serge Winitzki
- with assistance from Jean-Marc Lasgouttes.
- Version 1.3, for LyX 1.2.x and 1.3.x.
-\end_layout
+\end_inset
-\begin_layout Standard
-These definitions make it a lot easier to type equations without using the
- mouse, especially for people familiar with Scientific Word.
- The standard LyX bindings such as
+.
+ If
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
+\begin_layout Plain Layout
+<Type>
\end_layout
\end_inset
+ is
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Flex
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-or
+\end_inset
+
+, then
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-o
+\begin_layout Plain Layout
+<Name>
\end_layout
\end_inset
- are unmodified.
-\end_layout
+ should have the form
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-Tip: to find the "LyX bind name" for a key, look at the status bar after
- typing some non-existent key combination.
- E.g.
- to find how "Ctrl-&" is referenced, press Ctrl-S and then Ctrl-&: the status
- bar shows "C-s S-C-ampersand." (This does not work in LyX 1.3.0!)
+\begin_layout Plain Layout
+SubType:StyleName
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+, where
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-c
+\begin_layout Plain Layout
+SubType
\end_layout
\end_inset
-
+ is either
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-copy
+\begin_layout Plain Layout
+CharStyle
\end_layout
\end_inset
- -- Copy, cut, paste is as in Sciword,
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-c
+\begin_layout Plain Layout
+Custom
\end_layout
\end_inset
-,
+, or
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-x
+\begin_layout Plain Layout
+Element
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-v
+\begin_layout Plain Layout
+StyleName
\end_layout
\end_inset
-.
+ is any valid identifier.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+The following
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-d
+\begin_layout Plain Layout
+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
-math-display
+\begin_layout Plain Layout
+BgColor
\end_layout
\end_inset
- -- Display equation toggle: type
+ The color for the inset's background.
+ These valid colors are defined in
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-d
+\begin_layout Plain Layout
+src/ColorCode.h
\end_layout
\end_inset
- to insert a displayed formula (
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-d
+\begin_layout Plain Layout
+CopyStyle
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "des:CopyStyle"
-displayed
-\begin_inset Quotes erd
\end_inset
).
- You can also type
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-d
+\begin_layout Plain Layout
+Decoration
\end_layout
\end_inset
- in a displayed formula to convert it back to an inline formula.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ can be
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-f
+\begin_layout Plain Layout
+Classic
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-frac
+\begin_layout Plain Layout
+Minimalistic
\end_layout
\end_inset
- -- Fractions: type
+, or
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-f
+\begin_layout Plain Layout
+Conglomerate
\end_layout
\end_inset
- to insert a fraction (
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-f
+\begin_layout Plain Layout
+Classic
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
+; ERT insets generally use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Minimalistic
+\end_layout
-fraction
-\begin_inset Quotes erd
\end_inset
-).
- You can also select an expression and type
+; and character styles use
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-f
+\begin_layout Plain Layout
+Conglomerate
\end_layout
\end_inset
- to convert it to the numerator of a fraction.
- Note: pressing
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Backspace
+\begin_layout Plain Layout
+Font
\end_layout
\end_inset
- at the
+ The font used for both the text body
\emph on
-left
+and
\emph default
- end of the denominator will delete the numerator and convert the denominator
- to a non-fraction.
-\end_layout
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-\begin_layout PlainLayout
-C-i
-\end_layout
+\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
-math-insert
-\backslash
-int
+\begin_layout Plain Layout
+LabelFont
\end_layout
\end_inset
- -- Inserts
-\begin_inset Formula $\int$
-\end_inset
-
- (
+ to the same value, so define this first and define
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-i
+\begin_layout Plain Layout
+LabelFont
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
-
-integral
-\begin_inset Quotes erd
-\end_inset
-
-)
+ later if you want them to be different.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-k
+\begin_layout Plain Layout
+ForceLTR
\end_layout
\end_inset
-
+ [[FIXME]]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-line-delete-forward
+\begin_layout Plain Layout
+FreeSpacing
\end_layout
\end_inset
- -- Emacs-like binding: delete forward of cursor to end of line.
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+
+).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-m
+\begin_layout Plain Layout
+KeepEmpty
\end_layout
\end_inset
-
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:KeepEmpty"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-mode
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
- -- A text/math toggle (
+ 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
-m
+\begin_layout Plain Layout
+LabelFont
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
-
-math
-\begin_inset Quotes erd
+ The font used for the label.
+ See section
+\begin_inset space ~
\end_inset
-): switches to math in text mode, and also inserts roman text in math mode.
- Also bound to
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-C-t
-\end_layout
+\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
-t
+\begin_layout Plain Layout
+Font
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
-
-text
-\begin_inset Quotes erd
-\end_inset
-
-).
+, lest it be ineffective.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-n
+\begin_layout Plain Layout
+LatexName
\end_layout
\end_inset
-
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-number
+\begin_layout Plain Layout
+LatexParam
\end_layout
\end_inset
- -- Add/remove numbering in a single equation.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ The optional parameter for the corresponding
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-N
+\begin_layout Plain Layout
+LatexName
\end_layout
\end_inset
-
+ stuff, including possible bracket pairs like
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-nonumber
+\begin_layout Plain Layout
+[]
\end_layout
\end_inset
- -- Add/remove numbering at a line in equation arrays.
+.
+ This parameter cannot be changed from within LyX.
\end_layout
-\begin_layout Standard
-The above commands are toggles that control the numbering of equations (
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-N
+\begin_layout Plain Layout
+LatexType
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:LatexType"
-number
-\begin_inset Quotes erd
\end_inset
).
- Note: when deleting a number in a labeled eqnarray, the label is not really
- removed (the TeX code becomes
-\begin_inset Quotes eld
-\end_inset
-
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-label{}
-\backslash
-nonumber
+\begin_layout Plain Layout
+LyxType
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- ) and this generates a (harmless) LaTeX warning.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ Can be
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-o
+\begin_layout Plain Layout
+charstyle
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-file-open
+\begin_layout Plain Layout
+custom
\end_layout
\end_inset
- -- Open a new document.
- (W*ndows)
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-q
+\begin_layout Plain Layout
+element
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-quote-insert
+\begin_layout Plain Layout
+end
\end_layout
\end_inset
- -- Insert a quote character " (
+ (indicating a dummy definition ending definitions of charstyles etc.).
+ This entry is only meaningful for Flex (user definable) insets.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-q
+\begin_layout Plain Layout
+NeedProtect
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-quote
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-).
- This is not the
-\begin_inset Quotes eld
-\end_inset
+\emph on
+0
+\end_layout
-smart
-\begin_inset Quotes erd
\end_inset
- double quote character that you get by default.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-r
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-
+] Whether fragile commands in this layout should be
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
+\begin_layout Plain Layout
+
\backslash
-sqrt
+protect
\end_layout
\end_inset
- -- Square root sign
-\begin_inset Formula $\sqrt{x}$
-\end_inset
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether this command should itself be protected.)
+\end_layout
- (
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-r
+\begin_layout Plain Layout
+Preamble
\end_layout
\end_inset
- for
-\begin_inset Quotes eld
-\end_inset
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Preamble"
-root
-\begin_inset Quotes erd
\end_inset
).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-R
+\begin_layout Plain Layout
+Requires
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-root
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
- -- root sign
-\begin_inset Formula $\sqrt[n]{x}$
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Requires"
+
\end_inset
-.
+).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
+\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 both possible and necessary to define the
+ counters (
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-C-t
+\begin_layout Plain Layout
+chapter
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-math-mode
+\begin_layout Plain Layout
+figure
\end_layout
\end_inset
- -- Another binding for a switch between the text and the math mode (
+, \SpecialChar \ldots{}
+) in the text class itself.
+ The standard counters are defined in the file
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-t
+\begin_layout Plain Layout
+stdcounters.inc
\end_layout
\end_inset
- is for
-\begin_inset Quotes eld
-\end_inset
+, so you may have to do no more than add
+\end_layout
-text
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
-).
- Note that the roman text inserted in math mode is special.
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so, using the
+ following parameters:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-u
+\begin_layout Plain Layout
+LabelString [string=""]
\end_layout
\end_inset
-
+ when this is defined, this string defines how the counter is displayed.
+ Setting this value sets
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-font-underline
+\begin_layout Plain Layout
+LabelStringAppendix
\end_layout
\end_inset
- --
-\bar under
-Underline
-\bar default
- the selected text (text mode only, use things like
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\backslash
-overline
+thecounter
\end_layout
\end_inset
- or
+ will be replaced by the expansion of the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-underbar
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
- for math ).
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ (or
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-v
+\begin_layout Plain Layout
+LabelStringAppendix
\end_layout
\end_inset
-
+) of the counter
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-paste
+\begin_layout Plain Layout
+counter
\end_layout
\end_inset
- -- W*ndows heritage.
+.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Itemize
+counter values can be expressed using LaTeX-like macros
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-w
+\begin_layout Plain Layout
+
+\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
-buffer-close
+\begin_layout Plain Layout
+
+\emph on
+numbertype
\end_layout
\end_inset
- -- Close the current document (again, a W*ndows heritage).
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ can be:
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-C-x
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Actually, the situation is a bit more complicated: any
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\size default
+\emph on
+\noun default
+\color inherit
+numbertype
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ other than those descibed below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
\end_layout
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-cut
+\begin_layout Plain Layout
+arabic
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+: 1, 2, 3,\SpecialChar \ldots{}
+;
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-z
+\begin_layout Plain Layout
+alph
\end_layout
\end_inset
-
+ for lower-case letters: a, b, c, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-undo
+\begin_layout Plain Layout
+Alph
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ for upper-case letters: A, B, C, \SpecialChar \ldots{}
+;
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-Z
+\begin_layout Plain Layout
+roman
\end_layout
\end_inset
-
+ for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-redo
+\begin_layout Plain Layout
+Roman
\end_layout
\end_inset
- -- the
-\begin_inset Quotes eld
-\end_inset
-
-Redo
-\begin_inset Quotes erd
-\end_inset
+ for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
+;
+\begin_inset Flex CharStyle:Code
+status collapsed
- operation, or
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+hebrew
+\end_layout
-undo the undo
-\begin_inset Quotes erd
\end_inset
-.
+ for hebrew numerals.
\end_layout
+\end_deeper
\begin_layout Standard
-Bracket delimiters: press
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl
+\begin_layout Plain Layout
+master
\end_layout
\end_inset
--<bracket key> to insert a matching pair of delimiters.
- For example,
+ (defined via
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-[
+\begin_layout Plain Layout
+Within
\end_layout
\end_inset
- inserts a pair of parentheses
-\begin_inset Formula $\left[\right]$
-\end_inset
-
-.
- (Note:
+), the string
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-]
-\end_layout
-
-\end_inset
-
- does the same thing.) It will switch to math mode if needed.
- The supported characters are ( [ { < |.
- It is the same to press the right or the left bracket.
- The corresponding delimiters are
-\begin_inset Formula $\left(\right)$
-\end_inset
-
-
-\begin_inset Formula $\left[\right]$
-\end_inset
-
-
-\begin_inset Formula $\left\{ \right\} $
-\end_inset
+\begin_layout Plain Layout
-
-\begin_inset Formula $\left\langle \right\rangle $
-\end_inset
+\backslash
+themaster.
+\backslash
+arabic{counter}
+\end_layout
-
-\begin_inset Formula $\left|\right|$
\end_inset
-.
- The delimiters are
-\begin_inset Quotes eld
-\end_inset
+ is used; otherwise the string
+\begin_inset Flex CharStyle:Code
+status collapsed
-smart
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
- and resize with their contents.
- Use Math Panel to get other or non-matching delimiters.
- Press backspace on the
-\emph on
-left
-\emph default
- delimiter to remove both
-\begin_inset Quotes eld
-\end_inset
+\backslash
+arabic{counter}
+\end_layout
-smart
-\begin_inset Quotes erd
\end_inset
- delimiters without removing their contents.
+ is used.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-9
+\begin_layout Plain Layout
+LabelStringAppendix [string=""]
\end_layout
\end_inset
-
+ Same as
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim ( )
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
- -- for convenience, pressing
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-9
+\begin_layout Plain Layout
+Name
\end_layout
\end_inset
- is the same as
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-(
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-Ctrl-)
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+] The name of the counter.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-parenleft
+\begin_layout Plain Layout
+Within
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim ( )
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
+=
+\begin_inset Quotes erd
+\end_inset
+
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] 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
-C-0
+\begin_layout Plain Layout
+subsection
\end_layout
\end_inset
-
+ is numbered inside
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim ( )
+\begin_layout Plain Layout
+section
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-S-C-parenright
+\begin_layout Subsection
+Font description
\end_layout
+\begin_layout Standard
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:fonts"
+
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+A font description looks like this:
+\end_layout
-\begin_layout PlainLayout
-math-delim ( )
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ ...
+\end_layout
+\begin_layout LyX-Code
+EndFont
+\end_layout
+\begin_layout Standard
+The following commands are available:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-bracketleft
+\begin_layout Plain Layout
+Color
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim [ ]
+\begin_layout Plain Layout
+
+\emph on
+none
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-bracketright
+\begin_layout Plain Layout
+black
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim [ ]
+\begin_layout Plain Layout
+white
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-less
+\begin_layout Plain Layout
+red
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim langle rangle
+\begin_layout Plain Layout
+green
\end_layout
\end_inset
- -- angular delimiters
-\begin_inset Formula $\left\langle \right\rangle $
-\end_inset
-
-, not to confuse with ordinary < > signs.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-greater
+\begin_layout Plain Layout
+blue
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim langle rangle
+\begin_layout Plain Layout
+cyan
\end_layout
\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+magenta
\end_layout
-\begin_layout PlainLayout
-The bar (`|') bracket: on some keyboards (e.g.
-\begin_inset Space ~
\end_inset
-some British ones), the bar character is bound to an
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Alt
+\begin_layout Plain Layout
+yellow
\end_layout
\end_inset
--something and on some wayward Unices to "brokenbar".
- So we define all of these keys as well.
+]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-bar
+\begin_layout Plain Layout
+Family
\end_layout
\end_inset
-
+ [
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim | |
+\begin_layout Plain Layout
+
+\emph on
+Roman
\end_layout
\end_inset
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\emph default
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-S-brokenbar
+\begin_layout Plain Layout
+Sans
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim | |
+\begin_layout Plain Layout
+Typewriter
\end_layout
\end_inset
-
+]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-M-bar
+\begin_layout Plain Layout
+Misc
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim | |
+\begin_layout Plain Layout
+string
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+] Valid argument sare:
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-braceleft
+\begin_layout Plain Layout
+emph
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim { }
+\begin_layout Plain Layout
+noun
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-braceright
+\begin_layout Plain Layout
+underbar
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim { }
+\begin_layout Plain Layout
+no_emph
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout PlainLayout
-Accents are in most cases
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl
+\begin_layout Plain Layout
+no_noun
\end_layout
\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+no_bar
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
--<accent key>, e.g.
-\begin_inset Space ~
\end_inset
+.
+ Each of these turns on or off the corresponding attribute.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-.
+\begin_layout Plain Layout
+Series
\end_layout
\end_inset
- for overdot,
+ [
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-'
+\begin_layout Plain Layout
+
+\emph on
+Medium
\end_layout
\end_inset
- for acute accent,
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-~
+\begin_layout Plain Layout
+Bold
\end_layout
\end_inset
- for tilde (you also need to press
+]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Shift
+\begin_layout Plain Layout
+Shape
\end_layout
\end_inset
- here) etc.
- For example,
-\begin_inset Quotes eld
-\end_inset
-
+ [
+\emph on
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Ctrl-'
+\begin_layout Plain Layout
+
+\emph on
+Up
\end_layout
\end_inset
-
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-a
+\begin_layout Plain Layout
+Italic
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- inserts á.
- Some accents work only in math mode and others only in text mode.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-period
+\begin_layout Plain Layout
+SmallCaps
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-accent-dot
+\begin_layout Plain Layout
+Slanted
\end_layout
\end_inset
- -- overdot accent, ȧ (text mode only).
+]
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-comma
+\begin_layout Plain Layout
+Size
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-dot
+\begin_layout Plain Layout
+tiny
\end_layout
\end_inset
- -- overdot accent,
-\begin_inset Formula $\dot{a}$
-\end_inset
-
- (math mode only -- in physics this denotes a first derivative).
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-equals
+\begin_layout Plain Layout
+small
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-overrightarrow
-\end_layout
+\begin_layout Plain Layout
-\end_inset
+\emph on
+normal
+\end_layout
- -- Vector accent over math
-\begin_inset Formula $\overrightarrow{x}$
\end_inset
-.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-quotedbl
+\begin_layout Plain Layout
+large
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-accent-umlaut
+\begin_layout Plain Layout
+larger
\end_layout
\end_inset
- -- umlaut accent, ä (text mode only)
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+largest
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-colon
+\begin_layout Plain Layout
+huge
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-ddot
+\begin_layout Plain Layout
+giant
\end_layout
\end_inset
- -- double dot accent,
-\begin_inset Formula $\ddot{a}$
-\end_inset
+]
+\end_layout
+
+\begin_layout Subsection
+Upgrading old layout files
+\end_layout
- (math mode only -- in physics this denotes a second derivative).
- To get a triple dot in math mode, use
+\begin_layout Standard
+The file format of layout files changes from time to time, so old layout
+ files need to be converted.
+ This process has been automated since LyX 1.4.0: If LyX reads an old format
+ layout file it will call the conversion tool
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-dddot
+\begin_layout Plain Layout
+LyXDir/scripts/layout2layout.py
\end_layout
\end_inset
+ and convert it to a temporary file in current format.
+ The original file is left untouched.
+ If you want to convert the layout file permanently, just call the converter
+ by hand:
+\end_layout
+\begin_layout LyX-Code
+python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+(You need to replace
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-quoteleft
+\begin_layout Plain Layout
+$LyXDir
\end_layout
\end_inset
-
+ with the name of your LyX system directory, unless you happen to have defined
+ such an environment variable.) Then copy
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-accent-grave
+\begin_layout Plain Layout
+myclassnew.layout
\end_layout
\end_inset
- -- grave accent à (text mode only, use
+ to
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-grave
+\begin_layout Plain Layout
+UserDir/layouts/
\end_layout
\end_inset
- for math)
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-S-C-asciitilde
+\begin_layout Standard
+The automatic conversion only handles syntax changes.
+ It cannot handle the case where the contents of included files was changed,
+ so these will have to be converted separately.
\end_layout
+\begin_layout Section
+Creating Templates
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:templates"
+
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout PlainLayout
-accent-tilde
\end_layout
-\end_inset
-
- -- tilde accent ã (text mode only, use
+\begin_layout Standard
+Templates are created just like usual documents.
+ The only difference is that usual documents contain all possible settings,
+ including the font scheme and the paper size.
+ Usually a user doesn't want a template to overwrite his defaults in these
+ cases.
+ For that reason, the designer of a template should remove the corresponding
+ commands like
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
\backslash
-tilde
+fontscheme
\end_layout
\end_inset
- for math)
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ or
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-apostrophe
+\begin_layout Plain Layout
+
+\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
-accent-acute
+\begin_layout Plain Layout
+vi
\end_layout
\end_inset
- -- acute accent á (text mode only, use
+ or
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-
-\backslash
-acute
+\begin_layout Plain Layout
+xedit
\end_layout
\end_inset
- for math)
+.
+
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+Put the edited template files you create in
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-S-C-asciicircum
+\begin_layout Plain Layout
+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
-accent-circumflex
+\begin_layout Plain Layout
+LyXDir/templates/
\end_layout
\end_inset
- -- circumflex (caret) accent â (text mode only, use
-\begin_inset Flex CharStyle:Code
+ to the same place, and redefine the template path in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
+\begin_layout Plain Layout
-\backslash
-hat
+\bar under
+T
+\family sans
+\bar default
+ools
+\family default
+\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references\SpecialChar \menuseparator
+Paths
\end_layout
\end_inset
- for math).
+ dialog.
\end_layout
\begin_layout Standard
-Function keys.
- The new key S-F2 for creating a LaTeX file seems handy.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+Note that there is a template which has a particular meaning:
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F2
+\begin_layout Plain Layout
+defaults.lyx
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+.
+ This template is loaded everytime you create a new document with
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-buffer-write
+\begin_layout Plain Layout
+
+\bar under
+F
+\bar default
+ile
\end_layout
\end_inset
- -- Save current document.
-\end_layout
+\SpecialChar \menuseparator
-\begin_layout List
-\labelwidthstring 00.00.0000
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-S-F2
+\begin_layout Plain Layout
+
+\bar under
+N
+\bar default
+ew
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ 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
-buffer-export latex
+\begin_layout Plain Layout
+Sa
+\bar under
+v
+\bar default
+e as Document Defaults
\end_layout
\end_inset
- -- Write a LaTeX file for the current document.
+ button.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Chapter
+Including External Material
+\end_layout
-\begin_layout PlainLayout
-F3
+\begin_layout Standard
+The use of material from sources external to LyX is covered in detail in
+ the
+\emph on
+Embedded Objects
+\emph default
+ manual.
+ This part of the manual covers what needs to happen behind the scenes for
+ new sorts of material to be included.
\end_layout
-\end_inset
+\begin_layout Section
+How does it work?
+\end_layout
-
-\begin_inset Flex CharStyle:Code
+\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, various
+ raster format images, chess diagrams, and LilyPond music notation.
+ You can check the actual list by using the menu
+\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-find-replace
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+External Material
\end_layout
\end_inset
- -- Find and replace dialog.
+.
+ 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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-C-F4
+\begin_layout Plain Layout
+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
-buffer-close
+\begin_layout Plain Layout
+.fig
\end_layout
\end_inset
- -- same as
+ 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
-C-w
+\begin_layout Plain Layout
+fig
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+-file.
+ When you want to include the figure in your document, you invoke
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-F4
+\begin_layout Plain Layout
+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
-lyx-quit
+\begin_layout Plain Layout
+.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 Xfig on the original
+ file with a single click from within the external material dialog in LyX,
+ and also preview the produced PostScript file with ghostview 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
+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 that 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 in section
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Security-discussion"
+
\end_inset
- --
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-Alt-F4
+.
\end_layout
-\end_inset
-
- to quit LyX is the W*ndows w*ndow manager's mnemonic.
+\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
-F4
+\begin_layout Plain Layout
+LyXDir/lib/external_templates
\end_layout
\end_inset
- to
+ file.
+ You can place your own version in
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-F8
+\begin_layout Plain Layout
+UserDir/external_templates
\end_layout
\end_inset
- are used to switch fonts.
- Use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-F4
+.
\end_layout
-\end_inset
-
- to switch back to the normal font.
- The non-default font switches
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-F5
+\begin_layout Standard
+A typical template looks like this:
\end_layout
-\end_inset
-
- -
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-F8
+\begin_layout LyX-Code
+Template XFig
\end_layout
-\end_inset
-
- all work as toggles.
- They also work on the whole word if you put the cursor in the middle of
- the word, or if you select some text.
+\begin_layout LyX-Code
+GuiName "XFig: $$AbsOrRelPathParent$$Basename"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
+HelpText
+\end_layout
-\begin_layout PlainLayout
-F4
+\begin_layout LyX-Code
+An XFig figure.
\end_layout
-\end_inset
+\begin_layout LyX-Code
+HelpTextEnd
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+InputFormat fig
+\end_layout
-\begin_layout PlainLayout
-font-default
+\begin_layout LyX-Code
+FileFilter "*.fig"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+AutomaticProduction true
+\end_layout
- -- stop using any special font
+\begin_layout LyX-Code
+Transform Rotate
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
+Transform Resize
+\end_layout
-\begin_layout PlainLayout
-F5
+\begin_layout LyX-Code
+Format LaTeX
\end_layout
-\end_inset
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
-\begin_layout PlainLayout
-font-bold
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
- -- make
-\series bold
-bold
-\series default
- text.
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pstex_t}
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
-\begin_layout PlainLayout
-F6
+\begin_layout LyX-Code
+UpdateFormat pstex
\end_layout
-\end_inset
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pstex_t"
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
-\begin_layout PlainLayout
-font-emph
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.eps"
+\end_layout
- -- make
-\emph on
-emphasized
-\emph default
- text.
+\begin_layout LyX-Code
+ReferencedFile dvi "$$AbsPath$$Basename.eps"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
-\begin_layout PlainLayout
-F7
+\begin_layout LyX-Code
+Format PDFLaTeX
\end_layout
-\end_inset
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
-\begin_layout PlainLayout
-font-code
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
- -- make
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
+\end_layout
-\begin_layout PlainLayout
-typewritten
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+UpdateFormat pdftex
+\end_layout
- text.
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pdftex_t"
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
-\begin_layout PlainLayout
-F8
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.pdf"
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
-\begin_layout PlainLayout
-font-noun
+\begin_layout LyX-Code
+Format Ascii
\end_layout
-\end_inset
+\begin_layout LyX-Code
+Product "$$Contents(
+\backslash
+"$$AbsPath$$Basename.asc
+\backslash
+")"
+\end_layout
- -- make
-\noun on
-Caps/small caps
-\noun default
- text.
- (Used sometimes for people's names.)
+\begin_layout LyX-Code
+UpdateFormat asciixfig
\end_layout
-\begin_layout Standard
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.asc"
+\end_layout
-\begin_layout PlainLayout
-F9
+\begin_layout LyX-Code
+FormatEnd
\end_layout
-\end_inset
+\begin_layout LyX-Code
+Format DocBook
+\end_layout
- is bound as
-\begin_inset Quotes eld
-\end_inset
+\begin_layout LyX-Code
+Product "<graphic fileref=
+\backslash
+"$$AbsOrRelPathMaster$$Basename.eps
+\backslash
+">
+\end_layout
-meta-prefix
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+ </graphic>"
+\end_layout
-, same as the
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+UpdateFormat eps
+\end_layout
-\begin_layout PlainLayout
-Alt
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.eps"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile docbook "$$AbsPath$$Basename.eps"
+\end_layout
- key (useful e.g.
-\begin_inset Space ~
-\end_inset
+\begin_layout LyX-Code
+ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\end_layout
-if the keyboard has no working
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
-\begin_layout PlainLayout
-Alt
+\begin_layout LyX-Code
+Product "[XFig: $$FName]"
\end_layout
-\end_inset
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
-).
+\begin_layout LyX-Code
+TemplateEnd
\end_layout
\begin_layout Standard
-Here are some Sciword-inspired mnemonics for frequently used math symbols.
- Many symbols start with a
+As you can see, the template is enclosed in
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
+\begin_layout Plain Layout
+Template
\end_layout
\end_inset
- sequence.
- Therefore
+ \SpecialChar \ldots{}
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
+\begin_layout Plain Layout
+TemplateEnd
\end_layout
\end_inset
- cannot be itself bound to anything.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+ 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
-M-apostrophe
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
+ \SpecialChar \ldots{}
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-prime
+\begin_layout Plain Layout
+FormatEnd
\end_layout
\end_inset
- -- The
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
-prime
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+The template header
+\end_layout
- symbol
-\begin_inset Formula $\prime$
-\end_inset
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
- in math mode.
- This is frequently unnecessary: in most cases the normal apostrophe works
- just fine, e.g.
-
-\begin_inset Formula $x'+2x=0$
+\begin_layout Plain Layout
+AutomaticProduction
+\begin_inset space ~
\end_inset
-, but in some cases this would generate a double superscript error in LaTeX.
- For example:
-\begin_inset Formula $x^{\prime2}$
-\end_inset
+true|false
+\end_layout
- (
-\begin_inset Formula $x$
\end_inset
- prime squared) must be entered with the prime character.
+ Whether the file represented by the template must be generated by LyX.
+ This command must occur exactly once.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+FileFilter
+\begin_inset space ~
\end_inset
-apostrophe
+<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
-command-sequence math-superscript; math-insert
-\backslash
-prime;
+\begin_layout Plain Layout
+.obj
\end_layout
\end_inset
- -- Insert a prime as a superscript (see example above).
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Up
+\begin_layout Plain Layout
+.tgo
\end_layout
\end_inset
-
+), use something like
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert ^
+\begin_layout Plain Layout
+"*.{obj,tgo}"
\end_layout
\end_inset
- -- Insert an upper index.
- Also, ^
+.
+ This command must occur exactly once.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-Down
+\begin_layout Plain Layout
+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
-math-insert _
+\begin_layout Plain Layout
+HelpText
+\begin_inset space ~
+\end_inset
+
+<text>
+\begin_inset space ~
+\end_inset
+
+HelpTextEnd
\end_layout
\end_inset
- -- Insert a lower index.
- Also, _
+ 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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+InputFormat
+\begin_inset space ~
\end_inset
-d
+<format>
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout PlainLayout
-math-insert
-\backslash
-partial
-\end_layout
+ The file format of the original file.
+ This must be the name of a format that is known to LyX (see section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Formats"
\end_inset
- -- Partial derivative symbol
-\begin_inset Formula $\partial$
+).
+ Use
+\begin_inset Quotes eld
\end_inset
-.
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+*
+\end_layout
+
\end_inset
-e
-\end_layout
+\begin_inset Quotes erd
\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
-math-insert
-\backslash
-sum
-\end_layout
-
+\begin_layout Plain Layout
+Template
+\begin_inset space ~
\end_inset
- -- Summation symbol
-\begin_inset Formula $\sum$
-\end_inset
+<id>
+\end_layout
- (not the same as the Greek letter uppercase Sigma
-\begin_inset Formula $\Sigma$
\end_inset
- because it can resize and allows smart upper/lower limits).
+ A unique name for the template.
+ It must not contain substitution macros (see below).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Transform
+\begin_inset space ~
\end_inset
-p
+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
-math-insert
-\backslash
-prod
+\begin_layout Plain Layout
+Transform
\end_layout
\end_inset
- -- Product symbol
-\begin_inset Formula $\prod$
-\end_inset
-
- (not the same as the Greek letter uppercase Pi,
-\begin_inset Formula $\Pi$
-\end_inset
+ command must have either a corresponding
+\begin_inset Flex CharStyle:Code
+status collapsed
-).
+\begin_layout Plain Layout
+TransformCommand
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
\end_inset
-i
+ or a
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TransformOption
\end_layout
\end_inset
-
+ command in the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-infty
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
- -- Infinity
-\begin_inset Formula $\infty$
-\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Format
+\begin_inset space ~
\end_inset
-x
+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
-math-insert
-\backslash
-times
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
- -- Cross product
-\begin_inset Formula $\times$
-\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Option
+\begin_inset space ~
\end_inset
-v
+<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
-math-matrix 1 2
+\begin_layout Plain Layout
+$$<name>
\end_layout
\end_inset
- -- Insert a stacked array
-\begin_inset Formula $\begin{array}{c}
-\begin{array}{c}
-\end{array}\end{array}$
-\end_inset
-
-.
- (Frequently useful in formulae.)
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ for substitution in
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
-\end_inset
-
-m
+\begin_layout Plain Layout
+Product
\end_layout
\end_inset
+.
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-matrix 3 3
+\begin_layout Plain Layout
+<value>
\end_layout
\end_inset
- -- Insert a 3
-\begin_inset Formula $\times$
-\end_inset
-
-3 matrix
-\begin_inset Formula $\begin{array}{ccc}
-\\\\\end{array}$
-\end_inset
-
-.
- (Then you can modify its size using the
-\begin_inset Flex CharStyle:MenuItem
+ itself may contain substitution macros.
+ The advantage over using
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-Edit\SpecialChar \menuseparator
-Math
+\begin_layout Plain Layout
+<value>
\end_layout
\end_inset
- menu.)
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ directly in
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
-\end_inset
-
-S-plus
+\begin_layout Plain Layout
+Product
\end_layout
\end_inset
-
+ is that the substituted value of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-dagger
+\begin_layout Plain Layout
+$$<name>
\end_layout
\end_inset
- -- The
-\begin_inset Quotes eld
-\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
-dagger
-\begin_inset Quotes erd
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Product
+\begin_inset space ~
\end_inset
-
-\begin_inset Formula $\dagger$
+<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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+Preamble
+\begin_inset space ~
\end_inset
-equal
+<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
-math-insert
-\backslash
-equiv
+\begin_layout Plain Layout
+PreambleDef
\end_layout
\end_inset
- --
-\begin_inset Quotes eld
-\end_inset
-
-Identical equality
-\begin_inset Quotes erd
-\end_inset
-
+ \SpecialChar \ldots{}
-\begin_inset Formula $\equiv$
-\end_inset
-
-.
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-equal
+\begin_layout Plain Layout
+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
-math-insert
-\backslash
-approx
-\end_layout
-
+\begin_layout Plain Layout
+ReferencedFile
+\begin_inset space ~
\end_inset
- --
-\begin_inset Quotes eld
+<format>
+\begin_inset space ~
\end_inset
-Approximate equality
-\begin_inset Quotes erd
-\end_inset
+<filename>
+\end_layout
-
-\begin_inset Formula $\approx$
\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-minus
+\begin_layout Plain Layout
+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
-math-insert
+\begin_layout Plain Layout
+
\backslash
-sim
+usepackage{}
\end_layout
\end_inset
- -- The
-\begin_inset Quotes eld
-\end_inset
+ in the LaTeX preamble.
+ This command may occur zero or more times.
+\end_layout
-of order
-\begin_inset Quotes erd
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TransformCommand
+\begin_inset space ~
\end_inset
- sign
-\begin_inset Formula $\sim$
+Rotate
+\begin_inset space ~
\end_inset
-.
+RotationLatexCommand
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\end_inset
-\begin_layout PlainLayout
-C-minus
+ 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
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-rightarrow
-\end_layout
-
-\end_inset
-
- -- The arrow
-\begin_inset Formula $\rightarrow$
+\begin_layout Plain Layout
+TransformCommand
+\begin_inset space ~
\end_inset
- as in
-\begin_inset Formula $\lim_{x\rightarrow0}$
+Resize
+\begin_inset space ~
\end_inset
-.
+ResizeLatexCommand
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\end_inset
-\begin_layout PlainLayout
-S-M-less
+ 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
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-leq
-\end_layout
-
+\begin_layout Plain Layout
+TransformOption
+\begin_inset space ~
\end_inset
- -- Less-or-equal
-\begin_inset Formula $\leq$
+Rotate
+\begin_inset space ~
\end_inset
-.
+RotationLatexOption
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\end_inset
-\begin_layout PlainLayout
-S-M-greater
+ This command specifies that rotation is done via an optional argument.
+ This command may occur once or not at all.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-geq
-\end_layout
+\begin_layout Plain Layout
+TransformOption
+\begin_inset space ~
+\end_inset
+Resize
+\begin_inset space ~
\end_inset
- -- Greater-or-equal
-\begin_inset Formula $\geq$
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+TransformOption
+\begin_inset space ~
+\end_inset
+
+Clip
+\begin_inset space ~
\end_inset
-S-less
+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
-math-insert
-\backslash
-ll
-\end_layout
-
+\begin_layout Plain Layout
+TransformOption
+\begin_inset space ~
\end_inset
- --
-\begin_inset Quotes eld
+Extra
+\begin_inset space ~
\end_inset
-Much less than
-\begin_inset Quotes erd
-\end_inset
+ExtraLatexOption
+\end_layout
-
-\begin_inset Formula $\ll$
\end_inset
- (useful in physics)
+ This command specifies that an extra optional argument is used.
+ This command may occur once or not at all.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-C-s
-\begin_inset Space ~
+\begin_layout Plain Layout
+UpdateFormat
+\begin_inset space ~
\end_inset
-S-greater
+<format>
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ 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
-math-insert
-\backslash
-gg
+\begin_layout Plain Layout
+
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references:Conversion
\end_layout
\end_inset
- --
-\begin_inset Quotes eld
-\end_inset
+ dialog).
+ This command must occur exactly once.
+\end_layout
-Much greater than
-\begin_inset Quotes erd
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+UpdateResult
+\begin_inset space ~
\end_inset
- sign
-\begin_inset Formula $\gg$
+<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 Subsection
-Standard math bindings
+Preamble definitions
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-m
-\begin_inset Space ~
-\end_inset
-
-b
+\begin_layout Plain Layout
+PreambleDef
\end_layout
\end_inset
+ \SpecialChar \ldots{}
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-overline
+\begin_layout Plain Layout
+PreambleDefEnd
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+ They can be used by the templates in the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-d
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+ section.
+\end_layout
-\begin_layout PlainLayout
-math-display
+\begin_layout Section
+The substitution mechanism
\end_layout
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
+\begin_layout Plain Layout
+$$AbsOrRelPathMaster
+\end_layout
+
\end_inset
-e
+ The file path, absolute or relative to the master LyX document.
\end_layout
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert ^
+\begin_layout Plain Layout
+$$AbsOrRelPathParent
\end_layout
\end_inset
-
+ The file path, absolute or relative to the LyX document.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-f
+\begin_layout Plain Layout
+$$AbsPath
\end_layout
\end_inset
-
+ The absolute file path.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-frac
+\begin_layout Plain Layout
+$$Basename
\end_layout
\end_inset
-
+ The filename without path and without the extension.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
+\begin_layout Plain Layout
+$$Contents(
+\begin_inset Quotes eld
+\end_inset
+
+filename.ext
+\begin_inset Quotes erd
\end_inset
-g
+)
\end_layout
\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
-math-greek
+\begin_layout Plain Layout
+filename.ext
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-h
+\begin_layout Plain Layout
+$$Extension
\end_layout
\end_inset
-
+ The file extension (including the dot).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-accent-circumflex
+\begin_layout Plain Layout
+$$FName
\end_layout
\end_inset
-
+ 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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-i
+\begin_layout Plain Layout
+$$FPath
\end_layout
\end_inset
-
+ The path part of
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-int
+\begin_layout Plain Layout
+$$FName
\end_layout
\end_inset
-
+ (absolute name or relative to the LyX document).
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-l
+\begin_layout Plain Layout
+$$RelPathMaster
\end_layout
\end_inset
-
+ The file path, relative to the master LyX document.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-limits
+\begin_layout Plain Layout
+$$RelPathParent
\end_layout
\end_inset
-
+ The file path, relative to the LyX document.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-m
+\begin_layout Plain Layout
+$$Sysdir
\end_layout
\end_inset
-
+ 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 Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-mode
+\begin_layout Plain Layout
+$$Tempname
\end_layout
\end_inset
-
+ 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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-m
-\begin_inset Space ~
-\end_inset
-
-n
+\begin_layout Plain Layout
+$$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
-math-number
+\begin_layout Plain Layout
+Product
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+ supports additionally the following substitutions if they are enabled by
+ the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-o
+\begin_layout Plain Layout
+Transform
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-oint
+\begin_layout Plain Layout
+TransformCommand
\end_layout
\end_inset
-
+ commands:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-p
+\begin_layout Plain Layout
+$$ResizeFront
\end_layout
\end_inset
-
+ The front part of the resize command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-partial
+\begin_layout Plain Layout
+$$ResizeBack
\end_layout
\end_inset
-
+ The back part of the resize command.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-r
+\begin_layout Plain Layout
+$$RotateFront
\end_layout
\end_inset
-
+ The front part of the rotation command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-sqrt
+\begin_layout Plain Layout
+$$RotateBack
\end_layout
\end_inset
-
+ The back part of the rotation command.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+The value string of the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
+\begin_layout Plain Layout
+Option
+\end_layout
+
\end_inset
-s
+ command supports additionally the following substitutions if they are enabled
+ by the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Transform
\end_layout
\end_inset
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-sqrt
+\begin_layout Plain Layout
+TransformOption
\end_layout
\end_inset
-
+ commands:
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-u
+\begin_layout Plain Layout
+$$Clip
\end_layout
\end_inset
-
+ The clip option.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-sum
+\begin_layout Plain Layout
+$$Extra
\end_layout
\end_inset
-
+ The extra option.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-v
+\begin_layout Plain Layout
+$$Resize
\end_layout
\end_inset
-
+ The resize option.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-insert
-\backslash
-vec
+\begin_layout Plain Layout
+$$Rotate
\end_layout
\end_inset
-
+ The rotation option.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+You may ask why there are so many path macros.
+ There are mainly two reasons:
+\end_layout
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
+\begin_layout Enumerate
+Relative and absolute file names should remain relative or absolute, respectivel
+y.
+ 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
-x
+\begin_layout Enumerate
+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
-\end_inset
+\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
-math-insert _
+\begin_layout Plain Layout
+$$AbsPath
\end_layout
\end_inset
-
+ if an absolute path is required.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Itemize
+Use
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-8
+\begin_layout Plain Layout
+$$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
-math-insert
-\backslash
-infty
+\begin_layout Plain Layout
+$$AbsOrRelPathParent
\end_layout
\end_inset
-
+ in order to preserve the user's choice.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
+\begin_layout Standard
+There are special cases where this rule does not work and e.g.
+\begin_inset space ~
\end_inset
-S-G
+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 Plain Layout
+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
-math-greek-toggle
+\begin_layout Plain Layout
+.pstex_t
\end_layout
\end_inset
-
+ files needs the relative name in order to rewrite the file content.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Security-discussion"
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
\end_inset
-S-N
+Security discussion
\end_layout
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+\begin_inset Note Note
status collapsed
-\begin_layout PlainLayout
-math-nonumber
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-m
-\begin_inset Space ~
-\end_inset
-
-S-period
+\begin_layout Plain Layout
+execvp
\end_layout
\end_inset
-
+-system call rather than the
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-accent-dot
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
-M-m
-\begin_inset Space ~
-\end_inset
-
-S-asciitilde
+\begin_layout Plain Layout
+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
-accent-tilde
+\begin_layout Plain Layout
+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 Plain Layout
+fork
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
\end_inset
-S-apostrophe
+ and friends, take a look at the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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
-math-insert
-\backslash
-prime
+\begin_layout Plain Layout
+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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\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
+.
+\begin_inset Foot
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
+\begin_layout Plain Layout
+There is no principled reason it cannot do so.
+ But none of the developers on Windows® have yet implemented this functionality
+ there.
+\end_layout
+
\end_inset
-S-parenleft
+
\end_layout
-\end_inset
+\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
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim ( )
+\begin_layout Plain Layout
+UserDir
\end_layout
\end_inset
+ and have the names
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
+\begin_layout Plain Layout
+.lyxpipe.in
+\end_layout
+
\end_inset
-S-bracketleft
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim [ ]
+\begin_layout Plain Layout
+.lyxpipe.out
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+.
+ External programs write into
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-S-braceleft
+\begin_layout Plain Layout
+.lyxpipe.in
\end_layout
\end_inset
-
+ and read back data from
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim { }
+\begin_layout Plain Layout
+.lyxpipe.out
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout List
-\labelwidthstring 00.00.0000
+.
+ The stem of the pipe names can be defined in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
+\begin_layout Plain Layout
+
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
-S-less
+\bar under
+P
+\bar default
+references
\end_layout
\end_inset
-
+ dialog, for example
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim langle rangle
+\begin_layout Plain Layout
+"/home/myhome/.lyxpipe"
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+LyX will add the '
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-S-greater
+\begin_layout Plain Layout
+.in
\end_layout
\end_inset
-
+' and '
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-math-delim rangle langle
+\begin_layout Plain Layout
+.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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+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
-M-m
-\begin_inset Space ~
-\end_inset
+\begin_layout Standard
+Other than this, there are a few points to consider:
+\end_layout
-S-bar
+\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
-\end_inset
+\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
-math-delim | |
+\begin_layout Plain Layout
+O_WRONLY
\end_layout
\end_inset
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
-
-S-plus
+\begin_layout Standard
+mode.
\end_layout
-\end_inset
-
-
+\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
-math-insert
-\backslash
-pm
+\begin_layout Plain Layout
+development/lyxserver/server_monitor.c
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-m
-\begin_inset Space ~
-\end_inset
+\begin_layout Section
+Normal communication
+\end_layout
-S-equal
+\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
-\end_inset
+\begin_layout Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Description
-\begin_layout PlainLayout
-math-insert
-\backslash
-neq
+\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
-\end_inset
-
+\begin_layout Description
+\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 Subsection
-Other Accelerators
-\end_layout
+\begin_layout Description
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\emph on
+argument
+\emph default
+ is an optional argument which is meaningful only to some functions (for
+ instance
+\begin_inset Quotes eld
+\end_inset
-\begin_layout PlainLayout
-M-k
-\begin_inset Space ~
+self-insert
+\begin_inset Quotes erd
\end_inset
-o
+ which will insert the argument as text at the cursor position.)
\end_layout
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+The answer from LyX will arrive in the output pipe and be of the form
+\end_layout
-\begin_layout PlainLayout
-keymap-off
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-k
-\begin_inset Space ~
-\end_inset
+\begin_layout Standard
+In case of errors, the response from LyX will have this form
+\end_layout
-t
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
\end_layout
-\end_inset
+\begin_layout Standard
+where the
+\emph on
+error message
+\emph default
+ should contain an explanation of why the command failed.
+\end_layout
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+Examples:
+\end_layout
-\begin_layout PlainLayout
-keymap-toggle
+\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
+\begin_inset Newline newline
\end_inset
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
+\end_inset
+echo $a
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\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
-\begin_layout PlainLayout
-M-k
-\begin_inset Space ~
+notify
+\begin_inset Quotes erd
\end_inset
-x
+.
+ The format of the string LyX sends is as follows:
\end_layout
-\end_inset
-
-
+\begin_layout Quote
\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout PlainLayout
-keymap-off
+\begin_layout Plain Layout
+NOTIFY:
\end_layout
\end_inset
+\emph on
+key-sequence
\end_layout
-\begin_layout List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout PlainLayout
-M-k
-\begin_inset Space ~
-\end_inset
-
-1
+\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
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+notify
+\begin_inset Quotes erd
+\end_inset
-\begin_layout PlainLayout
-keymap-primary
+, 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
-\end_inset
+\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 List
-\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
+\begin_inset Quotes eld
+\end_inset
-\begin_layout PlainLayout
-M-k
-\begin_inset Space ~
+hello
+\begin_inset Quotes erd
\end_inset
-2
-\end_layout
+ or
+\begin_inset Quotes eld
+\end_inset
+bye
+\begin_inset Quotes erd
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+ If
+\begin_inset Quotes eld
+\end_inset
-\begin_layout PlainLayout
-keymap-secondary
-\end_layout
+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
\end_body
projects / lyx.git / blobdiff