-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 361
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413
\begin_document
\begin_header
\textclass scrbook
% used for multi-column text
\usepackage{multicol}
-\usepackage{inputenc}
\end_preamble
-\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
+\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\begin_modules
logicalmkup
\end_modules
+\maintain_unincluded_children false
\begin_local_layout
-Format 7
-InsetLayout CharStyle:MenuItem
+Format 35
+InsetLayout Flex:MenuItem
LyxType charstyle
LabelString menu
LatexType command
\newcommand*{\menuitem}[1]{{\sffamily #1}}
EndPreamble
End
+# In case we need to do with sans...
+#InsetLayout CharStyle:Code
+#Font
+#Family Sans
+#EndFont
+#Preamble
+#\renewcommand{\code}[1]{{\sffamily #1}}
+#EndPreamble
+#End
\end_local_layout
\language english
+\language_package default
\inputencoding auto
+\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\graphics default
\default_output_format default
+\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize 12
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle false
-\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
\papersize default
\use_geometry false
\use_amsmath 0
\use_esint 0
+\use_mhchem 0
+\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
+\suppress_date false
+\use_refstyle 0
\branch OutDated
\selected 0
+\filename_suffix 0
\color #f5fae7
\end_branch
+\index Index
+\shortcut idx
+\color #008000
+\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
-\defskip medskip
+\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes true
+\tracking_changes false
\output_changes false
-\author "Jean-Marc Lasgouttes"
-\author ""
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict true
\end_header
\begin_body
\end_inset
in the subject header, and please cc the current maintainer of this file,
- Richard Heck <
-rgheck
-@
-comcast
-.net>.
+ Richard Heck <rgheck@comcast.net>.
\end_layout
\end_inset
This manual covers the customization features present in LyX.
In it, we discuss issues like keyboard shortcuts, screen previewing options,
printer options, sending commands to LyX via the LyX Server, internationalizati
-on, installing new
-LaTeX
- classes and LyX layouts, etc.
+on, installing new LaTeX classes and LyX layouts, etc.
We can't possibly hope to touch on everything you can change—our developers
add new features faster than we can document them—but we will explain the
most common customizations and hopefully point you in the right direction
\begin_layout Standard
\begin_inset Branch OutDated
-status open
+status collapsed
\begin_layout Standard
Information from previous versions of this document that now seems to be
- outdated is contained in the
-OutDated
- branch of this document.
- By default, this information will not appear in the
-LaTeX
- output.
+ 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
files.
Before continuing to read this chapter, you should find out where your
LyX library and user directories are by using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
\end_inset
and the latter
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\begin_layout Section
What's in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
and its sub-directories contain a number of files and that can be used
to customize LyX's behavior.
You can change many of these files from within LyX itself through the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
this dialog.
However, many other inner aspects of LyX can be customized by modifying
the files in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
\begin_layout Standard
The files, which are to be found in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-packages.
-lst
+packages.lst
\end_layout
\end_inset
contains the list of packages that have been recognized by LyX.
It is currently unused by the LyX program itself, but the information extracted
, and more, is made available with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Help\SpecialChar \menuseparator
-
LaTeX
-
\begin_inset space ~
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-textclass
-.
-lst
+textclass.lst
\end_layout
\end_inset
the list of text classes that have been found in your
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- directories, along with the associated
-LaTeX
- document class and their description.
+ 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-lyxmodules
-.
-lst
+lyxmodules.lst
\end_layout
\end_inset
the list of layout modules found in your
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*files.
-lst
+*files.lst
\end_layout
\end_inset
- lists of various sorts of
-LaTeX
--related files found on your system
+ lists of various sorts of LaTeX-related files found on your system
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-doc/
-LaTeXConfig
-.lyx
+doc/LaTeXConfig.lyx
\end_layout
\end_inset
is automatically generated during configuration from the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-LaTeXConfig
-.lyx.in
+LaTeXConfig.lyx.in
\end_layout
\end_inset
.
- It contains information on your
-LaTeX
- configuration.
+ It contains information on your LaTeX configuration.
\end_layout
\begin_layout Subsection
\begin_layout Standard
These directories are duplicated between
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
.
If a particular files exists in both places, the one in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
this directory contains files with the extension
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- that define the
-keybindings
- used in LyX.
+ that define the keybindings used in LyX.
If there exists an internationalized version of the bind file named
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-clipart
-/
+clipart/
\end_layout
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
contains LyX documentation files (including the one you are currently reading).
The file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-LaTeXConfig
-.lyx
+LaTeXConfig.lyx
\end_layout
\end_inset
deserves special attention, as noted above.
- The internationalized help docs are in
-subdirectories
-
-\begin_inset Flex CharStyle:Code
+ The internationalized help docs are in subdirectories
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
contains example files that explain how to use some features.
In the file browser, press the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
contains image files that are used by the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-kbd
-/
+kbd/
\end_layout
\end_inset
- contains keyboard
-keymapping
- files.
+ contains keyboard keymapping files.
See Chapter
\begin_inset space ~
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
lyx2lyx
\end_layout
\end_inset
contains the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
lyx2lyx
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
contains some files that demonstrate the capabilities of the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:Creating-Templates"
+reference "sub:Creating-Templates"
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-ui
-/
+ui/
\end_layout
\end_inset
contains files with the extension
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.
-ui
+.ui
\end_layout
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
this file contains the list of LyX developers.
The contents are displayed with the menu entry
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-chkconfig
-.
-ltx
+chkconfig.ltx
\end_layout
\end_inset
- this is a
-LaTeX
- script used during the configuration process.
+ this is a LaTeX script used during the configuration process.
Do not run directly.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-configure.
-py
+configure.py
\end_layout
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
encodings
\end_layout
\end_inset
- this contains tables describing how different character
-encodings
- can be mapped to Unicode
+ this contains tables describing how different character encodings can be
+ mapped to Unicode
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
this file contains the templates available to the new
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Even if you are using LyX as an unprivileged user, you might want to change
LyX configuration for your own use.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\end_inset
in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
This directory is used as a mirror of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
\end_inset
, which means that every file in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\end_inset
is a replacement for the corresponding file in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
LyXDir
\end_layout
\begin_layout Itemize
The preferences set in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
dialog are saved to a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
UserDir
\end_layout
\begin_layout Itemize
When you reconfigure using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, LyX runs the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-configure.
-py
+configure.py
\end_layout
\end_inset
directory.
This means that any additional text class file that you might have added
in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-UserDir
-/layouts
+UserDir/layouts
\end_layout
\end_inset
will be added to the list of classes in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
copy the files in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-UserDir
-/doc/
+UserDir/doc/
\end_layout
\end_inset
and the items in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Invoking LyX with the command line switch
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--
-userdir
+-userdir
\end_layout
\end_inset
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 the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--
-userdir
+-userdir
\end_layout
\end_inset
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LYX_
-USERDIR
-_
-VER
+LYX_USERDIR_VER
\end_layout
\end_inset
\begin_layout Standard
Having several configurations also requires more maintenance: if you want
to add a new layout to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-NewUserDir
-/layouts
+NewUserDir/layouts
\end_layout
\end_inset
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.
+ directory, most of the subdirectories (see above) are empty.
If you want the new configuration to mirror an existing one, replace the
- empty
-subdirectory
- with a symbolic link to the matching
-subdirectory
- in the existing configuration.
+ empty subdirectory with a symbolic link to the matching subdirectory in
+ the existing configuration.
Take care with the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-
-subdirectory
-, however, since it contains a file written by the configuration script
- (also accessible through
-\begin_inset Flex CharStyle:MenuItem
+ subdirectory, however, since it contains a file written by the configuration
+ script (also accessible through
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain 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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
dialog.
Under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
press the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
button to define your new format.
The
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
field contains the name used to identify the format in the GUI.
The
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
You will also need to enter a file extension.
These are all required.
The optional
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
field is used to provide a keyboard shortcut on the menus.
(For example, pressing
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Alt-V D
+Alt-V F D
\end_layout
\end_inset
will
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
View\SpecialChar \menuseparator
+View (Other Formats)\SpecialChar \menuseparator
DVI
\end_layout
\begin_layout Standard
A Format can have a
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and an
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
associated with it.
For example, you might want to use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
Ghostview
\end_layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
menu.
The editor is for example launched when you right-click on an image and
choose
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
), the format will appear in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
menu.
The format will also appear in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
menu if a viewer is specified for the format.
Pure image formats, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
, should not use this option.
Formats that can both represent vector graphics and documents like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
\begin_layout Standard
The option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdflatex
\end_layout
export.
Included graphics may need to be converted to either
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
\end_inset
, or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
jpg
\end_layout
\end_inset
, since
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdflatex
\end_layout
cannot handle other image formats.
If an included graphic is not already in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
\end_inset
, or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
jpg
\end_layout
\end_inset
format, it is converted to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
\end_inset
if the vector format option is set, and otherwise to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
png
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- The `
-LaTeX
-
-name'
+ The `LaTeX name'
\end_layout
\begin_layout Standard
-The latter should be the
-filename
- as it would be used in a
-LaTeX's
-
+The latter should be the filename as it would be used in a LaTeX's
\series bold
\backslash
\begin_layout Standard
Copiers can be used to do almost anything with output files.
- For example, suppose you want generated
-pdf
- files to be copied to a special directory,
-\begin_inset Flex CharStyle:Code
+ For example, suppose you want generated pdf files to be copied to a special
+ directory,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/home/you/
-pdf
-/
+/home/you/pdf/
\end_layout
\end_inset
\end_inset
Save it in your local LyX directory—say,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/home/you/.lyx/scripts/
-pdfcopier
-.sh
+/home/you/.lyx/scripts/pdfcopier.sh
\end_layout
\end_inset
—and make it executable, if you need to do so on your platform.
Then, in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
dialog, select under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-PDF
-(
-pdflatex
-)
+PDF(pdflatex)
\end_layout
\end_inset
- format—or one of the other
-pdf
- formats—and enter
-\begin_inset Flex CharStyle:Code
+ format—or one of the other pdf formats—and enter
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-pdfcopier
-.sh $$i $$o
+pdfcopier.sh $$i $$o
\end_layout
\end_inset
into the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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.
+ All these files are written to a subdirectory of the directory in which
+ the original LyX file was found.
\begin_inset Foot
status collapsed
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
LyXconv
\end_layout
\end_inset
, so HTML generated from
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-/path/to/
-filename
-.lyx
+/path/to/filename.lyx
\end_layout
\end_inset
will end up in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-/path/to/
-filename
-.
-html
-.
-LyXconv
+/path/to/filename.html.LyXconv
\end_layout
\end_inset
\begin_layout Standard
You can define your own Converters to convert files between different formats.
This is done in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
To define a new converter, select the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
from the drop-down lists, enter the command needed for the conversion,
and then press the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- The base
-filename
- of the input file (i.
+ The base filename of the input file (i.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
The path to the original input file (this is different from $$p when a
- chain of converters is called).
+ chain of converters is called)
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$e
+\end_layout
+
+\end_inset
+
+ The iconv name for the encoding of the document.
\end_layout
\begin_layout Standard
In the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- This converter runs some form of
-LaTeX
-.
- This will make LyX's
-LaTeX
- error logs available.
+ This converter runs some form of LaTeX.
+ This will make LyX's LaTeX error logs available.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
needaux
\end_layout
\end_inset
- Needs the
-LaTeX
-
-\begin_inset Flex CharStyle:MenuItem
+ Needs the LaTeX
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
xml
\end_layout
\begin_layout Standard
The following three flags are not really flags at all because they take
an argument in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
parselog
\end_layout
\end_inset
If set, the converter's standard error will be redirected to a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-infile
-.out
+infile.out
\end_layout
\end_inset
, and the script given as argument will be run as:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-script <
-infile
-.out >
-infile
-.log
+script < infile.out > infile.log
\end_layout
\end_inset
.
The argument may contain
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
resultdir
\end_layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Newline newline
\end_inset
-Note that
-resultdir
- and
-usetempdir
- make no sense together.
+Note that resultdir and usetempdir make no sense together.
The latter will be ignored if the former is given.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
resultfile
\end_layout
\end_inset
Determines the output file name and may, contain
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
.
- Sensible only with
-resultdir
- and optional even then; if not given, it defaults to `
-index'
-.
+ Sensible only with resultdir and optional even then; if not given, it defaults
+ to `index'.
\end_layout
\begin_layout Standard
\begin_layout Standard
You do not have to define converters for all 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.
+ 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
+ LaTeX to PDF: Directly, using
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdflatex
\end_layout
\end_inset
; via (DVI and) PostScript, using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
ps2pdf
\end_layout
\end_inset
; or via DVI, using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
dvipdfm
\end_layout
.
To define such alternate chains, you must define multiple target `file
-
-formats'
-, as described in section
+ formats', as described in section
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
.
For example, in the standard configuration, the formats named
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdf
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdf2
\end_layout
\end_inset
, and
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
pdf3
\end_layout
\end_inset
are defined, all of which share the extension
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-.
-pdf
+.pdf
\end_layout
\end_inset
(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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX uses the GNU
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
-file for that language.
When this is available, you'll have to generate a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-file from it and install the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-file.
The process of doing all of this is explained in the documentation for
GNU
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
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.
+ Send a message to the LyX developers' list for more information about how
+ to proceed.
\end_layout
\begin_layout Standard
\begin_inset CommandInset href
LatexCommand href
name "information on the web"
-target "http://www.lyx.org/devel/cvs.php"
+target "http://www.lyx.org/HowToUseSVN"
\end_inset
\begin_layout Itemize
Copy the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
to the folder of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-**.
-po
+**.po
\end_layout
\end_inset
files.
Then rename it to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-xx.
-po
+xx.po
\end_layout
\end_inset
.
(If
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
doesn't exist anywhere, it can be remade with the console command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- in that directory, or you can use an existing
-po
--file for some other language as a template).
+ in that directory, or you can use an existing po-file for some other language
+ as a template).
\end_layout
\begin_layout Itemize
Edit
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-xx.
-po
+xx.po
\end_layout
\end_inset
\family typewriter
KBabel
\family default
- (for
-KDE
-).
+ (for KDE).
\family typewriter
Emacs
\family default
- contains a `
-mode'
- for editing
-\begin_inset Flex CharStyle:Code
+ contains a `mode' for editing
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
\begin_layout Itemize
Generate
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
This can be done with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-msgfmt
- -o xx.mo < xx.
-po
+msgfmt -o xx.mo < xx.po
\end_layout
\end_inset
\begin_layout Itemize
Copy the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\series default
xx, and under the name
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
As said, however, it would be best if the new
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
po
\end_layout
-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.
+ So send an email to the developers' mailing list if you're interested in
+ doing that.
\end_layout
\begin_layout Subsubsection
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
means.
GNU
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
does not handle such ambiguous translations.
Therefore you have to add some context information to the message: Instead
of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
it becomes
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-To[[as in
-'From
- format x to format
-y'
-]]
+To[[as in 'From format x to format y']]
\end_layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-To[[as in
-'From
- page x to page
-y'
-]].
+To[[as in 'From page x to page y']].
\end_layout
\end_inset
Now the two occurrences of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
are different for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
gettext
\end_layout
\begin_layout Standard
The online documentation (in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
and the locale is set accordingly, these will be used automagically by
LyX.
LyX looks for translated versions as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
do right away:
\end_layout
-\begin_layout Itemize
-Read
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-DocStyle.lyx
-\end_layout
-
-\end_inset
-
-, the guide to writing LyX documentation.
- Pay special attention to the translator's section.
-\end_layout
-
\begin_layout Itemize
Check out the documentation translation web page at
\begin_inset CommandInset href
\begin_layout Itemize
Join the documentation team! There is information on how to do that in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
(
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Help\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ntroduction
+Introduction
\end_layout
\end_inset
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is the key to be translated and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is a keyboard key and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Quotation
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Oh, and about characters: backslash is escaped, so to enter it, you'll need
double backslash.
Also, quotes and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
have different meaning.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
marks comments, quotes start and end LaTeX-style commands.
To enter quote, you'll need to use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, to enter
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Also, it should look into
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file for defaults, too (for example, a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The next two sections describe the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
A
\shape up
.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
file maps keystrokes to characters or strings.
As the name suggests, it sets a keyboard mapping.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
file keywords
\shape up
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\shape default
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\shape default
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\shape up
-ksmod
+kxmod
\end_layout
\end_inset
, and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
An example of a
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
statement to cause the symbol
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to be output for the keystroke
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
Note that a
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\family default
\emph default
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ksmod
+kxmod
\end_layout
\end_inset
have been assigned a keystroke with a previous
\shape default
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
the
\shape default
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
is the first arg
\family default
ument of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
must have be
\family default
en set with a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Consider this example from the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
This allows you to press
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and get the effect of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
\shape default
in this case cancels the last dead key, so if you press
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
you get
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
After the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
mapping is performed, a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In general the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For example, in order to map
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
the same character can apply to more than one string.
In the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
You could bind the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
] to the LyX command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in your
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
file.
Now, whenever you type the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
never takes a circumflex accent.
Hitting
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
One common way to bind dead-keys is to use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
Another way involves using
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
to set up the special
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
key.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
acts in some ways just like
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
John Weiss
\noun default
: This is exactly what I do in my
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and my
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
files.
I have my
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
key set up as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
symbolic keys bound such things as
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
You can make just about anything into the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
key: One of the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
keys, a spare function key, etc.
As for the LyX commands that produce accents, check the entry for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
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 Plain Layout
-.cls
-\end_layout
-
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\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_layout Standard
+First, let us a say a few words about how one ought to think about the relation
+ between LyX and LaTeX.
+ The thing to understand is that, in a certain sense, LyX doesn't know anything
+ about LaTeX.
+ Indeed, from LyX's point of view, LaTeX is just one of several
\begin_inset Quotes eld
\end_inset
-draw
+backend formats
\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
+ in which it is capable of producing output.
+ Other such formats are DocBook, plaintext, and XHTML.
+ LaTeX is, of course, a particularly important format, but very little of
+ the information LyX has about LaTeX is actually contained in the program
+ itself.
+\begin_inset Foot
+status collapsed
- which is the internal construct LyX uses to render the screen display.
-
+\begin_layout Plain Layout
+Some commands are sufficiently complex that they are
\begin_inset Quotes eld
\end_inset
-Layout
+hardcoded
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+ into LyX.
+ But the developers generally regard this as a Bad Thing.
+\end_layout
-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 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
+ Rather, that information, even for the standard classes like
+\begin_inset Flex Code
+status collapsed
-\begin_layout Section
-Installing a new LaTeX package
+\begin_layout Plain Layout
+article.cls
\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 package for preparing slides or
- viewgraphs for overhead projectors.
- Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
- a user interface for that.
- For example on MiKTeX you start its program
-\begin_inset Quotes eld
\end_inset
-Browse Packages
-\begin_inset Quotes erd
-\end_inset
+, is contained in `layout files'.
+ Similarly, LyX itself does not know much about DocBook or XHTML.
+ What it knows is contained in layout files.
+\end_layout
- to get a list of available packages.
- To install one, right click on it or use the installing toolbar button.
- When the package you want to install is not in the list, but you have it
- in form of a
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+You can think of the layout file for a given document class as a translation
+ manual between LyX constructs---paragraphs with their corresponding styles,
+ certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
+ XHTML constructs.
+ Almost everything LyX knows about
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.cls
+article.cls
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+, for example, is contained in the file
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.sty
+article.layout
\end_layout
\end_inset
--file, then copy these files to a subfolder of your LaTeX distribution,
- for example to the folder
-\family sans
-~
-\backslash
-tex
-\backslash
-latex
-\family default
-.
- Then update the file name database of your LaTeX-distribution.
- For example on MiKTeX this is done by pressing the button
-\family sans
-Refresh
-\begin_inset space ~
-\end_inset
+ and in various other files it includes.
+ For this reason, anyone intending to write layout files should plan to
+ study the existing files.
+ A good place to start is with
+\begin_inset Flex Code
+status collapsed
-FNDB
-\family default
- that you find in MiKTeX's
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+stdsections.inc
+\end_layout
-Settings
-\begin_inset Quotes erd
\end_inset
- program.
- In both cases you need afterwards to reconfigure LyX using the menu
-\begin_inset Flex CharStyle:MenuItem
+, which is included in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+article.layout
\end_layout
\end_inset
- and then to restart LyX.
-\end_layout
+,
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-If your LaTeX distribution doesn't provide a user interface, then you can
- follow these steps by using a UNIX/Linux console.
+\begin_layout Plain Layout
+book.layout
\end_layout
-\begin_layout Enumerate
-Get the package from
-\begin_inset CommandInset href
-LatexCommand href
-name "CTAN"
-target "http://www.ctan.org/"
-
\end_inset
- or wherever.
-\end_layout
-
-\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
+, and many of the other layout files for document classes.
+ This file is where sections and the like are defined:
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-texmf.cnf
+stdsections.inc
\end_layout
\end_inset
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-This usually lives in the directory
-\begin_inset Flex CharStyle:Code
+ tells LyX how paragraphs that are marked with the Section, Subsection,
+ etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
+ commands and tags.
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$TEXMF/web2c
+article.layout
\end_layout
\end_inset
-, though you can run
-\begin_inset Flex CharStyle:Code
+ file basically just includes several of these
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-kpsewhich texmf.cnf
+std*.inc
\end_layout
\end_inset
- to locate it.
+ files.
\end_layout
+\begin_layout Standard
+Defining the LyX--LaTeX correspondence is not the only thing layout files
+ do, though.
+ Their other job is to define how the LyX constructs themselves will appear
+ on-screen.
+ The fact that layout files have these two jobs is often a source of confusion,
+ because they are completely separate.
+ Telling LyX how to translate a certain paragraph style into LaTeX does
+ not tell LyX how to display it; conversely, telling LyX how to display
+ a certain paragraph style does not tell LyX how to translate it into LaTeX
+ (let alone tell LaTeX how to display it).
+ So, in general, when you define a new LyX construct, you must always do
+ two quite separate things: (i)
+\begin_inset space ~
\end_inset
- The location of the `local' TeX tree is defined by
-\begin_inset Flex CharStyle:Code
-status collapsed
+tell LyX how to translate it into LaTeX and (ii)
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-TEXMFLOCAL
+tell LyX how to display it.
\end_layout
+\begin_layout Standard
+Much the same is true, of course, as regards LyX's other backend formats,
+ though XHTML is in some ways different, because in that case LyX
+\emph on
+is
+\emph default
+ able, to some extent, to use information about how it should display a
+ paragraph on the screen to output information (in the form of CSS) about
+ how the paragraph should be displayed in a browser.
+ Even in this case, however, the distinction between what LyX does internally
+ and how things are rendered externally remains in force, and the two can
+ be controlled separately.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+
\end_inset
-; this is usually somewhere like
-\begin_inset Flex CharStyle:Code
-status collapsed
+ for the details.
+\end_layout
-\begin_layout Plain Layout
-/usr/local/share/texmf/
+\begin_layout Section
+Installing new LaTeX files
\end_layout
+\begin_layout Standard
+Some installations may not include a LaTeX package or class file that you
+ would like to use within LyX.
+ For example, you might need FoilTeX, a package for preparing slides for
+ overhead projectors.
+ Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
+ a user interface for installing such packages.
+ For example, with MiKTeX, you start the program
+\begin_inset Quotes eld
\end_inset
-.
- The `user' TeX tree is defined by
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-TEXMFHOME
-\end_layout
-
+Package
+\begin_inset space ~
\end_inset
- and is commonly at
-\begin_inset Flex CharStyle:Code
-status collapsed
+Manager
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-$HOME/texmf/
+ to get a list of available packages.
+ To install one of them, right click on it or use the corresponding toolbar
+ button.
\end_layout
-\end_inset
-
-.
- (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.
+\begin_layout Standard
+If your LaTeX distribution does not provide such a `package manager', or
+ if the package is not available from your distribution, then follow these
+ steps to install it manually:
\end_layout
\begin_layout Enumerate
-Make sure
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-TEXMF
-\end_layout
+Get the package from
+\begin_inset CommandInset href
+LatexCommand href
+name "CTAN"
+target "http://www.ctan.org/"
\end_inset
- includes the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-TEXMFLOCAL
+ or wherever.
\end_layout
+\begin_layout Enumerate
+If the package contains a file with the ending
+\begin_inset Quotes eld
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TEXMFHOME
+.ins
\end_layout
\end_inset
- variables; e.
-\begin_inset space \thinspace{}
-\end_inset
-g.
-\begin_inset Newline newline
+\begin_inset Quotes erd
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ (is the case for FoilTeX) then open a console, change to the folder of
+ this file and execute the command
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
+latex foiltex.ins
\end_layout
\end_inset
+.
+ You have now unpacked the package and have all files to install it.
+ Most LaTeX-packages are not packed and you can skip this step.
+\end_layout
-\begin_inset Newline newline
-\end_inset
+\begin_layout Enumerate
+Now you need to decide if the package should be available for all users
+ or only for you.
+\end_layout
-But, again, most of this will
-\begin_inset Quotes eld
-\end_inset
+\begin_deeper
+\begin_layout Enumerate
+On *nix systems (Linux, OSX, etc.), if you want the new package to be available
+ for all users on your system, then install it in your `local' TeX tree,
+ otherwise install it in your own `user' TeX tree.
+ Where these trees should be created, if they do not already exist, depends
+ on your system.
+ To find this out, look in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+texmf.cnf
+\end_layout
-just work
-\begin_inset Quotes erd
\end_inset
.
-\end_layout
-
-\begin_layout Enumerate
-Create your local
\begin_inset Foot
status collapsed
\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.
+This is usually in the directory
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$TEXMF/web2c
\end_layout
\end_inset
- TeX tree.
- You must follow the directory structure of your existing
-\begin_inset Flex CharStyle:Code
+, though you can execute the command
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-texmf
+kpsewhich texmf.cnf
+\end_layout
+
+\end_inset
+
+ to locate it.
\end_layout
\end_inset
- directory, which will be found at
-\begin_inset Flex CharStyle:Code
+ The location of the `local' TeX tree is defined by the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TEXMFMAIN
+TEXMFLOCAL
\end_layout
\end_inset
-.
- For example, latex packages should go under
-\begin_inset Flex CharStyle:Code
+ variable; this is usually somewhere like
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$TEXMFLOCAL/tex/latex/
+/usr/local/share/texmf
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Enumerate
-Install the package.
- For example, you would unpack the FoilTeX tarball and copy it to
-\begin_inset Flex CharStyle:Code
+ The location of the `user' TeX tree is defined by
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$TEXMFLOCAL/tex/latex/foiltex
+TEXMFHOME
\end_layout
\end_inset
-.
- The
-\begin_inset Flex CharStyle:Code
+ and is commonly
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-foiltex
+$HOME/texmf
\end_layout
\end_inset
- directory contains various files.
+.
+ (If these variables are not predefined, you have to define them.) You'll
+ probably need root permissions to create or modify the `local' tree, but
+ not for your `user' tree.
+\begin_inset Newline newline
+\end_inset
+
+In general, it is recommended to install in the user tree because your user
+ will not be modified or even overwritten when you upgrade your system.
+ It will typically also be backed up together with everything else when
+ you backup your home directory (which, of course, you do on a regular basis).
\end_layout
\begin_layout Enumerate
-Run:
-\begin_inset Flex CharStyle:Code
+On Windows, if you want the new package to be available for all users on
+ your system, change to the folder where LaTeX is installed and then change
+ to the subfolder
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-texhash
+~
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
.
- This should create
-\begin_inset Flex CharStyle:Code
+ (For MiKTeX, this would be by default the folder
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$TEXMFLOCAL/ls-R
+~:
+\backslash
+Programs
+\backslash
+MiKTeX
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
- amongst others.
-\end_layout
+.)
+\begin_inset Foot
+status open
-\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
+\begin_layout Plain Layout
+Note that this will be the correct path only on English installations.
+ On a German one, it would be
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+~:
+\backslash
+Programme
+\backslash
+MiKTeX
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
-) and then restart LyX.
- You should then see your new package—for example
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-slides (FoilTeX)
+, and similarly for other languages.
\end_layout
\end_inset
-—under
-\begin_inset Flex CharStyle:MenuItem
+ Create there a new folder
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+foiltex
\end_layout
\end_inset
- in the
-\begin_inset Flex CharStyle:MenuItem
+ and copy all files of the package into it.
+
+\begin_inset Newline newline
+\end_inset
+
+If the package should only available for you or you don't have admin permissions
+, do the same, but in the local LaTeX folder.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., for MiKTeX
+\begin_inset space ~
+\end_inset
+
+2.8 under Windows XP, this would be the folder:
+\begin_inset Newline newline
+\end_inset
+
+
+\family sans
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document Class
+~:
+\backslash
+Documents and Settings
+\backslash
+<username>
+\backslash
+Application Data
+\backslash
+
\end_layout
\end_inset
- drop box.
-
-\end_layout
-\begin_layout Section
-Layouts
-\end_layout
+\begin_inset Newline newline
+\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
+
+\family default
+
+\begin_inset Phantom HPhantom
+status open
\begin_layout Plain Layout
-article
+
+\family sans
+~:
+\backslash
+
\end_layout
\end_inset
- text class format as an example.
- The
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.layout
+MiKTeX
+\backslash
+2.8
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
- 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"
+\begin_inset Newline newline
+\end_inset
+On Vista, it would be:
+\begin_inset Newline newline
\end_inset
- 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+~:
+\backslash
+Users
+\backslash
+<username>
+\backslash
+AppData
+\backslash
+Roaming
+\backslash
+2.8
+\backslash
+MiKTeX
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-style
\end_layout
-\end_inset
+\end_deeper
+\begin_layout Enumerate
+Now one only need to tell LaTeX that there are new files.
+ This depends on the used LaTeX-Distribution:
+\end_layout
- and
-\begin_inset Flex CharStyle:Code
+\begin_deeper
+\begin_layout Enumerate
+For TeXLive execute the command
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-StYlE
+texhash
\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
+ from a console.
+ If you installed the package for all users, then you will probably need
+ to have root permissions for that.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Enumerate
+For MiKTeX, if you have installed the package for all users, start the program
+
+\begin_inset Quotes eld
+\end_inset
-\emph on
-emphasized
-\end_layout
+Settings
+\begin_inset space ~
+\end_inset
+(Admin)
+\begin_inset Quotes erd
\end_inset
-.
- If the argument has a data type like
+ and press the button marked
\begin_inset Quotes eld
\end_inset
-string
+Refresh FNDB
\begin_inset Quotes erd
\end_inset
- or
+.
+ Otherwise start the program
\begin_inset Quotes eld
\end_inset
-float
+Settings
\begin_inset Quotes erd
\end_inset
-, the default is shown like this:
-\begin_inset Flex CharStyle:Code
+ and do the same.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Finally, you need to tell LyX that there are new packages available.
+ So, in LyX, use the menu
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-float=
-\emph on
-default
+Tools
+\family sans
+\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
-.
+ and then restart LyX.
\end_layout
-\begin_layout Subsection
-Layout modules
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Layout-modules"
+\begin_layout Standard
+Now the package is installed.
+ In our example, the document class
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Slides
+\begin_inset space ~
\end_inset
+(FoilTe
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+{}
\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
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-stdsections.inc
+x)
\end_layout
\end_inset
-—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
+ will now be available under
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Document Class
\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 mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
-\begin_inset Flex CharStyle:MenuItem
+If you would like to use a LaTeX document class that is not even listed
+ in the menu
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Document Class
\end_layout
\end_inset
-.
+, then you need to create a `layout' file for it.
+ That is the topic of the next section.
+\end_layout
+
+\begin_layout Section
+Types of layout files
+\end_layout
+
+\begin_layout Standard
+This section describes the various sorts of LyX files that contain layout
+ information.
+ These files describe various paragraph and character styles, determining
+ how LyX should display them and how they should be translated into LaTeX,
+ DocBook, XHTML, or whatever output format is being used.
-\change_inserted 0 1243500588
+\end_layout
+\begin_layout Standard
+We shall try to provide a thorough description of the process of writing
+ layout files here.
+ However, there are so many different types of documents supported even
+ by just LaTeX 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, so please
+ feel free to ask questions there.
\end_layout
\begin_layout Standard
-The argument in square brackets is optional: It declares any LaTeX packages
- on which the module depends.
- Please note that only packages about which LyX knows should be listed in
- the square brackets.
+As you prepare to write a new layout, it is extremely helpful to look at
+ the layouts distributed with LyX.
+ If you write a LyX layout for a LaTeX document class that might also be
+ used by others, or write a module that might be useful to others, then
+ you should consider posting your layout to the
+\begin_inset CommandInset href
+LatexCommand href
+name "layout section on the LyX wiki"
+target "http://wiki.lyx.org/Layouts/Layouts"
+
+\end_inset
+
+ or even to the LyX developers' list, so that it might be included in LyX
+ itself.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-The list of such packages is documented only in the source code.
+Note that LyX is licensed under the General Public License, so any material
+ that is contributed to LyX must be similarly licensed.
\end_layout
\end_inset
- LyX will not check for arbitrary packages.
-
-\change_inserted 0 1243500694
- It is also possible to use the form
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-\change_inserted 0 1243500706
-from->to
\end_layout
+\begin_layout Subsection
+Layout modules
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Layout-modules"
+
\end_inset
-, which declares that the module can only be used when there exists a conversion
- chain between formats `from' and `to'.
-\change_unchanged
\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
+We have spoken to this point about `layout files'.
+ But there are different sorts of files that contain layout information.
+ Layout files, strictly so called, have the
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-#Adds an endnote command, in addition to footnotes.
-
+\begin_layout Plain Layout
+.layout
\end_layout
-\begin_layout LyX-Code
-#You will need to add
-\backslash
-theendnotes in TeX code where you
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-#want the endnotes to appear.
+ extension and provide LyX with information about document classes.
+ As of LyX 1.6, however, layout information can also be contained in layout
-\end_layout
-
-\begin_layout LyX-Code
-#DescriptionEnd
-\end_layout
+\emph on
+modules
+\emph default
+, which have the
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-#Requires: somemodule | othermodule
+\begin_layout Plain Layout
+.module
\end_layout
-\begin_layout LyX-Code
-#Excludes: badmodule
-\end_layout
+\end_inset
-\begin_layout Standard
-The description is used in
-\begin_inset Flex CharStyle:MenuItem
+ extension.
+ Modules are to LaTeX packages much as layouts are to LaTeX classes, and
+ some modules—such as the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+endnotes
\end_layout
\end_inset
- to provide the user with information about what the module does.
- The
-\begin_inset Flex CharStyle:Code
+ module—specifically provide support for one package.
+ In a sense, layout modules are similar to included
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Requires
+These can have any extension, but by convention have the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.inc
\end_layout
\end_inset
- line is used to identify other modules with which this one must be used;
- the
-\begin_inset Flex CharStyle:Code
+ extension.
+\end_layout
+
+\end_inset
+
+ files—files like
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Excludes
+stdsections.inc
\end_layout
\end_inset
- 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
+—in that modules are not specific to a given document class but may be used
+ with many different classes.
+ The difference is that using an included file with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-somemodule
+article.cls
\end_layout
\end_inset
- is really
-\begin_inset Flex CharStyle:Code
+ requires editing that file.
+ Modules, by contrast, are selected in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-somemodule.module
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
-.
+ dialog.
\end_layout
\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.
+Building modules is the easiest way to get started with layout editing,
+ since it can be as simple as adding a single new paragraph style or flex
+ inset.
+ But modules may, in principle, contain anything a layout file can contain.
+\end_layout
+
+\begin_layout Standard
+After creating a new module and copying it to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+layouts/
+\end_layout
+
+\end_inset
+
+ folder, 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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
\emph on
-It is strongly recommended that you save your work before doing so
+It is strongly recommended that you save your work before doing this
\emph default
.
In fact,
\emph on
it is strongly recommended that you not attempt to edit modules while simultaneo
-usly working on documents
+usly working on actual 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
+\begin_layout Subsubsection
+Local Layout
\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
+Modules are to LyX as packages are to LaTeX.
+ Sometimes, however, you find yourself wanting a specific inset or character
+ style just for one document and writing a module that will also be available
+ to other documents makes little sense.
+ What you need is LyX's
+\begin_inset Quotes eld
+\end_inset
+
+Local Layout
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+You will find it under
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Local Layout
+\family default
+.
+ The large text box allows you to enter anything that you might enter in
+ a layout file or module.
+ You can think of a document's local layout, in fact, as a module that belongs
+ just to it.
+ So, in particular, you must enter a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.cls
+Format
\end_layout
\end_inset
-) and style (
-\begin_inset Flex CharStyle:Code
+ tag.
+ Any format is acceptable, but one would normally use the format current
+ at the time.
+ (In LyX 2.0, the current layout format is 35.) You should be aware that local
+ layout is not supported by versions of LyX prior to 1.6, so you should not
+ use it if you want to be able to export your document to LyX 1.5 or earlier
+ (without, that is, losing the local layout information).
+ If you wish to be able to export to 1.6---local layout is supported in 1.6,
+ though there is no UI for it---then you should use format 11 and, of course,
+ use only layout constructs that were available in LyX 1.6.
+\end_layout
+
+\begin_layout Standard
+When you have entered something in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.sty
+Local Layout
\end_layout
\end_inset
-) files.
- Supporting a style file is usually fairly easy.
- Supporting a new document class is a bit harder.
+ pane, LyX will enable the
+\begin_inset Quotes eld
+\end_inset
+
+Validate
+\begin_inset Quotes erd
+\end_inset
+
+ button at the bottom.
+ Clicking this button will cause LyX to determine whether what you have
+ entered is valid layout information for the chosen format.
+ LyX will report the result but, unfortunately, will not tell you what errors
+ there might have been.
+ These will be written to the terminal, however, if LyX is started from
+ a terminal.
+ You will not be permitted to save your local layout until you have entered
+ something valid.
+\end_layout
+
+\begin_layout Standard
+The warnings at the end of the previous section apply here, too.
+ Do not play with local layout while you are actually working, especially
+ if you have not saved your document.
+ That said, using local layout with a test document can be a very convenient
+ way to try out layout ideas, or even to start developing a module.
\end_layout
\begin_layout Subsection
-A layout for a
-\begin_inset Flex CharStyle:MenuItem
+Layout for
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-sty
+.sty
\end_layout
\end_inset
- file
+ files
\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
+There are two situations you are likely to encounter when wanting to support
+ a new LaTeX document class, involving style (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myclass.sty
+.sty
\end_layout
\end_inset
- and it is meant to be used with
-\begin_inset Flex CharStyle:MenuItem
+) files and LaTeX2e class (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-report.cls
+.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
+) .
+ Supporting a style file is usually fairly easy.
+ Supporting a new class file is a bit harder.
+ We'll discuss the former in this section and the latter in the next.
+ Similar remarks apply, of course, if you want to support a new DocBook
+ DTD.
\end_layout
\begin_layout Standard
-Then edit
-\begin_inset Flex CharStyle:Code
+The easier case is the one in which your new document class is provided
+ as a style file that is to be used in conjunction with an already supported
+ document class.
+ For the sake of the example, we'll assume that the style file is called
+
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-myclass.layout
+myclass.sty
\end_layout
\end_inset
- and change the line:
+ and that it is meant to be used with
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+report.cls
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-DeclareLaTeXClass{report}
+, which is a standard class.
+
\end_layout
\begin_layout Standard
-to read
-\end_layout
+Start by copying the existing class's layout file into your local directory:
+\begin_inset Foot
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
+Of course, which directory is your local directory will vary by platform,
+ and LyX allows you to specify your local directory on startup, too, using
+ the
+\begin_inset Flex Code
+status collapsed
-\backslash
-DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
+\begin_layout Plain Layout
+-userdir
\end_layout
-\begin_layout Standard
-Then add:
+\end_inset
+
+ option.
\end_layout
-\begin_layout LyX-Code
-Preamble
+\end_inset
+
+
+\end_layout
+
+\begin_layout LyX-Code
+cp report.layout ~/.lyx/layouts/myclass.layout
+\end_layout
+
+\begin_layout Standard
+Then edit
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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
\begin_inset Newline newline
\end_inset
\begin_layout Standard
Start LyX and select
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
Then restart LyX and try creating a new document.
You should see "
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
" as a document class option in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
in this example—so you can fiddle around with the settings for the different
sections if you wish.
+ The layout information for sections is contained in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdsections.inc
+\end_layout
+
+\end_inset
+
+, but you do not need to copy and change this file.
+ Instead, you can simply add your changes to your layout file, after the
+ line
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Input stdclass.inc
+\end_layout
+
+\end_inset
+
+, which itself includes
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdsections.inc
+\end_layout
+
+\end_inset
+
+.
+ For example, you might add these lines:
+\end_layout
+
+\begin_layout LyX-Code
+Style Chapter
+\end_layout
+
+\begin_layout LyX-Code
+ Font
+\end_layout
+
+\begin_layout LyX-Code
+ Family Sans
+\end_layout
+
+\begin_layout LyX-Code
+ EndFont
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+to change the font for chapter headings to sans-serif.
+ This will override (or, in this case, add to) the existing declaration
+ for the Chapter style.
+
+\end_layout
+
+\begin_layout Standard
+Your new package may also provide commands or environments not present in
+ the base class.
+ In this case, you will want to add these to the layout file.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:TextClass"
+
+\end_inset
+
+ for information on how to do so.
+\end_layout
+
+\begin_layout Standard
+If
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+myclass.sty
+\end_layout
+
+\end_inset
+
+ can be used with several different document classes, and even if it cannot,
+ you might find it easiest just to write a module that you can load with
+ the base class.
+ The simplest possible such module would be:
+\end_layout
+
+\begin_layout LyX-Code
+#
+\backslash
+DeclareLyXModule{My Package}
+\end_layout
+
+\begin_layout LyX-Code
+#DescriptionBegin
+\end_layout
+
+\begin_layout LyX-Code
+#Support for mypkg.sty.
+\end_layout
+
+\begin_layout LyX-Code
+#DescriptionEnd
+\begin_inset Newline newline
+\end_inset
+
+
+\end_layout
+
+\begin_layout LyX-Code
+Format 21
+\begin_inset Newline newline
+\end_inset
+
+
+\end_layout
+
+\begin_layout LyX-Code
+Preamble
+\begin_inset Newline newline
+\end_inset
+
+
+\backslash
+usepackage{mypkg}
+\begin_inset Newline newline
+\end_inset
+
+EndPreamble
+\end_layout
+
+\begin_layout Standard
+A more complex module might modify the behavior of some existing constructs
+ or define some new ones.
+ Again, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:TextClass"
+
+\end_inset
+
+ for discussion.
\end_layout
\begin_layout Subsection
-Layout for a
-\begin_inset Flex CharStyle:MenuItem
+Layout for
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-cls
+.cls
\end_layout
\end_inset
- file
+ files
\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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain 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:
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+DeclareLaTeXClass
+\end_layout
+
+\end_inset
+
+ line will be different.
+ If your new class is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+thesis
+\end_layout
+
+\end_inset
+
+ and it is based upon
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+book
+\end_layout
+
+\end_inset
+
+, then the line should read:
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
And it will be easiest if you save the file to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Again, the specifics are covered below.
\end_layout
-\begin_layout Section
-Declaring a new text class
-\end_layout
+\begin_layout Subsection
+Creating templates
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Creating-Templates"
+
+\end_inset
+
-\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!
+Once you have written a layout file for a new document class, you might
+ want to consider writing a
+\emph on
+template
+\emph default
+ for it, too.
+ A template acts as a kind of tutorial for your layout, showing how it might
+ be used, though containing dummy content.
+ You can of course look at the various templates included with LyX for ideas.
\end_layout
\begin_layout Standard
-Lines in a layout file which begin with a
-\begin_inset Flex CharStyle:Code
+Templates are created just like usual documents: using LyX.
+ 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 preferred settings
+ for such parameters.
+ For that reason, the designer of a template should remove the corresponding
+ commands like
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-#
-\end_layout
-
-\end_inset
- are comments.
- There is one exception to this rule: all layouts should begin with lines
- like:
+\backslash
+font_roman
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\size small
-#% Do not delete the line below; configure depends on this
-\end_layout
+ or
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
-\size small
-#
\backslash
-DeclareLaTeXClass{article}
+papersize
\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
+\end_inset
+
+ from the template LyX file.
+ This can be done with any simple text-editor, for example
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chkconfig.ltx
+vi
\end_layout
\end_inset
-, in a special mode where
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-#
+notepad
\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
+.
+
+\end_layout
+
+\begin_layout Standard
+Put the edited template files you create in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-article.layout
+UserDir/templates/
\end_layout
\end_inset
-, then they define a text class of name
-\begin_inset Flex CharStyle:Code
+, copy the ones you use from the global template directory in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-article
+LyXDir/templates/
\end_layout
\end_inset
- (the name of the layout file) which uses the LaTeX document class
-\begin_inset Flex CharStyle:Code
+ to the same place, and redefine the template path in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-article.cls
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths
\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
+ dialog.
+\end_layout
- that appears above is used as a description of the text class in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+Note, by the way, that there is a template which has a particular meaning:
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+defaults.lyx
\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
+.
+ This template is loaded every time you create a new document with
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-article.cls
+File\SpecialChar \menuseparator
+New
\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
+ 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 MenuItem
status collapsed
\begin_layout Plain Layout
-myarticle.layout
+Save as Document Defaults
\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
+ button.
\end_layout
-\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[article]{article (with my own headings)}
+\begin_layout Subsection
+Upgrading old layout files
\end_layout
\begin_layout Standard
-This declares a text class
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-myarticle
-\end_layout
-
-\end_inset
-
-, associated with the LaTeX document class
-\begin_inset Flex CharStyle:Code
+The format of layout files changes with each LyX release, so old layout
+ files need to be converted to the new format.
+ This process has been automated since LyX 1.4: If LyX reads a layout file
+ in an older format, it automatically calls the script
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-article.cls
+layout2layout.py
\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:
+ to convert it to a temporary file in current format.
+ The original file is left untouched.
+ If you use the layout file often, then, you may want to convert it permanently,
+ so that LyX does not have to do so itself every time.
+ To do this, you can call the converter manually:
\end_layout
\begin_layout LyX-Code
-
-\size small
-#% Do not delete the line below; configure depends on this
+mv myclass.layout myclass.old
\end_layout
\begin_layout LyX-Code
-
-\size small
-#
-\backslash
-DeclareLaTeXClass[article,foo.sty]{article (with my own headings)}
+python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
\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
+You need to replace
+\begin_inset Flex Code
+status collapsed
-\size small
-#% Do not delete the line below; configure depends on this
+\begin_layout Plain Layout
+LyXDir
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\size small
-#
-\backslash
-DeclareDocBookClass[article]{SGML (DocBook article)}
+ with the name of your LyX system directory, of course.
\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).
+Note that manual conversion does not affect included files, so these will
+ have to be converted separately.
\end_layout
-\begin_layout Standard
-So, to be as explicit as possible, the form of the layout declaration is:
-\end_layout
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:TextClass"
-\begin_layout LyX-Code
+\end_inset
-\size small
-#
-\backslash
-DeclareLaTeXClass[class,package.sty]{layout description}
+The layout file format
\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 class file
- is not specified, then LyX will simply assume that it is the same as the
- name of the layout file.
+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 too much in one sitting.
+ Go have another adult beverage, just for good measure.
\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 to
-\begin_inset Flex CharStyle:Code
+Note that all the tags used in layout files are case-insensitive.
+ This means that
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXDir/layouts/
+Style
\end_layout
\end_inset
- or to
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir/layouts
+style
\end_layout
\end_inset
-, run
-\begin_inset Flex CharStyle:MenuItem
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+StYlE
\end_layout
\end_inset
-, exit LyX and restart it.
- Then your new text class should be available along with the others.
+ are really the same tag.
+ 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 Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+emphasized
\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
+\end_inset
+
+.
+ If the argument has a data type 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 Code
status collapsed
\begin_layout Plain Layout
-layout-reload
+float=
+\emph on
+default
\end_layout
\end_inset
.
- There is no default binding for this function—though, of course, you can
- bind it to a key yourself.
- 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
+The document class declaration
\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
+Lines in a layout file which begin with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Format
+#
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ are comments.
+ There is one exception to this rule.
+ All
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int
+*.layout
\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 14.
+ files should begin with a line like:
\end_layout
-\begin_layout Subsection
-General text class parameters
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\begin_layout Standard
-These are the general parameters which describe the form of the entire document:
+\begin_layout LyX-Code
+
+\size small
+#
+\backslash
+DeclareLaTeXClass{article}
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The second line is used when you (re)configure LyX.
+ The layout file is read by the LaTeX script
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+chkconfig.ltx
\end_layout
\end_inset
- Adds information to the document preamble.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+, in a special mode where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+#
\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 Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+article.layout
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+, then they define a text class of name
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+article
\end_layout
\end_inset
- Describes various global options supported by the document class.
- See Section
-\begin_inset space ~
-\end_inset
-
+ (the name of the layout file) which uses the LaTeX document class
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:ClassOptions"
+\begin_layout Plain Layout
+article.cls
+\end_layout
\end_inset
- for a description.
- Must end with
+ (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
-\begin_inset Flex CharStyle:Code
+ that appears above is used as a description of the text class in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-End
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ dialog.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Let's assume that you wrote your own text class that uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Columns
+article.cls
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ document class, but where you changed the appearance of the section headings.
+ If you put it in a file
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+myarticle.layout
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+, the header of this file should be:
+\end_layout
-\begin_layout Plain Layout
-2
+\begin_layout LyX-Code
+
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\end_inset
+\begin_layout LyX-Code
-] Whether the class should default to having one or two columns.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
+\size small
+#
+\backslash
+DeclareLaTeXClass[article]{article (with my own headings)}
+\end_layout
+
+\begin_layout Standard
+This declares a text class
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+myarticle
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+, associated with the LaTeX document class
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+article.cls
\end_layout
\end_inset
- This sequence defines a new counter.
- See Section
-\begin_inset space ~
+ and described as
+\begin_inset Quotes eld
\end_inset
+article (with my own headings)
+\begin_inset Quotes erd
+\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+.
+ If your text class depends on several packages, you can declare it as:
+\end_layout
-\end_inset
+\begin_layout LyX-Code
- for details.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+\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_inset Flex CharStyle:Code
+\begin_layout Standard
+This indicates that your text class uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+foo.sty
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ package.
+ Finally, it is also possible to declare classes for DocBook code.
+ Typical declarations will look like:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-DefaultFont
+\size small
+#% Do not delete the line below; configure depends on this
\end_layout
-\end_inset
+\begin_layout LyX-Code
- Sets the default font used to display the document.
- See Section
-\begin_inset space ~
-\end_inset
+\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_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Standard
+So, to be as explicit as possible, the form of the layout declaration is:
+\end_layout
-\end_inset
+\begin_layout LyX-Code
- for how to declare fonts.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+\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 or if there are packages to load.
+ If the name of the class file is not specified, then LyX will simply assume
+ that it is the same as the name of the layout file.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\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 Code
status collapsed
\begin_layout Plain Layout
-EndFont
+LyXDir/layouts/
\end_layout
\end_inset
+ or to
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+UserDir/layouts
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+, run
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-DefaultModule
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+, exit LyX and restart.
+ Then your new text class should be available along with the others.
+\end_layout
+
+\begin_layout Standard
+Once the layout file is installed, you can edit it and see your changes
+ without having to reconfigure or to restart LyX.
+
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-string]
+In versions of LyX prior to 1.6, this was not true.
+ As a result, editing layout files was very time consuming, since you had
+ constantly to restart LyX to see changes.
\end_layout
\end_inset
- Specifies a module to be included by default with this document class,
- which should be specified by filename without the
-\begin_inset Flex CharStyle:Code
+ You can force a reload of the current layout by using the LyX function
+
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-.module
+layout-reload
\end_layout
\end_inset
- extension.
- The user can still remove the module, but it will be active at the outset.
- (This applies only when new files are created, or when this class is chosen
- for an existing document.)
+.
+ There is no default binding for this function—though, of course, you can
+ bind it to a key yourself.
+ But you will normally use this function simply by entering it in the mini-buffe
+r.
+
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+
+\emph on
+Warning
+\emph default
+:
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+layout-reload
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ 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 layout information while simultaneousl
+y 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.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-string
+Really bad syntax errors may even caused LyX to exit.
+ This is because certain sorts of errors may make LyX unable to read
+\emph on
+any
+\emph default
+ layout information.
+ Please be careful.
\end_layout
\end_inset
-] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex CharStyle:MenuItem
+ The LyX team strives to keep LyX stable in such situations, but safe is
+ better than sorry.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Standard
+While we're giving advice: make regular backups.
+ And be nice to your mother.
\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
+\begin_layout Subsection
+The Module declaration
+\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 mandatory argument, in curly brackets, is the name of the module, as
+ it should appear in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-ExcludesModule
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Modules
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+.
+ The argument in square brackets is optional: It declares any LaTeX packages
+ on which the module depends.
+ Please note that only packages about which LyX knows should be listed in
+ the square brackets.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-string
+The list of such packages is documented only in the source code.
\end_layout
\end_inset
-] Indicates that the module in question—which should be specified by filename
- without the
-\begin_inset Flex CharStyle:Code
+ LyX will not check for arbitrary packages.
+ It is also possible to use the form
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-.module
+from->to
\end_layout
\end_inset
- extension—cannot be used with this document class.
- This might be used in a journal-specific layout file to prevent, say, the
- use of the
-\begin_inset Flex CharStyle:Code
+ as an optional argument, which declares that the module can only be used
+ when there exists a conversion chain between the formats `
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-sec
+from
\end_layout
\end_inset
- module that numbers theorems by section.
- This tag may
-\emph on
-not
-\emph default
- be used in a module.
- Modules have their own way of excluding other modules (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Layout-modules"
+' and `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+to
+\end_layout
\end_inset
-).
+'.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The module declaration should then be followed by lines like the following
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Float
+Preferably in English if the module should be published with LyX.
+ This description will appear in the list of messages to be translated and
+ will be thus translated with the next interface update.
\end_layout
\end_inset
- Defines a new float.
- See Section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Floats"
-
-\end_inset
-
- for details.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+:
+\end_layout
+\begin_layout LyX-Code
+#DescriptionBegin
+\end_layout
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+#Adds an endnote command, in addition to footnotes.
+
+\end_layout
-\begin_layout Plain Layout
-End
+\begin_layout LyX-Code
+#You will need to add
+\backslash
+theendnotes in TeX code where you
\end_layout
-\end_inset
+\begin_layout LyX-Code
+#want the endnotes to appear.
+
+\end_layout
+\begin_layout LyX-Code
+#DescriptionEnd
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+#Requires: somemodule | othermodule
+\end_layout
-.
+\begin_layout LyX-Code
+#Excludes: badmodule
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The description is used in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Input
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Modules
\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
+ to provide the user with information about what the module does.
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdclass.inc
+Requires
\end_layout
\end_inset
-, which contains most of the basic layouts.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ line is used to identify other modules with which this one must be used;
+ the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+Excludes
\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.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-a new character style.
- See Section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Flex-insets-and"
+ 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
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+.module
+\end_layout
- for more information.
- Must end with
-\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ extension.
+ So
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+somemodule
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ is really
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+somemodule.module
\end_layout
-\end_inset
-
- A string that indicates the width of the left margin on the screen, for
- example,
-\begin_inset Quotes eld
-\end_inset
-
-MMMMM
-\begin_inset Quotes erd
\end_inset
.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-NoFloat
+\begin_layout Subsection
+Format number
\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.
+\begin_layout Standard
+The first non-comment line of any layout file, included file, or module
+
+\emph on
+must
+\emph default
+ contain the file format number:
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoStyle
+Format
\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
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+int
\end_layout
\end_inset
- A string indicating what sort of output documents using this class will
- produce.
- At present, the options are: `docbook', `latex', and `literate'.
-\change_inserted 0 1243500198
-
+] The format of the layout file.
\end_layout
-\begin_layout Description
-
-\change_inserted 0 1243500505
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted 0 1243500208
-OutputFormat
+\begin_layout Standard
+This tag was introduced with LyX 1.4.0.
+ Layout files from LyX 1.3.x and earlier don't have an explicit file format
+ and are considered to be of format 1.
+ The format for the present version of LyX is format 21.
+ But each version of LyX is capable of reading earlier versions' layout
+ files, just as they are capable of reading files produced by earlier versions
+ of LyX.
+ There is, however, no provision for converting to earlier formats.
+ So LyX 1.6.x will not read layout files in format 21 but only files in format
+ 11 or earlier.
\end_layout
-\end_inset
-
- A string indicating the file format (as defined in the Preferences dialog)
- produced by this class.
- It is mainly useful when
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:General-text-class"
-\begin_layout Plain Layout
+\end_inset
-\change_inserted 0 1243500394
-OutputType
+General text class parameters
\end_layout
-\end_inset
-
- is `literate' and one wants to define a new type of literate document.
- This string is reset to `docbook', `latex', or `literate' when the correspondin
-g
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+These are general parameters that govern the behavior of an entire document
+ class.
+ (This does
+\emph on
+not
+\emph default
+ mean that they must appear in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 0 1243500473
-OutputType
+.layout
\end_layout
\end_inset
- parameter is encountered.
-\change_unchanged
-
+ files rather than in modules.
+ A module can contain any layout tag.)
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-PageStyle
+AddToHTMLPreamble
\end_layout
\end_inset
- [
-\emph on
-
-\begin_inset Flex CharStyle:Code
+ Adds information that will be output in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-plain
+<head>
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+ block when this document class is output to XHTML.
+ Typically, this would be used to output CSS style information, but it can
+ be used for anything that can appear in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-empty
+<head>
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-headings
-\end_layout
-
+.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-] The class default pagestyle.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+EndPreamble
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Preamble
-\end_layout
+\begin_inset Quotes erd
\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 Plain Layout
-Preamble
+.
\end_layout
-\end_inset
-
- or
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- declarations.
+ Adds information to the document preamble.
Must end with
\begin_inset Quotes eld
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+CiteFormat
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ Defines formats for use in the display of bibliographic information.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Citation-format-description"
+
+\end_inset
+
+ for details.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+End
\end_layout
\end_inset
-] [
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+ClassOptions
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ Describes various global options supported by the document class.
+ See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:ClassOptions"
+
+\end_inset
+
+ for a description.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+End
\end_layout
\end_inset
-] Whether the class already provides the feature
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Columns
\end_layout
\end_inset
-.
- A feature is in general the name of a package (
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-amsmath
+
+\emph on
+1
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-makeidx
+2
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) or a macro (
-\begin_inset Flex CharStyle:Code
+] Whether the class should
+\emph on
+default
+\emph default
+ to having one or two columns.
+ Can be changed in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-url
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-boldsymbol
+Counter
\end_layout
\end_inset
-,\SpecialChar \ldots{}
-); the complete list of supported features is unfortunately not documented
- outside the LyX source code—but see
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXFeatures.cpp
+string
\end_layout
\end_inset
- if you're interested.
-
-\begin_inset Flex CharStyle:MenuItem
+] This sequence defines the properties for a counter.
+ If the counter does not yet exist, it is created; if it does exist, it
+ is modified.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX Configuration
+End
\end_layout
\end_inset
- also gives an overview of the supported packages.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+ for details on counters.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ProvidesModule
+DefaultFont
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
+ Sets the default font used to display the document.
+ See Section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-string
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
-] Indicates that this layout provides the functionality of the module mentioned,
- which should be specified by the filename without the
-\begin_inset Flex CharStyle:Code
+ for how to declare fonts.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.module
+EndFont
\end_layout
\end_inset
- extension.
- This will typically be used if the layout includes the module directly,
- rather than using the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-DefaultModule
-\end_layout
+\begin_inset Quotes erd
\end_inset
- tag to indicate that it ought to be used.
- It could be used in a module that provided an alternate implementation
- of the same functionality.
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+DefaultModule
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+string]
\end_layout
\end_inset
-] Whether the class requires the feature
-\begin_inset Flex CharStyle:Code
+ Specifies a module to be included by default with this document class.
+ The module should be specified by filename without the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+.module
\end_layout
\end_inset
-.
- Multiple features must be separated by commas.
- Note that you can only request supported features.
+ extension.
+ The user can still remove the module, but it will be active at the outset.
+ (This applies only when new files are created, or when this class is chosen
+ for an existing document.)
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+DefaultStyle
\end_layout
\end_inset
- A string that indicates the width of the right margin on the screen, for
- example,
-\begin_inset Quotes eld
-\end_inset
-
-MMMMM
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SecNumDepth
+string
\end_layout
\end_inset
- Sets which divisions get numbered.
- Corresponds to the
-\begin_inset Flex CharStyle:Code
+] This is the style that will be assigned to new paragraphs, usually
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-secnumdepth
+Standard
\end_layout
\end_inset
- counter in LaTeX.
+.
+ This will default to the first defined style if not given, but you are
+ encouraged to use this directive.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sides
+ExcludesModule
\end_layout
\end_inset
[
-\emph on
-
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+string
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+] This tag indicates that the module in question—which should be specified
+ by filename without the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-2
+.module
\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
+ extension—cannot be used with this document class.
+ This might be used in a journal-specific layout file to prevent, say, the
+ use of the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+theorems-sec
\end_layout
\end_inset
- dialog.
+ module that numbers theorems by section.
+ This tag may
+\emph on
+not
+\emph default
+ be used in a module.
+ Modules have their own way of excluding other modules (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Layout-modules"
+
+\end_inset
+
+).
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+Float
\end_layout
\end_inset
- This sequence defines a new paragraph style.
- If the style already exists, it will redefine some of its parameters instead.
+ Defines a new float.
See Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Paragraph-Styles"
+reference "sub:Floats"
\end_inset
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+HTMLPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ Sets the information that will be output in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+<head>
\end_layout
\end_inset
-] The name of the command or environment to be used with
-\begin_inset Flex CharStyle:Code
+ block when this document class is output to XHTML.
+ Note that this will completely override any prior
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+HTMLPreamble
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+AddToHTMLPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ declarations.
+ (Use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-CommandAfter
+AddToHTMLPreamble
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ if you just want to add material to the preamble.) Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+EndPreamble
\end_layout
\end_inset
-] Indicates what kind of markup is used to define the title of a document.
-
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandAfter
+HTMLTOCSection
\end_layout
\end_inset
- means that the macro with name
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+string
\end_layout
\end_inset
- will be inserted after the last layout which has
-\begin_inset Quotes eld
-\end_inset
-
+] The layout to use for the table of contents, bibliography, and so forth,
+ when the document is output to HTML.
+ For articles, this should normally be Section; for books, Chapter.
+ If it is not given, then LyX will attempt to figure out which layout to
+ use.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle 1
+IfCounter
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+string
\end_layout
\end_inset
- corresponds to the case where the block of paragraphs which have
+] Modifies the properties of the given counter.
+ If the counter does not exist, the section is ignored.
+ Must end with
\begin_inset Quotes eld
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle 1
+End
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- should be enclosed into the
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-TitleLatexName
-\end_layout
+See Section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
- environment.
+ for details on counters.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TocDepth
+IfStyle
\end_layout
\end_inset
- Sets which divisions are included in the table of contents.
- Corresponds to the
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tocdepth
+string
\end_layout
\end_inset
- counter in LaTeX.
-\end_layout
+] Modifies the properties of the given paragraph style.
+ If the style does not exist, the section is ignored.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+End
\end_layout
\end_inset
- section
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:ClassOptions"
+\begin_inset Quotes erd
\end_inset
-
+.
\end_layout
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+Input
\end_layout
\end_inset
- section can contain the following entries:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ 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 Code
status collapsed
\begin_layout Plain Layout
-FontSize
+stdclass.inc
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+, which contains most of the basic layouts.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="10|11|12"
+InsetLayout
\end_layout
\end_inset
-] The list of available font sizes for the document's main font, separated
- by
+ This section (re-)defines the layout of an inset.
+ It can be applied to an existing inset or to a new, user-defined inset,
+ e.g., a new character style.
+ Must end with
\begin_inset Quotes eld
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-|
+End
\end_layout
\end_inset
\end_inset
.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Header
-\end_layout
-
+\begin_inset Newline newline
\end_inset
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
+See Section
+\begin_inset space ~
\end_inset
-g.: PUBLIC
-\begin_inset Quotes eld
-\end_inset
--//OASIS//DTD DocBook V4.2//EN
-\begin_inset Quotes erd
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Flex-insets-and"
+
\end_inset
-.
+ for more information.
+
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PageStyle
+LeftMargin
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string="empty|plain|headings|fancy"
+string
\end_layout
\end_inset
-] The list of available page styles, separated by
+] A string that indicates the width of the left margin on the screen, for
+ example,
\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-|
-\end_layout
-
+MMMMM
+\begin_inset Quotes erd
\end_inset
+.
+ (Note that this is not a `length', like
+\begin_inset Quotes eld
+\end_inset
+2ex
\begin_inset Quotes erd
\end_inset
-.
+.)
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Other
+NoCounter
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+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
+] This command deletes an existing counter, usually one defined in an included
+ file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-documentclass
+NoFloat
\end_layout
\end_inset
- command.
+ This command deletes an existing float.
+ This is particularly useful when you want to suppress a float that has
+ been defined in an input file.
\end_layout
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+NoStyle
\end_layout
\end_inset
- section must end with
-\begin_inset Quotes eld
-\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_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+OutputFormat
\end_layout
\end_inset
+ A string indicating the file format (as defined in the Preferences dialog)
+ produced by this class.
+ It is mainly useful when
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Plain Layout
+OutputType
\end_layout
-\begin_layout Subsection
-Paragraph Styles
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Paragraph-Styles"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-A paragraph style description looks like this:
-\begin_inset Foot
+ is `literate' and one wants to define a new type of literate document.
+ This string is reset to `docbook', `latex', or `literate' when the correspondin
+g
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new layout or modify an existing one.
+OutputType
\end_layout
\end_inset
-
+ parameter is encountered.
\end_layout
-\begin_layout LyX-Code
-Style
-\family roman
-\emph on
-name
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- ...
+\begin_layout Plain Layout
+OutputType
\end_layout
-\begin_layout LyX-Code
-End
-\end_layout
+\end_inset
-\begin_layout Standard
-where the following commands are allowed:
+ A string indicating what sort of output documents using this class will
+ produce.
+ At present, the options are: `docbook', `latex', and `literate'.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Align
+PageStyle
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-block
-\emph default
-, left, right, center
+plain
\end_layout
\end_inset
-] Paragraph alignment.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AlignPossible
+empty
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-block
-\emph default
-, left, right, center
+headings
\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 Description
-\begin_inset Flex CharStyle:Code
+] The default pagestyle.
+ Can be changed in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-BottomSep
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+Preamble
\end_layout
\end_inset
-]
-\begin_inset Foot
+ Sets the preamble for the LaTeX document.
+ Note that this will completely override any prior
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+Preamble
\end_layout
\end_inset
- The vertical space with which the last of a chain of paragraphs with this
- layout is separated from the following paragraph.
- If the next paragraph has another layout, the separations are not simply
- added, but the maximum is taken.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Category
+AddToPreamble
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ declarations.
+ (Use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+AddToPreamble
\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
+ if you just want to add material to the preamble.) Must end with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandDepth
+EndPreamble
\end_layout
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+Provides
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:CopyStyle"
-
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[string]
+string
\end_layout
\end_inset
- Copies all the features of an existing style into the current one.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+
+\emph on
+0
\end_layout
\end_inset
- 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
+,
+\begin_inset Flex Code
status collapsed
\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.
+1
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] Whether the class already provides the feature
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+string
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+.
+ A feature is in general the name of a package (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-No_Label
-\emph default
-, Box, Filled_Box, Static
+amsmath
\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
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+makeidx
\end_layout
\end_inset
- is
-\begin_inset Flex CharStyle:Code
+, \SpecialChar \ldots{}
+) or a macro (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+url
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+boldsymbol
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+,\SpecialChar \ldots{}
+); the complete list of supported features is unfortunately not documented
+ outside the LyX source code—but see
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+LaTeXFeatures.cpp
\end_layout
\end_inset
-).
+ if you're interested.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-No_Label
+Help\SpecialChar \menuseparator
+LaTeX Configuration
\end_layout
\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
-
-nothing
-\begin_inset Quotes erd
-\end_inset
+ also gives an overview of the supported packages.
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+ProvidesModule
\end_layout
\end_inset
- (resp.
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\begin_inset space ~
-\end_inset
-
-Filled_Box
+string
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
+] Indicates that this layout provides the functionality of the module mentioned,
+ which should be specified by the filename without the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
\end_inset
-black) square suitable for end of proof markers,
-\begin_inset Flex CharStyle:Code
+ extension.
+ This will typically be used if the layout includes the module directly,
+ rather than using the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+DefaultModule
\end_layout
\end_inset
- is an explicit text string.
+ tag to indicate that it ought to be used.
+ It could also be used in a module that provided an alternate implementation
+ of the same functionality.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+Requires
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+string
\end_layout
\end_inset
-] The string used for a label with a
-\begin_inset Flex CharStyle:Code
+] Whether the class requires the feature
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+string
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+.
+ Multiple features must be separated by commas.
+ Note that you can only request supported features.
+ (Again, see
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+LaTeXFeatures.cpp
\end_layout
\end_inset
-.
-
+ for a list of these.)
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Fill_Bottom
+RightMargin
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ A string that indicates the width of the right margin on the screen, for
+ example,
+\begin_inset Quotes eld
+\end_inset
+
+MMMMM
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+SecNumDepth
\end_layout
\end_inset
-] Similar to
-\begin_inset Flex CharStyle:Code
+ Sets which divisions get numbered.
+ Corresponds to the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Fill_Top
+secnumdepth
\end_layout
\end_inset
-.
+ counter in LaTeX.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Fill_Top
+Sides
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-0
-\emph default
-,1
+1
\end_layout
\end_inset
-] With this parameter the
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Fill
+2
\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
+] Whether the class-default should be printing on one or both sides of the
+ paper.
+ Can be changed in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
+Document\SpecialChar \menuseparator
Settings
\end_layout
\end_inset
- dialog can be set when initializing a paragraph with this style.
-\begin_inset Foot
+ dialog.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Note from Jean-Marc:
-\emph default
- I'm not sure that this setting has much use, and it should probably be
- removed in later versions.
+Style
\end_layout
\end_inset
-
-\end_layout
+ This sequence defines a paragraph style.
+ If the style does not yet exist, it is created; if it does exist, its parameter
+s are modified.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+End
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Font-description"
+reference "sub:Paragraph-Styles"
\end_inset
-.
- Note that defining this font automatically defines the
-\begin_inset Flex CharStyle:Code
+ for details on paragraph styles.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+TitleLatexName
\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
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+string="maketitle"
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] The name of the command or environment to be used with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+TitleLatexType
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
-
-\end_inset
-
-[
-\emph on
+.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+TitleLatexType
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\emph on
+CommandAfter
\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
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+Environment
\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
+] Indicates what kind of markup is used to define the title of a document.
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+CommandAfter
\end_layout
\end_inset
- Language dependent information to be included in the LaTeX preamble when
- this style is used.
- Note that this will completely override any prior
-\begin_inset Flex CharStyle:Code
+ means that the macro with name
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+TitleLatexName
\end_layout
\end_inset
- declarations.
- Must end with
+ will be inserted after the last layout which has
\begin_inset Quotes eld
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+InTitle 1
\end_layout
\end_inset
\end_inset
.
- The contents of this tag will occur once in the LaTeX preamble for each
- language used by the document.
- Each time, the following substitutions are made:
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$$lang
+Environment
\end_layout
\end_inset
- is replaced by the language name (as used by the babel package).
+ corresponds to the case where the block of paragraphs which have
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InTitle 1
\end_layout
-\begin_layout Itemize
-The
-\begin_inset Quotes eld
\end_inset
-Function
+
\begin_inset Quotes erd
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ should be enclosed into the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+TitleLatexName
\end_layout
\end_inset
- replaces its argument by the translation of the argument to the current
- language.
-\end_layout
-
-\begin_layout Standard
-This preamble snippet will only be used if the document contains more than
- one language and the babel package is used.
+ environment.
\end_layout
-\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+TocDepth
\end_layout
\end_inset
- Like
-\begin_inset Flex CharStyle:Code
+ Sets which divisions are included in the table of contents.
+ Corresponds to the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+tocdepth
\end_layout
\end_inset
-, but this preamble snippet occurs independently from the babel package,
- and only for the document language.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
+ counter in LaTeX.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Subsection
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+ClassOptions
\end_layout
\end_inset
+ section
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:ClassOptions"
-\begin_inset Quotes erd
\end_inset
-.
+
\end_layout
-\begin_deeper
\begin_layout Standard
-If the style defines text that appears in the typeset document, it may use
-
-\begin_inset Flex CharStyle:Code
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+ClassOptions
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ section can contain the following entries:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+FontSize
\end_layout
\end_inset
- to support non-english and even multilanguage documents correctly.
- The following excerpt (from the
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+string="10|11|12"
\end_layout
\end_inset
- file) shows how this works:
-\end_layout
+] The list of available font sizes for the document's main font, separated
+ by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-Preamble
-\end_layout
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
+\begin_layout Plain Layout
+|
\end_layout
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Header
\end_layout
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+ Used to set the DTD line with XML-based output classes.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
-\end_layout
+g.: PUBLIC
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-EndBabelPreamble
+-//OASIS//DTD DocBook V4.2//EN
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-The key to correct translation of the user visible text is the definition
- of the command
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+PageStyle
\end_layout
\end_inset
- in the language preamble.
- This command holds the name of the theorem that will appear in the output.
- The
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+string="empty|plain|headings|fancy"
\end_layout
\end_inset
- then uses the commands offered by the babel package to redefine
-\begin_inset Flex CharStyle:Code
+] The list of available page styles, separated by
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-claimname
+|
\end_layout
\end_inset
- for each used language in multilanguage documents.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InnerTag
+Other
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle
+string=""
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+] Some document class options, separated by a comma, that will be added
+ to the optional part of the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[1, 0]
+
+\backslash
+documentclass
\end_layout
\end_inset
- If 1, marks the layout as being part of a title block (see also the
-\begin_inset Flex CharStyle:Code
+ command.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+ClassOptions
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ section must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+End
\end_layout
\end_inset
- global entries).
-\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-ItemSep
+.
\end_layout
+\begin_layout Subsection
+Paragraph styles
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Paragraph-Styles"
+
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-float=0
\end_layout
-\end_inset
-
-] This provides extra space between paragraphs that have the same layout.
- If you put other layouts into an environment, each is separated with the
- environment's
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+A paragraph style description looks like this:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Parsep
+Note that this will either define a new style or modify an existing one.
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-Itemsep
\end_layout
-\end_inset
-
-.
- Note that this is a
+\begin_layout LyX-Code
+Style
+\family roman
\emph on
- multiplier.
+name
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-ItemTag
+\begin_layout LyX-Code
+ ...
\end_layout
-\end_inset
+\begin_layout LyX-Code
+End
+\end_layout
- [[FIXME]] (Used only with XML-type formats.)
+\begin_layout Standard
+where the following commands are allowed:
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+Align
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
+ [
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
-[
\emph on
+block
+\emph default
+, left, right, center
+\end_layout
+
+\end_inset
-\begin_inset Flex CharStyle:Code
+] Paragraph alignment.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+AlignPossible
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\emph on
+block
+\emph default
+, left, right, center
\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.
+] 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 Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+BabelPreamble
\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
+ Note that this will completely override any prior
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+BabelPreamble
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+EndBabelPreamble
\end_layout
\end_inset
-).
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
+
+\end_inset
+
+ for details on its use.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+BottomSep
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+float=0
\end_layout
\end_inset
]
-\begin_inset Newline newline
-\end_inset
+\begin_inset Foot
+status collapsed
-The name of the counter for automatic numbering (see Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+\begin_layout Plain Layout
+Note that a `float' here is a real number, such as: 1.5.
+\end_layout
\end_inset
- for details).
- This must be given if
-\begin_inset Flex CharStyle:Code
+ The vertical space with which the last of a chain of paragraphs with this
+ style is separated from the following paragraph.
+ If the next paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Labeltype
+Category
\end_layout
\end_inset
- is
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+[string]
\end_layout
\end_inset
-.
+ The category for this style.
+ This is used to group related styles in the style combobox on the toolbar.
+ Any string can be used, but you may want to use existing categories with
+ your own styles.
+
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+CommandDepth
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
+ Depth of XML command.
+ Used only with XML-type formats.
+\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+CopyStyle
+\end_layout
\end_inset
-.
-\end_layout
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:CopyStyle"
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelIndent
+[string]
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
+ Copies all the features of an existing style into the current one.
+
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Labelsep
+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 Plain Layout
-string=""
+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
-] 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+EndLabeltype
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+No_Label
+\emph default
+, Box, Filled_Box, Static
\end_layout
\end_inset
-] The string used for a label with a
-\begin_inset Flex CharStyle:Code
+] The type of label that stands at the end of the paragraph (or sequence
+ of paragraphs if
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LatexType
\end_layout
\end_inset
- labeltype.
- When
-\begin_inset Flex CharStyle:Code
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+Environment
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Item_Environment
+\end_layout
\end_inset
-.
-\begin_inset Foot
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
-\begin_inset Flex CharStyle:Code
+List_Environment
+\end_layout
+
+\end_inset
+
+).
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-@
-\emph on
-style-name
-\emph default
-@
+No_Label
\end_layout
\end_inset
- will be replaced by the expanded
-\begin_inset Flex CharStyle:Code
+ means
+\begin_inset Quotes eld
+\end_inset
+
+nothing
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Box
\end_layout
\end_inset
- of style
-\begin_inset Flex CharStyle:Code
+ (resp.
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+\begin_inset space ~
+\end_inset
-\emph on
-style-name
+Filled_Box
\end_layout
\end_inset
-.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
+) is a white (resp.
+\begin_inset space ~
\end_inset
-.
+black) square suitable for end of proof markers,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Static
\end_layout
\end_inset
-
+ is an explicit text string.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+EndLabelString
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-] This is used inside the appendix instead of
-\begin_inset Flex CharStyle:Code
+] The string used for a label with a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Static
\end_layout
\end_inset
-.
- Note that every
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+EndLabelType
\end_layout
\end_inset
- statement resets
-\begin_inset Flex CharStyle:Code
+.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Font
\end_layout
\end_inset
- too.
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ to the same value.
+ So you should define this one first if you also want to define
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelTag
+LabelFont
\end_layout
\end_inset
- [FIXME] (Used only with XML-type formats.)
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+FreeSpacing
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:FreeSpacing"
+
+\end_inset
+
+[
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
- Enumerate, Itemize, Bibliography
+0
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+1
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
- Use protected spaces (like
-\begin_inset space ~
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+FreeSpacing
+\end_layout
+
\end_inset
-that one) if you want more than one word as the label.
-
+ 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 Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+HTML*
\end_layout
\end_inset
- means the label is simply whatever
-\begin_inset Flex CharStyle:Code
+ These tags are used with XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Paragraph-Style-XHTML"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+InnerTag
\end_layout
\end_inset
- declares it to be.
- Note that this really is `static'.
+ [[FIXME]] (Used only with XML-type formats.)
\end_layout
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+InPreamble
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+[1, 0]
\end_layout
\end_inset
- are special cases of
-\begin_inset Flex CharStyle:Code
+ If 1, marks the style as to be included in the document preamble rather
+ than in the document body.
+ This is useful for document classes that want such information as the title
+ and author to appear in the preamble.
+ Note that this works only for styles for which the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LatexType
\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.
- This might be used with the
-\begin_inset Flex CharStyle:MenuItem
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Abstract
+Command
\end_layout
\end_inset
- layout, for example.
-\end_layout
-
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+Paragraph
\end_layout
\end_inset
- is a special case for the caption-labels
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
-Figure
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+InTitle
+\end_layout
-Table
-\begin_inset Quotes erd
\end_inset
-.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+[1, 0]
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float: It is
- hardcoded to be `FloatType N', where N is the value of the counter associated
- with the float.
-\end_layout
-
-\begin_layout Itemize
-The
-\begin_inset Flex CharStyle:Code
+ If 1, marks the style as being part of a title block (see also the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+TitleLatexType
\end_layout
\end_inset
- label type defines automatically numbered labels.
- The
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+TitleLatexName
\end_layout
\end_inset
- will be expanded to resolve any counter references it contains: For example,
- it might be
-\begin_inset Quotes eld
-\end_inset
-
+ global entries).
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Section
-\backslash
-thechapter.
-\backslash
-thesection
+ItemSep
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
+ environment's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parsep
+\end_layout
\end_inset
- for more information on counters.
+.
+ But the whole items of the environment are additionally separated with
+ this
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Itemsep
\end_layout
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+.
+ Note that this is a
+\emph on
+ multiplier.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+ItemTag
\end_layout
\end_inset
- produces the usual sort of enumeration labels.
- At present, it is hardcoded to use Arabic numerals, lowercase letters,
- small Roman numerals, and uppercase letters for the four possible depths.
+ [[FIXME]] (Used only with XML-type formats.)
\end_layout
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemize
+KeepEmpty
\end_layout
\end_inset
- produces various bullets at the different levels.
- It is also hardcoded.
-\end_layout
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:KeepEmpty"
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+[
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+
+\emph on
+0
\end_layout
\end_inset
- is used internally by LyX and should be used only with
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType BibEnvironment
+1
\end_layout
\end_inset
-.
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a style can be used
+ as some kind of break, which does not contain actual text.
\end_layout
-\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+LabelBottomsep
\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
+ [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 Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+Top_Environment
\end_layout
\end_inset
- An optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Centered_Top_Environment
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within LyX.
+).
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelCounter
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:LatexType"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string=""
+\end_layout
\end_inset
-[
-\begin_inset Flex CharStyle:Code
-status collapsed
+]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
+The name of the counter for automatic numbering.
+
+\begin_inset Newline newline
+\end_inset
+This
\emph on
-Paragraph
+must
\emph default
-, Command, Environment, Item_Environment,
+ be given if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment, Bib_Environment
+Counter
\end_layout
\end_inset
-] How the layout should be translated into LaTeX.
-\begin_inset Foot
+.
+ In that case, the counter will be stepped each time the style appears.
+
+\begin_inset Newline newline
+\end_inset
+
+This
+\emph on
+may
+\emph default
+ also be given if
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\begin_inset Flex CharStyle:Code
+LabelType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Enumerate
\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.
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelCounter myenum
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_deeper
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+.
+ Then the actual counters used are
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+myenumi
\end_layout
\end_inset
- means nothing special.
-
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+myenumii
\end_layout
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+myenumiii
\end_layout
\end_inset
- means
-\begin_inset Flex CharStyle:Code
+, and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+myenumiv
+\end_layout
-\backslash
+\end_inset
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
-\end_layout
+, much as in LaTeX.
+ These counters must all be declared separately.
+\begin_inset Newline newline
+\end_inset
+
+See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
-.
+ for details on counters.
\end_layout
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelFont
\end_layout
\end_inset
- means
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
.
-
\end_layout
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+LabelIndent
\end_layout
\end_inset
- is the same as
-\begin_inset Flex CharStyle:Code
+ Text that indicates how far a label should be indented.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Labelsep
\end_layout
\end_inset
-, except that an
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+string=""
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+] 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 Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+LabelString
\end_layout
\end_inset
- is the same as
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+string=""
\end_layout
\end_inset
-, except that
-\begin_inset Flex CharStyle:Code
+] The string used for a label with a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+Static
\end_layout
\end_inset
- is passed as an argument to the environment.
-
-\begin_inset Flex CharStyle:Code
+ labeltype.
+ When
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+LabelCounter
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex CharStyle:MenuItem
+ is set, this string can be contain the special formatting commands described
+ in Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
+For the sake of backwards compatibility, the string
+\begin_inset Flex Code
+status collapsed
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
+\begin_layout Plain Layout
+@
+\emph on
+style-name
+\emph default
+@
\end_layout
\end_inset
- dialog.
-
-\end_layout
+ will be replaced by the expanded
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
-\end_layout
+ of style
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-or:
+\begin_layout Plain Layout
+
+\emph on
+style-name
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
-
-\backslash
-end{latexname}.
+.
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-depending upon the LaTeX type.
+\end_inset
+
+
\end_layout
-\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+LabelStringAppendix
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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 margin is defined as
-\begin_inset Flex CharStyle:Code
+] This is used inside the appendix instead of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+LabelString
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+.
+ Note that every
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+LabelString
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
-
-\begin_inset Newline newline
-\end_inset
-
-The argument is passed as a string.
- For example
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+ statement resets
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+LabelStringAppendix
\end_layout
\end_inset
+ too.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelTag
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
\end_inset
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+LabelType
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+
+\emph on
+No_Label
+\emph default
+, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
+ Enumerate, Itemize, Bibliography
+\end_layout
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
\end_inset
+]
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--
+Manual
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces (like
+\begin_inset space ~
\end_inset
-.
- This way was chosen so that the look is the same with each used screen
- font.
+that one) if you want more than one word as the label.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Margin
+Static
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ means the label is simply whatever
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+LabelString
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
+ declares it to be.
+ Note that this really is `static'.
+\end_layout
-The kind of margin that the layout has on the left side.
-
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+Top_Environment
\end_layout
\end_inset
- just means a fixed margin.
-
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+Centered_Top_Environment
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex CharStyle:MenuItem
+ are special cases of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+Static
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-
-\begin_inset Flex CharStyle:Code
+.
+ The label will be printed above the paragraph, but only at the top of an
+ environment or the top of a chain of paragraphs with this style.
+ This might be used with the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Dynamic
+Abstract
\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
+ style, for example.
+\end_layout
-5.4.3.2.1 Very long headline
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
- must have a wider left margin (as wide as
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Sensitive
+\end_layout
-5.4.3.2.1
-\begin_inset Quotes erd
\end_inset
- plus the space) than
+ is a special case for the caption-labels
\begin_inset Quotes eld
\end_inset
-3.2 Very long headline
+Figure
\begin_inset Quotes erd
\end_inset
-, even if standard
+ and
\begin_inset Quotes eld
\end_inset
-word processors
+Table
\begin_inset Quotes erd
\end_inset
- are not able to do this.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+Sensitive
\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.
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Counter
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ label type defines automatically numbered labels.
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LabelString
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
+ will be expanded to resolve any counter references it contains: For example,
+ it might be
+\begin_inset Quotes eld
\end_inset
-] Whether fragile commands in this layout should be
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
+Section
\backslash
-protect
+thechapter.
+\backslash
+thesection
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether this command should itself be protected.)
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
+
+\end_inset
+
+ for more information on counters.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Newline
+Enumerate
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ produces the usual sort of enumeration labels.
+ At present, it is hardcoded to use Arabic numerals, lowercase letters,
+ small Roman numerals, and uppercase letters for the four possible depths.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Itemize
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ produces various bullets at the different levels.
+ It is also hardcoded.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Bibliography
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
-\begin_inset Flex CharStyle:Code
+ is used internally by LyX and should be used only with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-
+LatexType BibEnvironment
\end_layout
\end_inset
-) or not.
- The translation can be switched off to allow more comfortable LaTeX editing
- inside LyX.
+.
\end_layout
+\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LangPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ Note that this will completely override any prior
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LangPreamble
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
-
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-] Whether the following Paragraph is allowed to indent its very first row.
-
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+EndLangPreamble
\end_layout
\end_inset
- means that it is not allowed to do so;
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-0
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+
+.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\end_inset
- means it could do so if it wants to.
+ for details on its use.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+LatexName
\end_layout
\end_inset
- Name of a layout that has replaced this layout.
- This is used to rename a layout, while keeping backward compatibility.
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+LatexParam
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ An optional parameter for the corresponding
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int=0
+LatexName
\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.
+ stuff.
+ This parameter cannot be changed from within LyX.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ParIndent
+LatexType
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:LatexType"
+
+\end_inset
+
+[
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
\end_layout
\end_inset
-] The indent of the very first line of a paragraph.
- The
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+List_Environment, Bib_Environment
\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
+] How the style should be translated into LaTeX.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
\end_layout
\end_inset
-.
- Also, Standard layout paragraphs inside environments use the
-\begin_inset Flex CharStyle:Code
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+Paragraph
\end_layout
\end_inset
- of the environment, not their native one.
- For example, Standard paragraphs inside an enumeration are not indented.
+ means nothing special.
+
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parsep
+Command
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ means
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
\end_layout
\end_inset
-] The vertical space between two paragraphs of this layout.
+.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parskip
+Environment
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ means
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
-\end_layout
-\end_inset
-
-] LyX allows the user to choose either
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
-indent
-\begin_inset Quotes erd
-\end_inset
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
- or
-\begin_inset Quotes eld
\end_inset
-skip
-\begin_inset Quotes erd
-\end_inset
+.
+
+\end_layout
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
-indent
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Item_Environment
+\end_layout
- is chosen, this value is completely ignored.
- When
-\begin_inset Quotes eld
\end_inset
-skip
-\begin_inset Quotes erd
-\end_inset
+ is the same as
+\begin_inset Flex Code
+status collapsed
- is chosen, the parindent of a LaTeXtype
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Environment
+\end_layout
-Paragraph
-\begin_inset Quotes erd
\end_inset
- layout is ignored and all paragraphs are separated by this parskip argument.
- The vertical space is calculated with
-\begin_inset Flex CharStyle:Code
+, except that an
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-value
-\begin_inset space ~
-\end_inset
-* DefaultHeight
+\backslash
+item
\end_layout
\end_inset
- where
-\begin_inset Flex CharStyle:Code
+ is generated for each paragraph of this environment.
+
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+List_Environment
\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.
+ is the same as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Item_Environment
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+, except that
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+LabelWidthString
\end_layout
\end_inset
+ is passed as an argument to the environment.
-\begin_inset CommandInset label
-LatexCommand label
-name "des:PathThru"
-
-\end_inset
-
-[
-\emph on
-
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LabelWidthString
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+ can be defined in the
+\begin_inset Flex MenuItem
status collapsed
\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
+\bar under
+Edit
+\bar default
+\SpecialChar \menuseparator
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\bar under
+P
+\bar default
+aragraph
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-Preamble
+settings
\end_layout
\end_inset
+ dialog.
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Preamble"
-
-\end_inset
-
-Information to be included in the LaTeX preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
-\begin_inset Quotes eld
-\end_inset
+\end_layout
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-EndPreamble
+\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
\end_layout
-\end_inset
+\begin_layout Standard
+or:
+\end_layout
+\begin_layout LyX-Code
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+
+\backslash
+end{latexname}.
+\end_layout
-.
+\begin_layout Standard
+depending upon the LaTeX type.
\end_layout
+\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+LeftMargin
\end_layout
\end_inset
-[
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+string=""
\end_layout
\end_inset
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
-
+] If you put styles into environments, the leftmargins are not simply added,
+ but added with a factor
+\begin_inset Formula $\frac{4}{depth+4}$
\end_inset
-Whether the layout requires the feature
-\begin_inset Flex CharStyle:Code
+.
+ Note that this parameter is also used when the margin is defined as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Manual
\end_layout
\end_inset
-.
- See the description of
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+Dynamic
\end_layout
\end_inset
- above (page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+.
+ Then it is added to the manual or dynamic margin.
+
+\begin_inset Newline newline
+\end_inset
+The argument is passed as a string.
+ For example
+\begin_inset Quotes eld
\end_inset
-) for information on `features'.
-
-\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+MM
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+
+\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 Code
status collapsed
\begin_layout Plain Layout
-string=""
+MM
\end_layout
\end_inset
-] Similar to
-\begin_inset Flex CharStyle:Code
+
+\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 Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+-
\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 Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+Margin
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-single
+Static
\emph default
-, onehalf, double, other
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
+]
+\begin_inset Newline newline
+\end_inset
+
+The kind of margin that the style has on the left side.
-\emph on
-value
-\emph default
-] This defines what the default spacing should be in the layout.
- The arguments
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-single
+Static
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ just means a fixed margin.
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
+Manual
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ means that the left margin depends on the string entered in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-double
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\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
+ dialog.
+ This is used to typeset nice lists without tabulators.
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-other
+Dynamic
\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
+ 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
-\begin_layout Plain Layout
-Spacing
-\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
- implies the generation of specific LaTeX code, using the package
-\family roman
+5.4.3.2.1
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Flex CharStyle:Code
-status collapsed
+ plus the space) than
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-setspace.sty
-\end_layout
+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 Description
-\begin_inset Flex CharStyle:Code
+ are not able to do this.
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TextFont
+First_Dynamic
\end_layout
\end_inset
- The font used for the text body .
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ 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 Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-TocLevel [int]
+Right_Address_Box
\end_layout
\end_inset
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
+ 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TopSep
+NeedProtect
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\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.
+\emph on
+0
\end_layout
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Floats"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is has been both possible and necessary to
- define the floats (
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+] Whether fragile commands in this style should be
+\begin_inset Flex Code
status collapsed
\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 Plain Layout
-stdfloats.inc
+\backslash
+protect
\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 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:
+'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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Extension
+Newline
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+0
\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
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-GuiName
+
+\emph on
+1
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+] Whether newlines are translated into LaTeX newlines (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\backslash
-=
-\begin_inset Quotes erd
-\end_inset
+\backslash
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The string that will be used in the menus and also for the caption.
+) 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXBuiltin
+NextNoIndent
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+1
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\emph on
+0
\end_layout
\end_inset
-] Set to
-\begin_inset Flex CharStyle:Code
+] If set to true, and if
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+DefaultStyle
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
- If this is set to
-\begin_inset Flex CharStyle:Code
+ (usually
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Standard
\end_layout
\end_inset
-, the float will be defined using the LaTeX package
-\begin_inset Flex CharStyle:Code
+) paragraphs are being indented, then the indentation of such a paragraph
+ following one of this type will be suppressed.
+ (So this will not affect the display of non-default paragraphs.)
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float
+ObsoletedBy
\end_layout
\end_inset
-.
+ Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
+OptionalArgs
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+int=0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+] The number of optional arguments that can be used with this style.
+ This is useful for things like section headings, and only makes sense with
+ LaTeX.
+ Note that, on output, the optional arguments will all precede any required
+ arguments (see below).
+ So one can have constructs like:
+\end_layout
+\begin_deeper
+\begin_layout LyX-Code
-\begin_inset Quotes erd
-\end_inset
+\backslash
+mycmd[opt1]{req1}{contents of paragraph}
+\end_layout
-] The heading used for the list of floats.
+\begin_layout Standard
+but one cannot have things like:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
-\begin_layout Plain Layout
-NumberWithin
+\backslash
+mycmd[opt1]{req1}[opt2]{contents of paragraph}
\end_layout
-\end_inset
+\begin_layout Standard
+at least, not without ERT (with which you can have anything).
+
+\end_layout
- [
-\begin_inset Flex CharStyle:Code
+\end_deeper
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+ParbreakIsNewline
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "des:ParbreakIsNewline"
-\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
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+
+\emph on
+0
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Placement
+1
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+] Indicates that paragraphs will not be separated by an empty line in LaTeX
+ output, but only by a line break; together with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+PassThru 1
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
+, this allows to emulate a plain text editor (like the ERT inset).
+\end_layout
-] The default placement for the given class of floats.
- The string should be as in standard LaTeX:
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-t
+ParIndent
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-b
+string=""
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-p
+Parindent
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ will be fixed for a certain style.
+ The exception is the default style, since the indentation for these paragraphs
+ can be prohibited with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-h
+NextNoIndent
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+.
+ Also,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+Standard
\end_layout
\end_inset
- On top of that there is a new type,
-\begin_inset Flex CharStyle:Code
+ style paragraphs inside environments use the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+Parindent
\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
+ of the environment, not their native one.
+ For example,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+Standard
\end_layout
\end_inset
- specifier is special and, because of implementation details, cannot be
- used in non-built in float types.
- If you do not understand what this means, just use
-\begin_inset Quotes eld
-\end_inset
-
+ paragraphs inside an enumeration are not indented.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tbp
+Parsep
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+] The vertical space between two paragraphs of this style.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+Parskip
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+float=0
\end_layout
\end_inset
-=
+] LyX allows the user 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
-] The style used when defining the float using
-\begin_inset Flex CharStyle:Code
-status collapsed
+ to typeset a document.
+ When
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+indent
+\begin_inset Quotes erd
+\end_inset
-\backslash
-newfloat
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Type
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-string
-\end_layout
-
-\end_inset
-
-=
-\begin_inset Quotes erd
+ is chosen, this value is completely ignored.
+ When
+\begin_inset Quotes eld
\end_inset
-
+skip
\begin_inset Quotes erd
\end_inset
-] The
+ is chosen, the parindent of a LaTeXtype
\begin_inset Quotes eld
\end_inset
-type
+Paragraph
\begin_inset Quotes erd
\end_inset
- of the new class of floats, like program or algorithm.
- After the appropriate
-\begin_inset Flex CharStyle:Code
+ style is ignored and all paragraphs are separated by this parskip argument.
+ The vertical space is calculated with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+value
+\begin_inset space ~
+\end_inset
-\backslash
-newfloat
+* DefaultHeight
\end_layout
\end_inset
-, commands such as
-\begin_inset Flex CharStyle:Code
+ where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+DefaultHeight
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+ 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 Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-end{algorithm*}
+PassThru
\end_layout
\end_inset
- will be available.
-\end_layout
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:PassThru"
-\begin_layout Standard
-Note that defining a float with type
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+[
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-type
+0
\end_layout
\end_inset
- automatically defines the corresponding counter with name
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+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 Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Flex-insets-and"
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
\end_inset
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Preamble"
-\end_layout
+\end_inset
-\begin_layout Standard
-LyX has supported character styles since version 1.4.0; as of version 1.6.0,
- these are called Flex insets.
-
-\end_layout
+Information to be included in the LaTeX preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Flex insets come in three different kinds:
-\end_layout
-\begin_layout Itemize
-character style (
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+EndPreamble
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-noun
+RefPrefix
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-code
+string
\end_layout
\end_inset
-.
+] The prefix to use when creating labels referring to paragraphs of this
+ type.
+ This allows the use of formatted references.
\end_layout
-\begin_layout Itemize
-user custom (
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Custom
+RequiredArgs
\end_layout
\end_inset
-): These can be used to define custom collapsible insets, similar to TeX
- code, footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-endnote
+int=0
\end_layout
\end_inset
- module.
-\end_layout
-
-\begin_layout Itemize
-XML elements (
-\begin_inset Flex CharStyle:Code
+] The number of required arguments that the LaTeX command or environment
+ corresponding to this style expects.
+ In the case of a command, these are required arguments
+\emph on
+other than
+\emph default
+ that associated with the content of the paragraph itself.
+ These do not actually have to be provided: LyX will output empty arguments
+ if necessary.
+ Note that optional arguments will be output before required arguments.
+ See the discussion of the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Element
+OptionalArgs
\end_layout
\end_inset
-): For use with DocBook classes.
+ tag above for more information.
\end_layout
-\begin_layout Standard
-Flex insets are defined using the
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+Requires
\end_layout
\end_inset
- tag, which shall be explained in a moment.
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+string
\end_layout
\end_inset
- tag also serves another function: It can be used to customize the general
- layout of many different types of insets.
- Currently,
-\begin_inset Flex CharStyle:Code
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Requires"
+
+\end_inset
+
+Whether the style requires the feature
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+string
\end_layout
\end_inset
- can be used to customize the layout parameters for footnotes, marginal
- notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
- boxes, tables, algorithms, URLs, and optional arguments, as well as to
- define Flex insets.
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
+.
+ See the description of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+Provides
\end_layout
\end_inset
- definition must begin with a line of the form:
-\end_layout
+ above (page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
-\begin_layout LyX-Code
-InsetLayout <Type>
+\end_inset
+
+) for information on `features'.
+
\end_layout
-\begin_layout Standard
-Here
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+RightMargin
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are two
- cases.
-\end_layout
-
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+string=""
\end_layout
\end_inset
- any one of the following:
-\begin_inset Flex CharStyle:Code
+] Similar to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+LeftMargin
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+Spacing
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+
+\emph on
+single
+\emph default
+, onehalf, double, other
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\emph on
+value
+\emph default
+] This defines what the default spacing should be in the style.
+ The arguments
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+single
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ERT
+onehalf
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Figure
+double
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ If you specify the argument
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Foot
+other
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+, then you should also provide a numerical argument which will be the actual
+ multiplier value.
+ Note that, contrary to other parameters,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Index
+Spacing
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ implies the generation of specific LaTeX code, using the package
+\family roman
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info
+setspace.sty
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:menu
+Spellcheck
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+0
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcuts
+
+\emph on
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] Spellcheck paragraphs of this style.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Listings
+TextFont
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ The font used for the text body .
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Marginal
+TocLevel
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\series medium
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Comment
+
+\series medium
+[int]
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\series default
+ 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 Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+TopSep
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:GreyedOut
+float=0
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-OptArg
+] The vertical space with which the very first of a chain of paragraphs
+ with this style is separated from the previous paragraph.
+ If the previous paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:I18n"
+
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+Internationalization of Paragraph Styles
+\end_layout
+
+\begin_layout Standard
+LyX has long supported internationalization of layout information, but,
+ until version 2.0, this applied only to the user interface and not to, say,
+ PDF output.
+ Thus, French authors were forced to resort to ugly hacks if they wanted
+ `
+\lang french
+Théorème
+\lang english
+ 1' instead of `Theorem 1'.
+ Thanks to Georg Baum, that is no longer the case.
+\end_layout
+
+\begin_layout Standard
+If a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Table
+Style
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+ defines text that is to appear in the typeset document, it may use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+LangPreamble
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+BabelPreamble
\end_layout
\end_inset
- can be any valid identifier not used by a pre-existing inset.
- Note that the definition of a flex inset must
-\emph on
- als
-\emph default
-o include a
-\begin_inset Flex CharStyle:Code
+ to support non-English and even multi-language documents correctly.
+ The following excerpt (from the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+theorems-ams.inc
\end_layout
\end_inset
- entry.
+ file) shows how this works:
\end_layout
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-InsetLayout
+\begin_layout LyX-Code
+Preamble
\end_layout
-\end_inset
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
+\end_layout
- definition can contain the following entries:
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
-\begin_layout Plain Layout
-BgColor
+\begin_layout LyX-Code
+LangPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
- The color for the inset's background.
- The valid colors are defined in
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
-\begin_layout Plain Layout
-src/ColorCode.h
+\begin_layout LyX-Code
+BabelPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
-.
+\begin_layout LyX-Code
+EndBabelPreamble
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_deeper
+\begin_layout Standard
+In principle, any legal LaTeX may appear in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+LangPreamble
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+BabelPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ tags, but in practice they will typically look as they do here.
+ The key to correct translation of the typeset text is the definition of
+ the LaTeX command
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+claimname
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ and its use in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\backslash
+newtheorem
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
+.
+
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+LangPreamble
\end_layout
\end_inset
- can be
-\begin_inset Flex CharStyle:Code
+ tag provides for internationalization based upon the overall language of
+ the document.
+ The contents of the tag will be included in the preamble, just as with
+ the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+Preamble
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Minimalistic
-\end_layout
+ tag.
+ What makes it special is the use of the
+\begin_inset Quotes eld
+\end_inset
+function
+\begin_inset Quotes erd
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+_()
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
-\begin_inset Flex CharStyle:Code
+, which will be replaced, when LyX produces LaTeX output, with the translation
+ of its argument into the document language.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+BabelPreamble
\end_layout
\end_inset
-, ERT insets generally
-\begin_inset Flex CharStyle:Code
+ tag is more complex, since it is meant to provide support for multi-language
+ documents and so offers an interface to the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+babel
\end_layout
\end_inset
-, and character styles
-\begin_inset Flex CharStyle:Code
+ package.
+ Its contents will be added to the preamble once for each language that
+ appears in the document.
+ In this case, the argument to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+_()
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ will be replaced with its translation into the language in question; the
+ expression
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+$$lang
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
+ is replaced by the language name (as used by the babel package).
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+A German document that also included a French section would thus have the
+ following in the preamble:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captionsfrench{
+\backslash
+renewcommand{
+\backslash
+claimname}{Affirmation}}
+\backslash
+addto
+\backslash
+captionsngerman{
+\backslash
+renewcommand{
+\backslash
+claimname}{Behauptung}}
+\backslash
+providecommand{
+\backslash
+claimname}{Behauptung}
+\end_layout
+
+\begin_layout Standard
+LaTeX and
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-Font
+babel
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
+ will then conspire to produce the correct text in the output.
+\end_layout
+
+\begin_layout Standard
+One important point to note here is that the translations are provided by
+ LyX itself, through the same mechanism it uses for internationalization
+ of the user interface.
+ This means, in effect, that
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
\end_inset
-.
- Note that defining this font automatically defines the
-\begin_inset Flex CharStyle:Code
+ are really only of use in layout files that are provided with LyX, since
+ text entered in user-created layout files will not be seen by LyX's internation
+alization routines.
+ That said, however, any layout created with the intention that it will
+ be included with LyX should use these tags where appropriate.
+\end_layout
+
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Floats"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Since version 1.3.0 of LyX, it is has been both possible and necessary to
+ define the floats (
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-LabelFont
+figure
\end_layout
\end_inset
- to the same value, so define this first and define
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-LabelFont
+table
\end_layout
\end_inset
- later if you want them to be different.
+, \SpecialChar \ldots{}
+) in the text class itself.
+ Standard floats are included in the file
+\begin_inset Flex Code
+status collapsed
+
+\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 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+Extension
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
\end_inset
-latex
+=
\begin_inset Quotes erd
\end_inset
- language, leading to Left-to-Right (latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
-g.
-\begin_inset space \space{}
+\begin_inset Quotes erd
\end_inset
-in TeX code or URL.
- A kludge.
+] 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+GuiName
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-1
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Indicates whether the PlainLayout should be used or, instead, the user
- can change the paragraph style used in the inset.
+] The string that will be used in the menus and also for the caption.
+ This is translated to the current language if babel is used.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+HTML*
\end_layout
\end_inset
- As with paragraph styles (see page
+ These are used for XHTML output.
+ See
\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
\end_inset
-).
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InToc
+IsPredefined
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
-status collapsed
+\emph on
-\begin_layout Plain Layout
+\begin_inset Flex Code
+status open
-\emph on
+\begin_layout Plain Layout
0
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\emph default
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
- One would not, for example, want the content of a footnote in a section
- header to be included in the TOC displayed in the outline, but one would
- normally want the content of a character style displayed.
- Default is false: not to include.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] Indicates whether the float is already defined in the document class or
+ if we instead need to load
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+float.sty
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
+ and use what it provides to define it on-the-fly.
+ The default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
\end_inset
-).
+, which means: use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+.
+ It should be set to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+1
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
+ if the float is already defined by the LaTeX document class.
+\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+ListCommand
+\end_layout
\end_inset
-.
- Note that this definition can never appear before
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+string
\end_layout
\end_inset
-, lest it be ineffective.
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' should be omitted.
+ This
+\emph on
+must
+\emph default
+ be given if
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+UsesFloatPkg
\end_layout
\end_inset
- What will be displayed on the button or elsewhere as the inset label.
- Some inset types (TeX code and Branch) modify this label on the fly.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ is false, since there is no standard way to generate this command.
+ It is ignored if
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+UsesFloatPkg
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
+ is true, since in that case there is a standard way to define the command.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+ListName
\end_layout
\end_inset
- The optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+string
\end_layout
\end_inset
- stuff, including possible bracket pairs like
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-[]
-\end_layout
+\begin_inset Quotes erd
\end_inset
-.
- This parameter cannot be changed from within LyX.
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within LyX; it is passed to LaTeX for use
+ as the title there; and it is used as the title in XHTML output.
+ It will be translated to the document language.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+NumberWithin
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
\end_inset
-).
-\end_layout
+=
+\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 Code
+status collapsed
+
+\begin_layout Plain Layout
+chapter
+\end_layout
+
+\end_inset
+
+, the floats will be numbered within chapters.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Placement
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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.
+ The string should be as in standard LaTeX:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+t
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+b
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+p
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+h
+\end_layout
+
+\end_inset
+
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
+status collapsed
+
+\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 Code
+status collapsed
+
+\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
+
+here
+\begin_inset Quotes erd
+\end_inset
+
+ and nowhere else.
+ Note however that the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+H
+\end_layout
+
+\end_inset
+
+ specifier is special and, because of implementation details, cannot be
+ used in non-built in float types.
+ If you do not understand what this means, just use
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tbp
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RefPrefix
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The prefix to use when creating labels referring to floats of this type.
+ This allows the use of formatted references.
+ Note that you can remove any
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RefPrefix
+\end_layout
+
+\end_inset
+
+ set by a copied style by using the special value
+\begin_inset Quotes eld
+\end_inset
+
+OFF
+\begin_inset Quotes erd
+\end_inset
+
+, which must be all caps.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Style
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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 Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newfloat
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Type
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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 Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newfloat
+\end_layout
+
+\end_inset
+
+, commands such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{program}
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{algorithm*}
+\end_layout
+
+\end_inset
+
+ will be available.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UsesFloatPkg
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status open
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Tells us whether this float is defined using the facilities provided by
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float.sty
+\end_layout
+
+\end_inset
+
+, either by the class file or a package, or on-the-fly by LyX itself.
+\end_layout
+
+\begin_layout Standard
+Note that defining a float with type
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+type
+\end_layout
+
+\end_inset
+
+ automatically defines the corresponding counter with name
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+type
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Flex-insets-and"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+LyX has supported character styles since version 1.4.0; as of version 1.6.0,
+ these are called Flex insets.
+
+\end_layout
+
+\begin_layout Standard
+Flex insets come in three different kinds:
+\end_layout
+
+\begin_layout Itemize
+character style (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CharStyle
+\end_layout
+
+\end_inset
+
+): These define semantic markup corresponding to such LaTeX commands as
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+noun
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+code
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+user custom (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Custom
+\end_layout
+
+\end_inset
+
+): These can be used to define custom collapsible insets, similar to TeX
+ code, footnote, and the like.
+ An obvious example is an endnote inset, which is defined in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+endnote
+\end_layout
+
+\end_inset
+
+ module.
+\end_layout
+
+\begin_layout Itemize
+XML elements (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Element
+\end_layout
+
+\end_inset
+
+): For use with DocBook classes.
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ tag, which shall be explained in a moment.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ tag also serves another function: It can be used to customize the general
+ layout of many different types of insets.
+ Currently,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
+ boxes, tables, algorithms, URLs, and optional arguments, as well as to
+ define Flex insets.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ definition must begin with a line of the form:
+\end_layout
+
+\begin_layout LyX-Code
+InsetLayout <Type>
+\end_layout
+
+\begin_layout Standard
+Here
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<Type>
+\end_layout
+
+\end_inset
+
+ indicates the inset whose layout is being defined, and here there are two
+ cases.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a pre-existing inset is being modified.
+ In this case, can be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<Type>
+\end_layout
+
+\end_inset
+
+ any one of the following:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Algorithm
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Branch
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Box
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Box:shaded
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ERT
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Figure
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Foot
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Index
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Info
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Info:menu
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Info:shortcut
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Info:shortcuts
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Listings
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Marginal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Note:Comment
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Note:Note
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Note:Greyedout
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+OptArg
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Table
+\end_layout
+
+\end_inset
+
+, or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+URL
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a Flex inset is being defined.
+ In this case,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<Type>
+\end_layout
+
+\end_inset
+
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Flex:<name>
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+name
+\end_layout
+
+\end_inset
+
+ may be be any valid identifier not used by a pre-existing Flex inset.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ Note that the definition of a flex inset
+\emph on
+must
+\emph default
+also include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+ entry, declaring which type of inset it defines.
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
+\end_inset
+
+ definition can contain the following entries:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+BgColor
+\end_layout
+
+\end_inset
+
+ The color for the inset's background.
+ The valid colors are defined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src/ColorCode.h
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ContentAsLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether to use the content of the inset as the label, when the inset is
+ closed.
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CopyStyle
+\end_layout
+
+\end_inset
+
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "des:CopyStyle"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CustomPars
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Decoration
+\end_layout
+
+\end_inset
+
+ can be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Classic
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Minimalistic
+\end_layout
+
+\end_inset
+
+, or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Conglomerate
+\end_layout
+
+\end_inset
+
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Classic
+\end_layout
+
+\end_inset
+
+, ERT insets generally
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Minimalistic
+\end_layout
+
+\end_inset
+
+, and character styles
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Conglomerate
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Display
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Only useful if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
+
+\end_inset
+
+ is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Environment
+\end_layout
+
+\end_inset
+
+.
+ Indicates whether the environment will stand on its own in LaTeX output
+ or will appear inline with the surrounding text.
+ If set to false, it is supposed that the LaTeX environment ignores white
+ space (including one newline character) after the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
+\end_layout
+
+\end_inset
+
+ tags.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+ Required at the end of the InsetLayout declarations.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ to the same value, so define this first and define
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ later if you want them to be different.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForceLTR
+\end_layout
+
+\end_inset
+
+ Force the
+\begin_inset Quotes eld
+\end_inset
+
+latex
+\begin_inset Quotes erd
+\end_inset
+
+ language, leading to Left-to-Right (latin) output, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+in TeX code or URL.
+ A kludge.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForcePlain
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Indicates whether the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PlainLayout
+\end_layout
+
+\end_inset
+
+ should be used or, instead, the user can change the paragraph style used
+ in the inset.
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+FreeSpacing
+\end_layout
+
+\end_inset
+
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+
+).
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTML*
+\end_layout
+
+\end_inset
+
+ These tags control XHTML output.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\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
+
+).
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that this definition can never appear before
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+TeX code
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Branch
+\end_layout
+
+\end_inset
+
+) modify this label on the fly.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexName
+\end_layout
+
+\end_inset
+
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexParam
+\end_layout
+
+\end_inset
+
+ The optional parameter for the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexName
+\end_layout
+
+\end_inset
+
+ stuff, including possible bracket pairs like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[]
+\end_layout
+
+\end_inset
+
+.
+ This parameter cannot be changed from within LyX.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
+
+\end_inset
+
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:LatexType"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyxType
+\end_layout
+
+\end_inset
+
+ Can be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+custom
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+element
+\end_layout
+
+\end_inset
+
+, or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+end
+\end_layout
+
+\end_inset
+
+ (indicating a dummy definition ending definitions of charstyles, etc).
+ This entry is required in and is only meaningful for Flex insets.
+ Among other things, it determines on which menu this inset will appear.
+ Setting
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
+\end_layout
+
+\end_inset
+
+ will set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ to false.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ can be set to true for charstyle insets, if you wish, by setting it
+\emph on
+after
+\emph default
+ you set the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXType
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether multiple paragraphs are permitted in this inset.
+ This will also set
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CustomPars
+\end_layout
+
+\end_inset
+
+ to the same value and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ForcePlain
+\end_layout
+
+\end_inset
+
+ to the opposite value.
+ These can be reset to other values, if they are used
+\emph on
+after
+\emph default
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+NeedProtect
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether fragile commands in this inset should be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+protect
+\end_layout
+
+\end_inset
+
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.) Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ParbreakIsNewline
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:ParbreakIsNewline"
+
+\end_inset
+
+).
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:PassThru"
+
+\end_inset
+
+).
+ Default is false.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Preamble
+\end_layout
+
+\end_inset
+
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Preamble"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+RefPrefix
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The prefix to use when creating labels referring to insets of this type.
+ This allows the use of formatted references.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Requires
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Requires"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ResetsFont
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether this inset should use the font of its surrounding environment
+ or uses its own.
+ Default is true: uses its own.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Spellcheck
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Spellcheck the contents of this inset.
+ Default is true.
+\end_layout
+
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Counters"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Since version 1.3.0 of LyX, it is both possible and necessary to define the
+ counters (
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+chapter
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+figure
+\end_layout
+
+\end_inset
+
+, \SpecialChar \ldots{}
+) in the text class itself.
+ The standard counters are defined in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdcounters.inc
+\end_layout
+
+\end_inset
+
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
+
+\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.
+ The counter declaration must begin with:
+\end_layout
+
+\begin_layout LyX-Code
+Counter CounterName
+\end_layout
+
+\begin_layout Standard
+where of course `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CounterName
+\end_layout
+
+\end_inset
+
+' is replaced by the name of the counter.
+ And it must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+End
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The following parameters can also be used:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] When defined, this string defines how the counter is displayed.
+ Setting this value sets
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thecounter
+\end_layout
+
+\end_inset
+
+ will be replaced by the expansion of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+ (or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+) of the counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+counter
+\end_layout
+
+\end_inset
+
+.
+
+\end_layout
+
+\begin_layout Itemize
+counter values can be expressed using LaTeX-like macros
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
+\end_layout
+
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+numbertype
+\end_layout
+
+\end_inset
+
+ can be:
+\begin_inset Foot
+status collapsed
+
+\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 described below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+arabic
+\end_layout
+
+\end_inset
+
+: 1, 2, 3,\SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alph
+\end_layout
+
+\end_inset
+
+ for lower-case letters: a, b, c, \SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alph
+\end_layout
+
+\end_inset
+
+ for upper-case letters: A, B, C, \SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+roman
+\end_layout
+
+\end_inset
+
+ for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Roman
+\end_layout
+
+\end_inset
+
+ for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+hebrew
+\end_layout
+
+\end_inset
+
+ for hebrew numerals.
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+master
+\end_layout
+
+\end_inset
+
+ (defined via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Within
+\end_layout
+
+\end_inset
+
+), the string
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
+\end_layout
+
+\end_inset
+
+ is used; otherwise the string
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{counter}
+\end_layout
+
+\end_inset
+
+ is used.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] Same as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
+\end_layout
+
+\end_inset
+
+, but for use in the Appendix.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PrettyFormat
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] A format for use with formatted references to this counter.
+ For example, one might want to have references to section numbers appear
+ as
+\begin_inset Quotes eld
+\end_inset
+
+Section 2.4
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The string should contain
+\begin_inset Quotes eld
+\end_inset
+
+##
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This will be replaced by the counter number itself.
+ So, for sections, it would be: Section ##.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Within
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+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 every time the other one is increased.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+subsection
+\end_layout
+
+\end_inset
+
+ is numbered inside
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+section
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Font-description"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+A font description looks like this:
+\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
+The following commands are available:
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Color
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+none
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+black
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+white
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+red
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+green
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+blue
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cyan
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+magenta
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+yellow
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Roman
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Sans
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Typewriter
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Misc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Valid arguments are:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+emph
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+noun
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+underbar
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_noun
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_bar
+\end_layout
+
+\end_inset
+
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+emph
+\end_layout
+
+\end_inset
+
+ turns on emphasis, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+ turns it off.
+
+\begin_inset Newline newline
+\end_inset
+
+If the latter seems puzzling, remember that the font settings for the present
+ context are generally inherited from the surrounding context.
+ So
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+no_emph
+\end_layout
+
+\end_inset
+
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Series
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Medium
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Bold
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Shape
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Up
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Italic
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+SmallCaps
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Slanted
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Size
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tiny
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+small
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+normal
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+large
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+larger
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+largest
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+huge
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+giant
+\end_layout
+
+\end_inset
+
+]
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Citation-format-description"
+
+\end_inset
+
+Citation format description
+\end_layout
+
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ blocks are used to describe how bibliographic information should be displayed,
+ both within LyX itself (in the citation dialog and in tooltips, for example)
+ and in XHTML output.
+ Such a block might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
+
+\begin_layout LyX-Code
+ article ...
+\end_layout
+
+\begin_layout LyX-Code
+ book ...
+\end_layout
+
+\begin_layout LyX-Code
+End
+\end_layout
+
+\begin_layout Standard
+The individual lines define how the bibliographic information associated
+ with an article or book, respectively, is to be displayed, and such a definitio
+n can be given for any `entry type' that might be present in a BibTeX file.
+ LyX defines a default format in the source code that will be used if no
+ specific definition has been given.
+ LyX predefines several formats in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, which is included in most of LyX's document classes.
+\end_layout
+
+\begin_layout Standard
+The definitions use a simple language that allows BibTeX keys to be replaced
+ with their values.
+ Keys should be enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs, e.g.:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%author%
+\end_layout
+
+\end_inset
+
+.
+ So a simple definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+misc %author%,
+\begin_inset Quotes eld
+\end_inset
+
+%title
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+This would print the author, followed by a comma, followed by the title,
+ in quotes, followed by a period.
+\end_layout
+
+\begin_layout Standard
+Of course, sometimes you may want to print a key only if it exists.
+ This can be done by using a conditional construction, such as:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%volume%[[vol.
+\begin_inset space ~
+\end_inset
+
+%volume%]]}
+\end_layout
+
+\end_inset
+
+.
+ This says: If the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+volume
+\end_layout
+
+\end_inset
+
+ key exists, then print
+\begin_inset Quotes eld
+\end_inset
+
+vol.
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ followed by the volume key.
+ It is also possible to have an else clause in the conditional, such as:
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{%author%[[%author%]][[%editor%, ed.]]}
+\end_layout
+
+\end_inset
+
+.
+ Here, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
+\begin_inset Quotes eld
+\end_inset
+
+,
+\begin_inset space ~
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+ Note that the key is again enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs; the entire conditional is enclosed in braces; and the if and else
+ clauses are enclosed in double brackets,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[[
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+]]
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ There must be no space between any of these.
+\end_layout
+
+\begin_layout Standard
+There is one other piece of syntax available in definitions, which looks
+ like this:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{!<i>!}
+\end_layout
+
+\end_inset
+
+.
+ This defines a piece of formatting information that is to be used when
+ creating
+\begin_inset Quotes eld
+\end_inset
+
+rich text
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Obviously, we do not want to output HTML tags when writing plain text,
+ so they should be wrapped in
+\begin_inset Quotes eld
+\end_inset
+
+{!
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+!}
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Two special sorts of definitions are also possible in a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ block.
+ An example of the first would be:
+\end_layout
+
+\begin_layout LyX-Code
+!quotetitle
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+This is an abbreviation, or macro, and it can be used by treating it as
+ if it were a key:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+
+.
+ LyX will treat
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+
+ exactly as it would treat its definition.
+ So, let us issue the obvious
+\emph on
+warning
+\emph default
+.
+ Do not do this:
+\end_layout
+
+\begin_layout LyX-Code
+!funfun %funfun%
+\end_layout
+
+\begin_layout Standard
+or anything like it.
+ LyX shouldn't go into an infinite loop, but it may go into a long one before
+ it gives up.
+\end_layout
+
+\begin_layout Standard
+The second sort of special definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+_pptext pp.
+\end_layout
+
+\begin_layout Standard
+This defines a translatable piece of text, which allows relevant parts of
+ the bibliography to be translated.
+ It can be included in a definition by treating it as a key:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%_pptext%
+\end_layout
+
+\end_inset
+
+.
+ Several of these are predefined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+.
+ Note that these are not macros, in the sense just defined.
+ They will not be expanded.
+\end_layout
+
+\begin_layout Standard
+So here then is an example that use all these features:
+\end_layout
+
+\begin_layout LyX-Code
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+\end_layout
+
+\begin_layout Standard
+This defines a macro that prints the author, followed by a comma, if the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is defined, or else prints the name of the editor, followed by the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+_edtext
+\end_layout
+
+\end_inset
+
+ or its translation (it is by default
+\begin_inset Quotes eld
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+), if the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+editor
+\end_layout
+
+\end_inset
+
+ key is defined.
+ Note that this is in fact defined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, so you can use it in your own definitions, or re-definitions, if you load
+ that file first.
+\end_layout
+
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-XHTML"
+
+\end_inset
+
+Tags for XHTML output
+\end_layout
+
+\begin_layout Standard
+As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
+ by layout information.
+ In general, LyX provides sensible defaults and, as mentioned earlier, it
+ will even construct default CSS style rules from the other layout tags.
+ For example, LyX will attempt to use the information provided in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ declaration for the Chapter style to write CSS that will appropriately
+ format chapter headings.
+\end_layout
+
+\begin_layout Standard
+In many cases, then, you may not have to do anything at all to get acceptable
+ XHTML output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so LyX provides a number of layout tags
+ that can be used to customize the XHTML and CSS that are generated.
+\end_layout
+
+\begin_layout Standard
+Note that there are two tags,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\end_layout
+
+\end_inset
+
+ that may appear outside style and inset declarations.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:General-text-class"
+
+\end_inset
+
+ for details on these.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Paragraph-Style-XHTML"
+
+\end_inset
+
+Paragraph styles
+\end_layout
+
+\begin_layout Standard
+The sort of XHTML LyX outputs for a paragraph depends upon whether we are
+ dealing with a normal paragraph, a command, or an environment, where this
+ is itself determined by the contents of the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LaTeXType
+\end_layout
+
+\end_inset
+
+ tag.
+
+\end_layout
+
+\begin_layout Standard
+For a command or normal paragraph, the output XHTML has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the paragraph.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The label tags are of course omitted if the paragraph does not have a label.
+\end_layout
+
+\begin_layout Standard
+For an environment that is not some sort of list, the XHTML takes this form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Environment Label</labeltag>First paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag>Second paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note that the label is output only for the first paragraph, as it should
+ be for a theorem, for example.
+
+\end_layout
+
+\begin_layout Standard
+For a list, we have one of these forms:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note the different orders of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+.
+ Which order we get depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ is false (the default), you get the first of these, with the label within
+ the item; if true, you get the second, with the label outside the item.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each paragraph type can be controlle
+d by means of the layout tags we are about to describe.
+ As mentioned earlier, however, LyX uses sensible defaults for many of these,
+ so you often may not need to do very much to get good XHTML output.
+ Think of the available tags as there so you can tweak things to your liking.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`mydiv'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyxType
+class=`layoutname'
\end_layout
\end_inset
- Can be
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+layoutname
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ is the LyX name of the layout, made lowercase, for example: chapter.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-custom
+HTMLStyle
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-element
+HTMLForceCSS
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-end
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
- (indicating a dummy definition ending definitions of charstyles, etc).
- This entry is required in and is only meaningful for Flex insets.
- Among other things, it determines on which menu this inset will appear.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] Whether to output the default CSS information LyX generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+HTMLStyle
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+.
+ Setting this to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+0
\end_layout
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set CustomPars to the same value and ForcePlain to the opposite
- value.
- These can be reset to other values, if they are used
-\emph on
-after
-\emph default
- MultiPar.
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+HTMLItem
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] The tag to be used for individual paragraphs of environments, replacing
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+itemtag
\end_layout
\end_inset
-] Whether fragile commands in this layout should be
-\begin_inset Flex CharStyle:Code
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+div
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether the command should itself be protected.)
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+HTMLItemAttr
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] Attributes for the item tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+class=`layoutname_item'
\end_layout
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:PathThru"
+\begin_inset Quotes erd
\end_inset
-).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+HTMLStyle
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Preamble"
-
-\end_inset
-
-).
+ for that purpose.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+HTMLLabel
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Requires"
-
-\end_inset
+] The tag to be used for paragraph and item labels, replacing
+\begin_inset Flex Code
+status collapsed
-).
+\begin_layout Plain Layout
+labeltag
\end_layout
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Counters"
-
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Since version 1.3.0 of LyX, it is both possible and necessary to define the
- counters (
-\begin_inset Flex CharStyle:MenuItem
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+span
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+, unless
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+LabelType
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- The standard counters are defined in the file
-\begin_inset Flex CharStyle:Code
+ is either
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
+Top_Environment
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
-
-\begin_layout LyX-Code
-Input stdcounters.inc
-\end_layout
-
-\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.
- The counter declaration must begin with:
-\end_layout
+ or
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Counter name
+\begin_layout Plain Layout
+Centered_Top_Environment
\end_layout
-\begin_layout Standard
-where of course `name' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
+, in which case it defaults to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+div
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
- The following parameters can also be used:
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString [string=""]
+HTMLLabelAttr
\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
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+string
\end_layout
\end_inset
- 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 Plain Layout
-
-\backslash
-thecounter
-\end_layout
-
+] Attributes for the label tag.
+ Defaults to
+\begin_inset Quotes eld
\end_inset
- will be replaced by the expansion of the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelString
-\end_layout
-
-\end_inset
- (or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+class=`layoutname_label'
\end_layout
\end_inset
-) of the counter
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-counter
-\end_layout
+\begin_inset Quotes erd
\end_inset
.
-
-\end_layout
-
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
-\begin_inset Flex CharStyle:Code
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+HTMLStyle
\end_layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+ for that purpose.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+HTMLLabelFirst
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+ [
+\begin_inset Flex Code
status collapsed
-
-\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 described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+] Meaningful only for list-like environments, this tag controls whether
+ the label tag is output before or inside the item tag.
+ This is used, for example, in the description environment, where we want
+ `
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+<dt>\SpecialChar \ldots{}
+</dt><dd>\SpecialChar \ldots{}
+</dd>
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+.
+ Default is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+0
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+: The label tag is output inside the item tag.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+HTMLPreamble
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+ Information to be output in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+<head>
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Roman
+<script>
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+ block defining an
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+onclick
\end_layout
\end_inset
- for hebrew numerals.
+ handler.
\end_layout
-\end_deeper
-\begin_layout Standard
-If LabelString is not defined, a default value is constructed as follows:
- if the counter has a master counter
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+HTMLStyle
\end_layout
\end_inset
- (defined via
-\begin_inset Flex CharStyle:Code
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+<style>
\end_layout
\end_inset
-), the string
-\begin_inset Flex CharStyle:Code
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
+HTMLTag
\end_layout
\end_inset
- is used; otherwise the string
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
+string
\end_layout
\end_inset
- is used.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix [string=""]
+tag
\end_layout
\end_inset
- Same as
-\begin_inset Flex CharStyle:Code
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+div
\end_layout
\end_inset
-, but for use in the Appendix.
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+HTMLTitle
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+] Marks this style as the one to be used to generate the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+<title>
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] If this is set to the name of another counter, the present counter will
- be reset every time the other one is increased.
- For example,
-\begin_inset Flex CharStyle:Code
+ tag for the XHTML file.
+ By default, it is false.
+ The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+stdtitle.inc
\end_layout
\end_inset
- is numbered inside
-\begin_inset Flex CharStyle:Code
+ file sets it to true for the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
+title
\end_layout
\end_inset
-.
+ environment.
+
\end_layout
\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Font-description"
+InsetLayout XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output of insets can also be controlled by information in layout
+ files.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+At present, this is true only for
+\begin_inset Quotes eld
+\end_inset
+
+text
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets you can type into) and is not true for
+\begin_inset Quotes eld
+\end_inset
+command
+\begin_inset Quotes erd
\end_inset
+ insets (insets that are associated with dialog boxes).
+\end_layout
+
+\end_inset
+ Here, too, LyX tries to provide sensible defaults, and it constructs default
+ CSS style rules.
+ But everything can be customized.
\end_layout
\begin_layout Standard
-A font description looks like this:
+The XHTML LyX outputs for an inset has the following form:
\end_layout
\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
\end_layout
\begin_layout LyX-Code
- ...
+<labeltag>Label</labeltag>
\end_layout
\begin_layout LyX-Code
-EndFont
+<innertag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Contents of the inset.</innertag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
\end_layout
\begin_layout Standard
-The following commands are available:
+If the inset permits multiple paragraphs---that is, if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true---then the contents of the inset will itself be output as paragraphs
+ formatted according to the styles used for those paragraphs (standard,
+ quote, and the like).
+ The label tag is of course omitted if the paragraph does not have a label
+ and, at present, is always
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+ The inner tag is optional and, by default, does not appear.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+HTMLAttr
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+string
+\end_layout
-\emph on
-none
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myinset' onclick=`\SpecialChar \ldots{}
+'
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, LyX will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+class=`insetname'
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+insetname
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ is the LyX name of the inset, made lowercase and with non-alphanumeric
+ characters converted to underscores, for example: footnote.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+HTMLForceCSS
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+
+\emph on
+0
+\emph default
+,1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] Whether to output the default CSS information LyX generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-blue
+HTMLStyle
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ Setting this to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is 0.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+HTMLInnerAttr
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
+string
\end_layout
\end_inset
-]
+] Attributes for the inner tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname_inner'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+HTMLInnerTag
\end_layout
\end_inset
[
-\emph on
-
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+string
+\end_layout
-\emph on
-Roman
+\end_inset
+
+] The inner tag, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+innertag
\end_layout
\end_inset
+ in the examples above.
+ By default, there is none.
+\end_layout
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sans
+HTMLIsBlock
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+0,
+\emph on
+1
\end_layout
\end_inset
-]
+] Whether this inset represents a standalone block of text (such as a footnote)
+ or instead represents material that is included in the surrounding text
+ (such as a branch).
+ Defaults to 1.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Misc
+HTMLLabel
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-] Valid argument are:
-\begin_inset Flex CharStyle:Code
+] A label for this inset, possibly including a reference to a counter.
+ For example, for footnote, it might be:
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+
+\backslash
+arabic{footnote}
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ This is optional, and there is no default.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-noun
+HTMLPreamble
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ Information to be output in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-underbar
+<head>
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+<script>
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ block defining an
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_noun
+onclick
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_bar
+HTMLStyle
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+HTMLTag
\end_layout
\end_inset
[
-\emph on
-
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Medium
+string
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bold
+tag
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ in the examples above.
+ The default depends upon the setting of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Shape
+MultiPar
\end_layout
\end_inset
- [
-\emph on
-
-\begin_inset Flex CharStyle:Code
+: If
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
+MultiPar
\end_layout
\end_inset
-
-\emph default
-,
-\begin_inset Flex CharStyle:Code
+ is true, the default is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Italic
+div
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+; if it is false, the default is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SmallCaps
+span
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+\end_layout
-\begin_layout Plain Layout
-Slanted
+\begin_layout Subsection
+Float XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output for floats too can be controlled by layout information.
+ The output has the following form:
\end_layout
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
\end_inset
-]
+>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the float.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The caption, if there is one, is a separate inset and will be output as
+ such.
+ Its appearance can be controlled via the InsetLayout for caption insets.
+
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Size
+HTMLAttr
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tiny
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-small
+class=`myfloat' onclick=`\SpecialChar \ldots{}
+'
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-\emph on
-normal
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+.
+ By default, LyX will output
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+class=`float float-floattype'
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-larger
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+floattype
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ is LyX's name for this type of float, as determined by the float declaration
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Floats"
+
+\end_inset
+
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-huge
+HTMLStyle
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ CSS style information to be included when this float is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
+<style>
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Subsection
-Upgrading old layout files
+ block, so only the CSS itself need be included.
\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 since LyX 1.4.0: If LyX reads an old format
- layout file it will call the conversion tool
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXDir/scripts/layout2layout.py
+HTMLTag
\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 Standard
-(You need to replace
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$LyXDir
+string
\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
+] The tag to be used for this float, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myclassnew.layout
+tag
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir/layouts/
+div
\end_layout
\end_inset
-.
+ and will rarely need changing.
+\end_layout
+
+\begin_layout Subsection
+Bibliography formatting
\end_layout
\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.
+The bibliography can be formatted using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
\end_layout
-\begin_layout Section
-Creating Templates
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Creating-Templates"
+\end_inset
+
+ blocks.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Citation-format-description"
\end_inset
+ for the details.
+\end_layout
+
+\begin_layout Subsection
+LyX-generated CSS
+\end_layout
+\begin_layout Standard
+We have several times mentioned that LyX will generate default CSS style
+ rules for both insets and paragraph styles, based upon the other layout
+ information that is provided.
+ In this section, we shall say a word about which layout information LyX
+ uses and how.
\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 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
+At present, LyX auto-generates CSS only for font information, making use
+ of the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-fontscheme
+Family
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-papersize
+Series
\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
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-vi
+Shape
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+, and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-xedit
+Size
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Standard
-Put the edited template files you create in
-\begin_inset Flex CharStyle:Code
+ specified in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir/templates/
+Font
\end_layout
\end_inset
-, copy the ones you use from the global template directory in
-\begin_inset Flex CharStyle:Code
-status collapsed
+ declaration.
+ (See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
-\begin_layout Plain Layout
-LyXDir/templates/
-\end_layout
+\end_inset
+.) The translation is mostly straightforward and obvious.
+ For example,
+\begin_inset Quotes eld
\end_inset
- to the same place, and redefine the template path in the
-\begin_inset Flex CharStyle:MenuItem
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Paths
+Family Sans
\end_layout
\end_inset
- dialog.
-\end_layout
-\begin_layout Standard
-Note that there is a template which has a particular meaning:
-\begin_inset Flex CharStyle:Code
+\begin_inset Quotes erd
+\end_inset
+
+ becomes
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-defaults.lyx
+font-family: sans-serif;
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
- This template is loaded every time you create a new document with
-\begin_inset Flex CharStyle:MenuItem
+ The correspondence of LyX sizes and CSS sizes is a little less obvious
+ but nonetheless intuitive.
+ See the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
-New
+getSizeCSS()
\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
+ function in
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-Save as Document Defaults
+
+src/FontInfo.cpp
\end_layout
\end_inset
- button.
+ for the details.
+
\end_layout
\begin_layout Chapter
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The Xfig application itself works on an original file with the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
extension.
Within Xfig, you create and change your figure, and when you are done,
you save the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-file.
When you want to include the figure in your document, you invoke
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The external templates are defined in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
file.
You can place your own version in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
As you can see, the template is enclosed in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar \ldots{}
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
It contains a header specifying some general settings and, for each supported
primary document file format, a section
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar \ldots{}
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
tgif has
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
), use something like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
The file format of the original file.
- This must be the name of a format that is known to LyX (see section
+ This must be the name of a format that is known to LyX (see section
+\begin_inset space ~
+\end_inset
+
+
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
It may occur zero or more times.
This command enables the corresponding tabs in the external dialog.
Each
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
command must have either a corresponding
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
command in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- section for all formats.
+ section for all templates.
Use a dummy text when no representation is available.
Then you can at least see a reference to the external material in the exported
document.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
This command defines an additional macro
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
for substitution in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
itself may contain substitution macros.
The advantage over using
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
directly in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is that the substituted value of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar \ldots{}
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
The name of a required LaTeX package.
The package is included via
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\bar under
P
\bar default
-references:Conversion
+references\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File Format
\end_layout
\end_inset
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The external template configuration file may contain additional preamble
definitions enclosed by
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\SpecialChar \ldots{}
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
They can be used by the templates in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
This macro will expand to the contents of the file with the name
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
The path part of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
the absolute filename with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The macros above are substituted in all commands unless otherwise noted.
The command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
supports additionally the following substitutions if they are enabled by
the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The value string of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
command supports additionally the following substitutions if they are enabled
by the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Else use
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
in the XFig template above: We can't use the absolute name because the
copier for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-system call rather than the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
projects / lyx.git / blobdiff