-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 376
+#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 1
+\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
\paperpagestyle headings
\tracking_changes false
\output_changes false
-\html_use_mathml true
+\html_math_output 0
+\html_css_as_file 0
\html_be_strict true
\end_header
\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
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
\end_inset
and the latter
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Section
What's in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
\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
\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
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
\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 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
\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 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
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
\begin_layout Standard
These directories are duplicated between
-\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
.
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
\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
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
\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
deserves special attention, as noted above.
The internationalized help docs are in subdirectories
-\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
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
\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
contains 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
\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_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
contains files with the extension
-\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
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
\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
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
\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
\end_inset
, which means that every file in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
\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
\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
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
\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
\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
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
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
\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
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
subdirectory, however, since it contains a file written by the configuration
script (also accessible through
-\begin_inset Flex CharStyle:MenuItem
+\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
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
, 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
\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
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
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, since
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain 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
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
format, it is converted to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain 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
\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
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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
—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
\end_inset
format—or one of the other pdf formats—and enter
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
\end_inset
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, so HTML generated from
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
will end up in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\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
\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
\begin_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
Needs the LaTeX
-\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 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
\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
\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
.
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
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_layout Labeling
\labelwidthstring 00.00.0000
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
formats.
For example, the standard LyX configuration provides three ways to convert
LaTeX to PDF: Directly, using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
; via (DVI and) PostScript, using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
; or via DVI, using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
For example, in the standard configuration, the formats named
-\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
are defined, all of which share the extension
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
(For further reading on locale settings, see also the documentation for
locale that comes with your operating system.
For Linux, the manual page for
-\begin_inset Flex CharStyle:Code
+\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
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
-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
\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
files.
Then rename it to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
(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
\begin_layout Itemize
Edit
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Emacs
\family default
contains a `mode' for editing
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
\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
\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
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
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
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
\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
\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
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
\end_inset
Rather, that information, even for the standard classes like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
XHTML constructs.
Almost everything LyX knows about
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, for example, is contained in the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, which is included in
-\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
, and many of the other layout files for document classes.
This file is where sections and the like are defined:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
commands and tags.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file basically just includes several of these
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
be controlled separately.
See
\begin_inset CommandInset ref
-LatexCommand prettyref
+LatexCommand ref
reference "sec:Tags-for-XHTML"
\end_inset
\begin_inset Quotes eld
\end_inset
-Browse Packages
+Package
+\begin_inset space ~
+\end_inset
+
+Manager
\begin_inset Quotes erd
\end_inset
to get a list of available packages.
- To install one, right click on it or use the toolbar button to install
- it.
-
+ To install one of them, right click on it or use the corresponding toolbar
+ button.
\end_layout
\begin_layout Standard
-If your LaTeX distribution doesn't provide such a `package manager', or
- if the file is not available from your distribution, then you can follow
- these steps to install it manually.
+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
\end_layout
\begin_layout Enumerate
-You can install the 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.
+If the package contains a file with the ending
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.ins
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ (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
+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_layout Enumerate
+Now you need to decide if the package should be available for all users
+ or only for you.
+\end_layout
+
+\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
- upon the details of your system.
- To find out where they are, look in the file
-\begin_inset Flex CharStyle:Code
+ on your system.
+ To find this out, look in the file
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-This usually lives in the directory
-\begin_inset Flex CharStyle:Code
+This is usually in the directory
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-, though you can run
-\begin_inset Flex CharStyle:Code
+, though you can execute the command
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
The location of the `local' TeX tree is defined by the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
variable; this is usually somewhere like
-\begin_inset Flex URL
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-/usr/local/share/texmf/
+/usr/local/share/texmf
\end_layout
\end_inset
.
The location of the `user' TeX tree is defined by
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and is commonly
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$HOME/texmf/
+$HOME/texmf
\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.
+ (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
-Make sure
-\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
-TEXMF
+~
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
- includes the
-\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
+~:
+\backslash
+Programs
+\backslash
+MiKTeX
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+.)
+\begin_inset Foot
+status open
+
+\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
-TEXMFHOME
+~:
+\backslash
+Programme
+\backslash
+MiKTeX
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
- variables; e.
-\begin_inset space \thinspace{}
-\end_inset
+, and similarly for other languages.
+\end_layout
-g.
-\begin_inset Newline newline
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ Create there a new folder
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TEXMF = {$TEXMFHOME,!!$TEXMFLOCAL,!!$TEXMFMAIN}
+foiltex
\end_layout
\end_inset
-
+ and copy all files of the package into it.
+
\begin_inset Newline newline
\end_inset
-It probably does.
-\end_layout
-
-\begin_layout Enumerate
-Your local and user trees
-\emph on
-must
-\emph default
- have the same sort of directory structure as your main existing
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-texmf
-\end_layout
+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
- directory, which will be found at
-\begin_inset Flex CharStyle:Code
-status collapsed
+2.8 under Windows XP, this would be the folder:
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-TEXMFMAIN
-\end_layout
-\end_inset
+\family sans
- (commonly,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/usr/share/texmf/
+~:
+\backslash
+Documents and Settings
+\backslash
+<username>
+\backslash
+Application Data
+\backslash
+
\end_layout
\end_inset
-.) For example, latex packages should go under
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-$TEXMFLOCAL/tex/latex/
-\end_layout
+\begin_inset Newline newline
\end_inset
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-$TEXMFHOME/tex/latex/
-\end_layout
+\family default
-\end_inset
+\begin_inset Phantom HPhantom
+status open
-.
- If you do not put them here, they probably will not work.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Enumerate
-Once your tree is properly set up, you can install the package into an appropria
-te location.
- If you are lucky, your package will have been provided as a so-called `TDS'
- (TeX Directory Structure) zip file.
- To install it, you want to unzip it from the top of your tree.
- So, for example, you can copy the file
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family sans
+~:
+\backslash
-\begin_layout Plain Layout
-newpkg.zip
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/home/yourname/texmf/
+MiKTeX
+\backslash
+2.8
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
- and then, from inside that directory, just run:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-unzip newpkg.zip
-\end_layout
+\begin_inset Newline newline
\end_inset
-.
- This will extract the needed files and copy them where they need to be.
+On Vista, it would be:
\begin_inset Newline newline
\end_inset
-If you do not have a TDS file, then you have to do this manually.
- For example, you might install the FoilTeX files into
-\begin_inset Flex URL
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-$TEXMFLOCAL/tex/latex/contrib/foiltex
+~:
+\backslash
+Users
+\backslash
+<username>
+\backslash
+AppData
+\backslash
+Roaming
+\backslash
+2.8
+\backslash
+MiKTeX
+\backslash
+tex
+\backslash
+latex
\end_layout
\end_inset
-.
- Why there? The CTAN download directories are themselves organized much
- like a TeX tree, and it isn't a bad idea to follow its structure when you
- install your own files.
- FoilTeX, as it happens, is found at
-\begin_inset Flex URL
+
+\end_layout
+
+\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
+
+\begin_deeper
+\begin_layout Enumerate
+For TeXLive execute the command
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-http://ctan.org/texarchive/macros/latex/contrib/foiltex/
+texhash
\end_layout
\end_inset
-.
-
+ 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 Enumerate
-Finally, you must update the database TeX uses to find files.
- On MiKTeX, this is done by pressing the button
-\family sans
-Refresh
+For MiKTeX, if you have installed the package for all users, start the program
+
+\begin_inset Quotes eld
+\end_inset
+
+Settings
\begin_inset space ~
\end_inset
-FNDB
-\family default
- that you find in MiKTeX's
+(Admin)
+\begin_inset Quotes erd
+\end_inset
+
+ and press the button marked
\begin_inset Quotes eld
\end_inset
-Settings
+Refresh FNDB
\begin_inset Quotes erd
\end_inset
- program.
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-$TEXMFLOCAL/tex/latex/
-\end_layout
+.
+ Otherwise start the program
+\begin_inset Quotes eld
+\end_inset
+Settings
+\begin_inset Quotes erd
\end_inset
-.
- Under TeXLive and the like, you should run
-\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
-texhash
+Tools
+\family sans
+\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
- from a terminal, with root permissions if necessary.
-
+ and then restart LyX.
\end_layout
\begin_layout Standard
-Your package is now installed and available to LaTeX.
- You can verify this from a terminal by typing `
-\begin_inset Flex CharStyle:Code
+Now the package is installed.
+ In our example, the document class
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-kpsewhich yourfile.ext
-\end_layout
-
+Slides
+\begin_inset space ~
\end_inset
-'.
- To make LyX aware of it, however, you will need to reconfigure (
-\begin_inset Flex CharStyle:MenuItem
+(FoilTe
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Reconfigure
+
+{}
+\end_layout
+
+\end_inset
+
+x)
\end_layout
\end_inset
-) and then restart LyX.
- If the new package was a document class, such as FoilTeX again, you will
- now see it available under
-\begin_inset Flex CharStyle:MenuItem
+ will now be available under
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-, in this case as
-\begin_inset Flex CharStyle:MenuItem
+.
+
+\end_layout
+
+\begin_layout Standard
+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
-slides (FoilTeX)
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Document Class
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Standard
-What if there isn't a layout file is available for your new document class?
- Then, unfortunately, LyX will know nothing about it until you create a
- layout file yourself (or get someone else to do it).
+, then you need to create a `layout' file for it.
That is the topic of the next section.
\end_layout
\begin_layout Plain Layout
Note that LyX is licensed under the General Public License, so any material
- that is contribued to LyX must be similarly licensed.
+ that is contributed to LyX must be similarly licensed.
\end_layout
\end_inset
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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
modules
\emph default
, which have the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
extension.
Modules are to LaTeX packages much as layouts are to LaTeX classes, and
some modules—such as the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- module—specifcally provide support for one package.
+ module—specifically provide support for one package.
In a sense, layout modules are similar to included
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
These can have any extension, but by convention have the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
files—files like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
—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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
requires editing that file.
Modules, by contrast, are selected in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
After creating a new module and copying it to the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-layout/
+layouts/
\end_layout
\end_inset
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
syntax errors and the like in your module file could cause strange behavior.
\end_layout
-\begin_layout Subsection
-Layout for
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-.sty
+\begin_layout Subsubsection
+Local Layout
\end_layout
+\begin_layout Standard
+Modules are to LyX as packages are to LaTeX.
+ Sometimes, however, you find yourself wanting a specific inset or character
+ style just for one document and writing a module that will also be available
+ to other documents makes little sense.
+ What you need is LyX's
+\begin_inset Quotes eld
\end_inset
- files
+Local Layout
+\begin_inset Quotes erd
+\end_inset
+
+.
\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
+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.
+ pane, LyX will enable the
+\begin_inset Quotes eld
+\end_inset
+
+Validate
+\begin_inset Quotes erd
+\end_inset
+
+ button at the bottom.
+ Clicking this button will cause LyX to determine whether what you have
+ entered is valid layout information for the chosen format.
+ LyX will report the result but, unfortunately, will not tell you what errors
+ there might have been.
+ These will be written to the terminal, however, if LyX is started from
+ a terminal.
+ You will not be permitted to save your local layout until you have entered
+ something valid.
+\end_layout
+
+\begin_layout Standard
+The warnings at the end of the previous section apply here, too.
+ Do not play with local layout while you are actually working, especially
+ if you have not saved your document.
+ That said, using local layout with a test document can be a very convenient
+ way to try out layout ideas, or even to start developing a module.
+\end_layout
+
+\begin_layout Subsection
+Layout for
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+.sty
+\end_layout
+
+\end_inset
+
+ files
+\end_layout
+
+\begin_layout Standard
+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
+.sty
+\end_layout
+
+\end_inset
+
+) files and LaTeX2e class (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.cls
+\end_layout
+
+\end_inset
+
+) .
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.
document class.
For the sake of the example, we'll assume that the style file is called
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and that it is meant to be used with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Then edit
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
, 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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, which itself includes
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
If
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Subsection
Layout for
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
in the file.
If so, then you may proceed largely as in the previous section, though
the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
line will be different.
If your new class is
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and it is based upon
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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
for such parameters.
For that reason, the designer of a template should remove the corresponding
commands like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Put the edited template files you create in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, copy the ones you use from the global template directory in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
to the same place, and redefine the template path in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Note, by the way, that there is a template which has a particular meaning:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
This template is loaded every time you create a new document with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain 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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You need to replace
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Note that all the tags used in layout files are case-insensitive.
This means that
-\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
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, the default is shown like this:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Subsection
-The Document Class Declaration
+The document class declaration
\end_layout
\begin_layout Standard
Lines in a layout file which begin with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
are comments.
There is one exception to this rule.
All
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, in a special mode where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, then they define a text class of name
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
(the name of the layout file) which uses the LaTeX document class
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
that appears above is used as a description of the text class in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Let's assume that you wrote your own text class that uses the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
document class, but where you changed the appearance of the section headings.
If you put it in a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
This declares a text class
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, associated with the LaTeX document class
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
This indicates that your text class uses the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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.
+ 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_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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, run
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
You can force a reload of the current layout by using the LyX function
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Warning
\emph default
:
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Subsection
-The Module Declaration
+The Module declaration
\end_layout
\begin_layout Standard
\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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Modules
\end_layout
\end_inset
LyX will not check for arbitrary packages.
It is also possible to use the form
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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 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 Standard
-The module declaration should then be followed by lines like the following:
+The module declaration should then be followed by lines like the following
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Preferably in English if the module should be published with LyX.
+ This description will appear in the list of messages to be translated and
+ will be thus translated with the next interface update.
+\end_layout
+
+\end_inset
+
+:
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
The description is used in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Document\SpecialChar \menuseparator
-Settings
+Settings\SpecialChar \menuseparator
+Modules
\end_layout
\end_inset
to provide the user with information about what the module does.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
line is used to identify other modules with which this one must be used;
the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
filenames
\emph default
without the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
extension.
So
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is really
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Subsection
-File format
+Format number
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Description
-\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
not
\emph default
mean that they must appear in
-\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
Adds information that will be output in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 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 Description
-\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 Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\end_inset
+
+ 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
+End
+\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
\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_inset
[
-\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
\emph default
to having one or two columns.
Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
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
[
-\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 Description
-\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 Description
-\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
Specifies a module to be included by default with this document class.
The module should be specified by filename without 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_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] This tag indicates that the module in question—which should be specified
by filename without the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\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
-\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
Sets the information that will be output in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
block when this document class is output to XHTML.
Note that this will completely override any prior
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
declarations.
(Use
-\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 Description
-\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 Description
-\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
-\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
[
-\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 Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\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
-\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
[
-\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
+NoCounter
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] This command deletes an existing counter, usually one defined in an included
+ file.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\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
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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_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
[
-\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
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] The default pagestyle.
Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
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
Sets the preamble for the LaTeX document.
Note that this will completely override any prior
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
declarations.
(Use
-\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 Description
-\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
] [
-\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
] Whether the class already provides the feature
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
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
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
, \SpecialChar \ldots{}
) or a macro (
-\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
,\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
if you're interested.
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
extension.
This will typically be used if the layout includes the module directly,
rather than using 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_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] Whether the class requires the feature
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Multiple features must be separated by commas.
Note that you can only request supported features.
(Again, see
-\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
Sets which divisions get numbered.
Corresponds to 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_inset
[
-\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
] 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
+\begin_inset Flex MenuItem
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
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] The name of the command or environment to be used with
-\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
[
-\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
] Indicates what kind of markup is used to define the title of a document.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
means that the macro with 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_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
should be enclosed into 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
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
\end_layout
\begin_layout Subsection
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
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_inset
[
-\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 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
[
-\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 Description
-\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
] Some document class options, separated by a comma, that will be added
to the optional part of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\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 Subsection
-Paragraph Styles
+Paragraph styles
\begin_inset CommandInset label
LatexCommand label
name "sub:Paragraph-Styles"
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new layout or modify an existing one.
+Note that this will either define a new style or modify an existing one.
\end_layout
\end_inset
\end_layout
\begin_layout Description
-\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 Description
-\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 Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- declarations.
+ declaration for this 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_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
-status collapsed
-
-\begin_layout Plain Layout
-$$lang
-\end_layout
-
-\end_inset
-
- is replaced by the language name (as used by the babel package).
-\end_layout
-
-\begin_layout Itemize
-The
-\begin_inset Quotes eld
-\end_inset
-
-Function
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-_()
-\end_layout
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\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.
+ for details on its use.
\end_layout
-\end_deeper
\begin_layout Description
-\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
The vertical space with which the last of a chain of paragraphs with this
- layout is separated from the following paragraph.
- If the next paragraph has another layout, the separations are not simply
+ style is separated from the following paragraph.
+ If the next paragraph has another style, the separations are not simply
added, but the maximum is taken.
\end_layout
\begin_layout Description
-\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
The category for this style.
- This is used to group related styles in the Layout combobox on the toolbar.
+ This is used to group related styles in the style combobox on the toolbar.
Any string can be used, but you may want to use existing categories with
your own styles.
\end_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
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] 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
\end_inset
is
-\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
or
-\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
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
(resp.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
black) square suitable for end of proof markers,
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] The string used for a label with a
-\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 Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Fill_Bottom
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] Similar to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Fill_Top
-\end_layout
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Fill_Top
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
-\end_layout
-
-\end_inset
-
-] With this parameter the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Fill
-\end_layout
-
-\end_inset
-
- value of the
-\begin_inset Quotes eld
-\end_inset
-
-Vertical space above
-\begin_inset Quotes erd
-\end_inset
-
- list of the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
-\end_layout
-
-\end_inset
-
- dialog can be set when initializing a paragraph with this style.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Note from Jean-Marc:
-\emph default
- I'm not sure that this setting has much use, and it should probably be
- removed in later versions.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Note that defining this font automatically defines the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
\end_layout
\begin_layout Description
-\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
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
These tags are used with XHTML output.
See
\begin_inset CommandInset ref
-LatexCommand prettyref
+LatexCommand ref
reference "sub:Paragraph-Style-XHTML"
\end_inset
\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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- If 1, marks the layout as to be included in the document preamble rather
+ If 1, marks the style as to be included in the document preamble rather
than in the document body.
This is useful for document classes that want such information as the title
and author to appear in the preamble.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ Note that this works only for styles for which the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle
+LatexType
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[1, 0]
+Command
\end_layout
\end_inset
- If 1, marks the layout as being part of a title block (see also the
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+Paragraph
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InTitle
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[1, 0]
+\end_layout
+
+\end_inset
+
+ 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
+TitleLatexType
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
\begin_layout Plain Layout
TitleLatexName
\end_layout
\end_layout
\begin_layout Description
-\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
-] This provides extra space between paragraphs that have the same layout.
- If you put other layouts into an environment, each is separated with the
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
environment's
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
But the whole items of the environment are additionally separated with
this
-\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
[
-\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
lead to empty LaTeX output.
There are some cases where this could be desirable however: in a letter
template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a layout can be used
+ people do not forget them; in some special classes, a style can be used
as some kind of break, which does not contain actual text.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
[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
+\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 Description
-\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
must
\emph default
be given if
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
.
- In that case, the counter will be stepped each time the layout appears.
+ In that case, the counter will be stepped each time the style appears.
\begin_inset Newline newline
\end_inset
may
\emph default
also be given if
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is
-\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
.
Then the actual counters used are
-\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
,
-\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_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_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] The string used for a label with a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
labeltype.
When
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
For the sake of backwards compatibility, the string
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
will be replaced by the expanded
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
of style
-\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
[
-\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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Note that every
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
statement resets
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_deeper
\begin_layout Itemize
-\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
means the label is simply whatever
-\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
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
are special cases of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this layout.
+ environment or the top of a chain of paragraphs with this style.
This might be used with the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
- layout, for example.
+ style, for example.
\end_layout
\begin_layout Itemize
-\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
\begin_layout Itemize
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
label type defines automatically numbered labels.
The
-\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_layout
\begin_layout Itemize
-\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
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
\end_deeper
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- Like
-\begin_inset Flex CharStyle:Code
+ Note that this will completely override any prior
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+LangPreamble
\end_layout
\end_inset
-, but this preamble snippet occurs independently from the babel package,
- and only for the document language.
+ declaration for this 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_inset
.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-If the style defines text that appears in the typeset document, it may use
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LangPreamble
-\end_layout
-
-\end_inset
-
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-BabelPreamble
-\end_layout
-
-\end_inset
-
- to support non-english and even multilanguage documents correctly.
- The following excerpt (from the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-theorems-ams.inc
-\end_layout
-
-\end_inset
-
- file) shows how this works:
-\end_layout
-
-\begin_layout LyX-Code
-Preamble
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
-\end_layout
-
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
-
-\begin_layout LyX-Code
-LangPreamble
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
-\end_layout
-
-\begin_layout LyX-Code
-
-\end_layout
-
-\begin_layout LyX-Code
-EndLangPreamble
-\end_layout
-
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
-
-\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 Standard
-The key to correct translation of the user visible text is the definition
- of the command
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-claimname
-\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
-status collapsed
-
-\begin_layout Plain Layout
-BabelPreamble
-\end_layout
-
-\end_inset
-
- then uses the commands offered by the babel package to redefine
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-claimname
-\end_layout
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:I18n"
\end_inset
- for each used language in multilanguage documents.
+ for details on its use.
\end_layout
-\end_deeper
\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
An optional parameter for the corresponding
-\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
[
-\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
-] How the layout should be translated into LaTeX.
+] How the style should be translated into LaTeX.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_deeper
\begin_layout Itemize
-\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
means
-\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
means
-\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
is the same as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, except that an
-\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
is the same as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, except that
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
is passed as an argument to the environment.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
can be defined in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\bar under
-L
+Edit
\bar default
-ayout\SpecialChar \menuseparator
+\SpecialChar \menuseparator
\bar under
P
\bar default
aragraph
+\begin_inset space ~
+\end_inset
+
+settings
\end_layout
\end_inset
\end_deeper
\begin_layout Description
-\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
-] If you put layouts into environments, the leftmargins are not simply added,
+] If you put styles into environments, the leftmargins are not simply added,
but added with a factor
\begin_inset Formula $\frac{4}{depth+4}$
\end_inset
.
Note that this parameter is also used when the margin is defined as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\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
-\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 Description
-\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_inset Newline newline
\end_inset
-The kind of margin that the layout has on the left side.
+The kind of margin that the style has on the left side.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
just means a fixed margin.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
means that the left margin depends on the string entered in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
dialog.
This is used to typeset nice lists without tabulators.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
are not able to do this.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
\end_layout
\begin_layout Description
-\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
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-] Whether fragile commands in this layout should be
-\begin_inset Flex CharStyle:Code
+] Whether fragile commands in this style should be
+\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
[
-\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
] Whether newlines are translated into LaTeX newlines (
-\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
[
-\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
-] Whether the following Paragraph is allowed to indent its very first row.
-
-\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
- means that it is not allowed to do so;
-\begin_inset Flex CharStyle:Code
+ (usually
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Standard
\end_layout
\end_inset
- means it could do so if it wants to.
+) paragraphs are being indented, then the indentation of such a paragraph
+ following one of this type will be suppressed.
+ (So this will not affect the display of non-default paragraphs.)
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- Name of a layout that has replaced this layout.
- This is used to rename a layout, while keeping backward compatibility.
+ Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
\end_layout
\begin_layout Description
-\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
-] The number of optional arguments that can be used with this layout.
+] The number of optional arguments that can be used with this style.
This is useful for things like section headings, and only makes sense with
LaTeX.
+ Note that, on output, the optional arguments will all precede any required
+ arguments (see below).
+ So one can have constructs like:
+\end_layout
+
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+mycmd[opt1]{req1}{contents of paragraph}
+\end_layout
+
+\begin_layout Standard
+but one cannot have things like:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+mycmd[opt1]{req1}[opt2]{contents of paragraph}
+\end_layout
+
+\begin_layout Standard
+at least, not without ERT (with which you can have anything).
+
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ParbreakIsNewline
+\end_layout
+
+\end_inset
+
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:ParbreakIsNewline"
+
+\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 that paragraphs will not be separated by an empty line in LaTeX
+ output, but only by a line break; together with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PassThru 1
+\end_layout
+
+\end_inset
+
+, this allows to emulate a plain text editor (like the ERT inset).
\end_layout
\begin_layout Description
-\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
] 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
\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
+ 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
\end_inset
.
- Also, Standard layout paragraphs inside environments use the
-\begin_inset Flex CharStyle:Code
+ Also,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\end_inset
+
+ style paragraphs inside environments use the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
of the environment, not their native one.
- For example, Standard paragraphs inside an enumeration are not indented.
+ For example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Standard
+\end_layout
+
+\end_inset
+
+ paragraphs inside an enumeration are not indented.
\end_layout
\begin_layout Description
-\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
-] The vertical space between two paragraphs of this layout.
+] The vertical space between two paragraphs of this style.
\end_layout
\begin_layout Description
-\begin_inset 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_inset Quotes erd
\end_inset
- layout is ignored and all paragraphs are separated by this parskip argument.
+ style is ignored and all paragraphs are separated by this parskip argument.
The vertical space is calculated with
-\begin_inset Flex 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
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset label
LatexCommand label
-name "des:PathThru"
+name "des:PassThru"
\end_inset
[
-\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 Description
-\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 Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+RefPrefix
\end_layout
\end_inset
-[
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-]
-\begin_inset CommandInset label
+] The prefix to use when creating labels referring to paragraphs 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
+RequiredArgs
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=0
+\end_layout
+
+\end_inset
+
+] 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
+OptionalArgs
+\end_layout
+
+\end_inset
+
+ tag above for more information.
+\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
+
+]
+\begin_inset CommandInset label
LatexCommand label
name "des:Requires"
\end_inset
-Whether the layout requires the feature
-\begin_inset Flex CharStyle:Code
+Whether the style requires the feature
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
See the description 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_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] Similar to
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
value
\emph default
-] This defines what the default spacing should be in the layout.
+] This defines what the default spacing should be in the style.
The arguments
-\begin_inset Flex 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
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
correspond respectively to a multiplier value of 1, 1.25 and 1.667.
If you specify the argument
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
, 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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
implies the generation of specific LaTeX code, using the package
\family roman
-\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
+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 paragraphs of this style.
+ Default is true.
+\end_layout
+
+\begin_layout Description
+\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
\series medium
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain 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
+ 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
-Floats
\begin_inset CommandInset label
LatexCommand label
-name "sub:Floats"
+name "sub:I18n"
\end_inset
+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
-Since version 1.3.0 of LyX, it is has been both possible and necessary to
- define the floats (
-\begin_inset Flex CharStyle:MenuItem
+If a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+Style
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+ defines text that is to appear in the typeset document, it may use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-table
+LangPreamble
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- Standard floats are included in the file
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdfloats.inc
+BabelPreamble
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
+ to support non-English and even multi-language documents correctly.
+ The following excerpt (from the
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Input stdfloats.inc
+\begin_layout Plain Layout
+theorems-ams.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_inset
+
+ file) shows how this works:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+Preamble
+\end_layout
-\begin_layout Plain Layout
-Extension
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
-\begin_layout Plain Layout
-string
+\begin_layout LyX-Code
+LangPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
-=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- LaTeX writes the captions to this file.
+\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
-GuiName
+LangPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+BabelPreamble
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+ 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_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-] 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.
+\backslash
+claimname
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ and its use in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+
+\backslash
+newtheorem
\end_layout
\end_inset
- These are used for XHTML output.
- See
+.
+
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXBuiltin
+LangPreamble
\end_layout
\end_inset
- [
-\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
-
-\emph on
-0
+Preamble
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\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
-] Set to
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+_()
\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
+, 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
-0
+BabelPreamble
\end_layout
\end_inset
-, the float will be defined using the LaTeX package
-\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
-float
+babel
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\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
-ListName
+_()
\end_layout
\end_inset
- [
-\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
-string
+$$lang
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ is replaced by the language name (as used by the babel package).
+\end_layout
+\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
+babel
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The heading used for the list of floats.
- This is translated to the document language.
+ will then conspire to produce the correct text in the output.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\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
-NumberWithin
+LangPreamble
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+BabelPreamble
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ 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
-\begin_inset Quotes erd
+\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
+figure
+\end_layout
+
\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 MenuItem
status collapsed
\begin_layout Plain Layout
-chapter
+table
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
+, \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
-Placement
+Extension
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Quotes erd
\end_inset
-] The default placement for the given class of floats.
- The string should be as in standard LaTeX:
-\begin_inset Flex CharStyle:Code
+] 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 Code
status collapsed
\begin_layout Plain Layout
-t
+GuiName
\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
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The string that will be used in the menus and also for the caption.
+ This is translated to the current language if babel is used.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-p
+HTML*
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
+ These are used for XHTML output.
+ See
+\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
-h
+IsPredefined
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
-status collapsed
+ [
+\emph on
+
+\begin_inset Flex Code
+status open
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+0
\end_layout
\end_inset
- On top of that there is a new type,
-\begin_inset Flex CharStyle:Code
+
+\emph default
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+1
\end_layout
\end_inset
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
-\end_inset
+] 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
+float.sty
+\end_layout
-here
-\begin_inset Quotes erd
\end_inset
- and nowhere else.
- Note however that the
-\begin_inset Flex CharStyle:Code
+ and use what it provides to define it on-the-fly.
+ The default is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-H
+0
\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 CharStyle:Code
+, which means: use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tbp
+float.sty
\end_layout
\end_inset
+.
+ It should be set to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+ if the float is already defined by the LaTeX document class.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+ListCommand
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Quotes erd
\end_inset
-] The style used when defining the float using
-\begin_inset Flex CharStyle:Code
+] 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
+UsesFloatPkg
+\end_layout
-\backslash
-newfloat
+\end_inset
+
+ 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
+UsesFloatPkg
\end_layout
\end_inset
-.
+ 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
-Type
+ListName
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Quotes erd
\end_inset
-] The
-\begin_inset Quotes eld
-\end_inset
-
-type
-\begin_inset Quotes erd
-\end_inset
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within LyX; it is passed to LaTeX for use
+ as the title there; and it is used as the title in XHTML output.
+ It will be translated to the document language.
+\end_layout
- of the new class of floats, like program or algorithm.
- After the appropriate
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+NumberWithin
\end_layout
\end_inset
-, commands such as
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+string
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
+=
+\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
-
-\backslash
-end{algorithm*}
+chapter
\end_layout
\end_inset
- will be available.
+, the floats will be numbered within chapters.
+
\end_layout
-\begin_layout Standard
-Note that defining a float with type
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+Placement
\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
+string
\end_layout
\end_inset
-.
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Flex-insets-and"
+\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
-\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
+\end_inset
-\begin_layout Itemize
-character style (
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+b
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-noun
+p
\end_layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-code
+h
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Itemize
-user custom (
-\begin_inset Flex CharStyle:Code
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Custom
+Note that the order of these letters in the string is irrelevant, like in
+ LaTeX.
\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
+ On top of that there is a new type,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-endnote
+H
\end_layout
\end_inset
- module.
-\end_layout
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-XML elements (
-\begin_inset Flex CharStyle:Code
+here
+\begin_inset Quotes erd
+\end_inset
+
+ and nowhere else.
+ Note however that the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Element
+H
\end_layout
\end_inset
-): For use with DocBook classes.
-\end_layout
+ 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_layout Standard
-Flex insets are defined using the
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+tbp
\end_layout
\end_inset
- tag, which shall be explained in a moment.
+
+\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
-InsetLayout
+RefPrefix
\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 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
+] 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
-InsetLayout
+RefPrefix
\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 CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-<Type>
-\end_layout
+ set by a copied style by using the special value
+\begin_inset Quotes eld
+\end_inset
+OFF
+\begin_inset Quotes erd
\end_inset
- indicates the inset whose layout is being defined, and here there are two
- cases.
+, which must be all caps.
\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_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+Style
\end_layout
\end_inset
- any one of the following:
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Branch
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] The style used when defining the float using
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+
+\backslash
+newfloat
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+Type
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ERT
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Figure
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Foot
-\end_layout
+] The
+\begin_inset Quotes eld
+\end_inset
+type
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ of the new class of floats, like program or algorithm.
+ After the appropriate
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Index
+
+\backslash
+newfloat
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+, commands such as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info
+
+\backslash
+begin{program}
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:menu
+
+\backslash
+end{algorithm*}
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ will be available.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info:shortcut
+UsesFloatPkg
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+ [
+\begin_inset Flex Code
+status open
\begin_layout Plain Layout
-Info:shortcuts
+0
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Listings
+
+\emph on
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] Tells us whether this float is defined using the facilities provided by
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Marginal
+float.sty
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+, either by the class file or a package, or on-the-fly by LyX itself.
+\end_layout
+
+\begin_layout Standard
+Note that defining a float with type
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Comment
+
+\emph on
+type
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ automatically defines the corresponding counter with name
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+
+\emph on
+type
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Note:GreyedOut
+.
\end_layout
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Flex-insets-and"
+
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-OptArg
\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
-,
-\begin_inset Flex CharStyle:Code
+\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
-Table
+CharStyle
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+): These define semantic markup corresponding to such LaTeX commands as
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+
+\backslash
+noun
\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>
+
+\backslash
+code
\end_layout
\end_inset
- can be any valid identifier not used by a pre-existing inset.
- Note that the definition of a flex inset
-\emph on
-must
-\emph default
-also include a
-\begin_inset Flex CharStyle:Code
+.
+\end_layout
+
+\begin_layout Itemize
+user custom (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+Custom
\end_layout
\end_inset
- entry, declaring which type of inset this is.
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
+): 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
-InsetLayout
+endnote
\end_layout
\end_inset
- definition can contain the following entries:
+ module.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+XML elements (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BgColor
+Element
\end_layout
\end_inset
- The color for the inset's background.
- The valid colors are defined in
-\begin_inset Flex CharStyle:Code
+): 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
-src/ColorCode.h
+InsetLayout
\end_layout
\end_inset
-.
+ tag, which shall be explained in a moment.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ContentAsLabel
+InsetLayout
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ 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
-
-\emph on
-0
+InsetLayout
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ 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
-1
+InsetLayout
\end_layout
\end_inset
-] Whether to use the content of the inset as the label, when the inset is
- closed.
- Default is false.
+ definition must begin with a line of the form:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout LyX-Code
+InsetLayout <Type>
+\end_layout
+
+\begin_layout Standard
+Here
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+<Type>
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
-
-\end_inset
-
-).
+ indicates the inset whose layout is being defined, and here there are two
+ cases.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\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
-CustomPars
+<Type>
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ any one of the following:
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Algorithm
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Branch
\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_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Decoration
+Box
\end_layout
\end_inset
- can be
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+Box:shaded
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+ERT
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+Figure
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+Foot
\end_layout
\end_inset
-, ERT insets generally
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+Index
\end_layout
\end_inset
-, and character styles
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+Info
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+Info:menu
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+Info:shortcut
\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 Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+Info:shortcuts
+\end_layout
\end_inset
-.
- Note that defining this font automatically defines the
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Listings
\end_layout
\end_inset
- to the same value, so define this first and define
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Marginal
\end_layout
\end_inset
- later if you want them to be different.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+Note:Comment
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-latex
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Note:Note
+\end_layout
- language, leading to Left-to-Right (latin) output, e.
-\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space \space{}
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-in TeX code or URL.
- A kludge.
+\begin_layout Plain Layout
+Note:Greyedout
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+OptArg
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Table
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+, or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+URL
\end_layout
\end_inset
-] Indicates whether the PlainLayout 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 CharStyle:Code
+\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
-FreeSpacing
+<Type>
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
-
+ must be of the form
+\begin_inset Quotes eld
\end_inset
-).
- Default is false.
-\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+Flex:<name>
\end_layout
\end_inset
- These tags control XHTML output.
- See
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-InToc
-\end_layout
+\begin_inset Quotes erd
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+name
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ 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
-1
+LyXType
\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.
+ entry, declaring which type of inset it defines.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+InsetLayout
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
-
-\end_inset
-
-).
- Default is false.
+ definition can contain the following entries:
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle: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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+BgColor
\end_layout
\end_inset
-, lest it be ineffective.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ The color for the inset's background.
+ The valid colors are defined in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+src/ColorCode.h
\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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+ContentAsLabel
\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
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
-\end_layout
-
-\end_inset
-
- The optional parameter for the corresponding
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-LatexName
+\emph on
+0
\end_layout
\end_inset
- stuff, including possible bracket pairs like
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+1
\end_layout
\end_inset
-.
- This parameter cannot be changed from within LyX.
+] 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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+CopyStyle
\end_layout
\end_inset
As with paragraph styles (see page
\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
+LatexCommand ref
+reference "des:CopyStyle"
\end_inset
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyxType
+CustomPars
\end_layout
\end_inset
- Can be
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+
+\emph on
+0
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-custom
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+] 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
-element
+Decoration
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+ can be
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-end
+Classic
\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 CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+Minimalistic
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+, or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+Conglomerate
\end_layout
\end_inset
- will set
-\begin_inset Flex CharStyle:Code
+, 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
-MultiPar
+Classic
\end_layout
\end_inset
- to false.
-
-\begin_inset Flex CharStyle:Code
+, ERT insets generally
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+Minimalistic
\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 CharStyle:Code
+, and character styles
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+Conglomerate
\end_layout
\end_inset
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+Display
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
0
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set
-\begin_inset Flex CharStyle:Code
+] Only useful if
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+LatexType
\end_layout
\end_inset
- to the same value and
-\begin_inset Flex CharStyle:Code
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+Environment
\end_layout
\end_inset
- to the opposite value.
- These can be reset to other values, if they are used
+.
+ 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
-after
+LatexName
\emph default
-
-\begin_inset Flex CharStyle:Code
+}
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-.
+ tags.
Default is true.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+End
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ 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
-0
-\end_layout
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ Note that defining this font automatically defines the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+LabelFont
\end_layout
\end_inset
-] Whether fragile commands in this layout should be
-\begin_inset Flex CharStyle:Code
+ to the same value, so define this first and define
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+LabelFont
\end_layout
\end_inset
-'ed.
- (Note: This is
-\emph on
-not
-\emph default
- whether the command should itself be protected.) Default is false.
+ later if you want them to be different.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+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 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
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:PathThru"
+] 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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+FreeSpacing
\end_layout
\end_inset
As with paragraph styles (see page
\begin_inset CommandInset ref
LatexCommand pageref
-reference "des:Preamble"
+reference "des:FreeSpacing"
\end_inset
).
+ Default is false.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Requires
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+HTML*
\end_layout
\end_inset
-] As with paragraph styles (see page
+ These tags control XHTML output.
+ See section
\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Requires"
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Counters"
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
\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
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+InToc
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+
+\emph on
+0
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- The standard counters are defined in the file
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
+1
\end_layout
\end_inset
-, so you may have to do no more than add
+] 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 LyX-Code
-Input stdcounters.inc
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\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:
+\begin_layout Plain Layout
+KeepEmpty
\end_layout
-\begin_layout LyX-Code
-Counter CounterName
+\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 Standard
-where of course `
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CounterName
+LabelFont
\end_layout
\end_inset
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
+ The font used for the label.
+ See section
+\begin_inset space ~
\end_inset
-\begin_inset Flex CharStyle:Code
+\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
-End
+Font
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- The following parameters can also be used:
+, lest it be ineffective.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ 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
-string
+TeX code
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Branch
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] When defined, this string defines how the counter is displayed.
- Setting this value sets
-\begin_inset Flex CharStyle:Code
+) modify this label on the fly.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+LatexName
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
-\begin_deeper
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+LatexParam
\end_layout
\end_inset
- will be replaced by the expansion of the
-\begin_inset Flex CharStyle:Code
+ The optional parameter for the corresponding
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+LatexName
\end_layout
\end_inset
- (or
-\begin_inset Flex CharStyle:Code
+ stuff, including possible bracket pairs like
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+[]
\end_layout
\end_inset
-) of the counter
-\begin_inset Flex CharStyle:Code
+.
+ This parameter cannot be changed from within LyX.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-counter
+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 Itemize
-counter values can be expressed using LaTeX-like macros
-\begin_inset Flex CharStyle:Code
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LyxType
+\end_layout
-\backslash
+\end_inset
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
+ Can be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+charstyle
\end_layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+custom
+\end_layout
-\emph on
-numbertype
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+element
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+, or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+end
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
+\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
+\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
-\bar default
-
-\size 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
-\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.
+none
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+black
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+white
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+red
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+green
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Roman
+blue
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-;
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-hebrew
+cyan
\end_layout
\end_inset
- for hebrew numerals.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+magenta
\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
+\end_inset
+
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+yellow
\end_layout
\end_inset
- (defined via
-\begin_inset Flex CharStyle:Code
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+Family
\end_layout
\end_inset
-), the string
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-themaster.
-\backslash
-arabic{counter}
+\emph on
+Roman
\end_layout
\end_inset
- is used; otherwise the string
-\begin_inset Flex CharStyle:Code
+,
+\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
-
-\backslash
-arabic{counter}
+emph
\end_layout
\end_inset
- is used.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+noun
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+underbar
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+no_emph
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] Same as
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+no_noun
\end_layout
\end_inset
-, but for use in the Appendix.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PrettyFormat
+no_bar
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+emph
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+ turns on emphasis, and
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+no_emph
+\end_layout
-\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
+ turns it off.
+
+\begin_inset Newline newline
\end_inset
-Section 2.4
-\begin_inset Quotes erd
-\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
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+no_emph
+\end_layout
-##
-\begin_inset Quotes erd
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+Series
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+Medium
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Bold
+\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
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+Shape
\end_layout
\end_inset
- is numbered inside
-\begin_inset Flex CharStyle:Code
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
+
+\emph on
+Up
\end_layout
\end_inset
-.
-\end_layout
+,
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Font description
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Font-description"
+\begin_layout Plain Layout
+Italic
+\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+SmallCaps
\end_layout
-\begin_layout Standard
-A font description looks like this:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
-\end_layout
+,
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- ...
+\begin_layout Plain Layout
+Slanted
\end_layout
-\begin_layout LyX-Code
-EndFont
-\end_layout
+\end_inset
-\begin_layout Standard
-The following commands are available:
+]
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+Size
\end_layout
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-none
+tiny
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+small
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+
+\emph on
+normal
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+large
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-green
+larger
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-blue
+largest
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+huge
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+giant
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-yellow
+]
\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 Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+CiteFormat
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Roman
+ 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
-\end_inset
+\begin_layout LyX-Code
+CiteFormat
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+ article ...
+\end_layout
-\begin_layout Plain Layout
-Sans
+\begin_layout LyX-Code
+ book ...
\end_layout
-\end_inset
+\begin_layout LyX-Code
+End
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
+\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
-Typewriter
+stdciteformats.inc
\end_layout
\end_inset
-]
+, which is included in most of LyX's document classes.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\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
-Misc
+%
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
+ signs, e.g.:
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+%author%
\end_layout
\end_inset
-] Valid arguments are:
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-emph
+.
+ So a simple definition might look like this:
\end_layout
+\begin_layout LyX-Code
+misc %author%,
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+%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
-noun
+{%volume%[[vol.
+\begin_inset space ~
+\end_inset
+
+%volume%]]}
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ This says: If the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-underbar
+volume
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ 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
-no_emph
+{%author%[[%author%]][[%editor%, ed.]]}
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ Here, the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_noun
+author
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-no_bar
-\end_layout
+,
+\begin_inset space ~
+\end_inset
+ed.
+\begin_inset Quotes erd
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
- For example,
-\begin_inset Flex CharStyle:Code
+ Note that the key is again enclosed in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+%
\end_layout
\end_inset
- turns on emphasis, and
-\begin_inset Flex CharStyle:Code
+ 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
-no_emph
+[[
\end_layout
\end_inset
- turns it off.
-
-\begin_inset Newline newline
+
+\begin_inset Quotes eld
\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 CharStyle:Code
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\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.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ There must be no space between any of these.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\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
-Series
+{!<i>!}
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
+.
+ This defines a piece of formatting information that is to be used when
+ creating
+\begin_inset Quotes eld
+\end_inset
-\emph on
-Medium
-\end_layout
+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 Flex CharStyle:Code
-status collapsed
+{!
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Bold
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
+!}
+\begin_inset Quotes erd
\end_inset
-]
+.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Two special sorts of definitions are also possible in a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Shape
+CiteFormat
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Up
+ block.
+ An example of the first would be:
\end_layout
+\begin_layout LyX-Code
+!quotetitle
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+%title%
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Italic
-\end_layout
-\end_inset
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
+\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
-SmallCaps
+%!quotetitle%
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ LyX will treat
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Slanted
+%!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 Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+!funfun %funfun%
+\end_layout
-\begin_layout Plain Layout
-Size
+\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
-\end_inset
+\begin_layout Standard
+The second sort of special definition might look like this:
+\end_layout
- [
-\begin_inset Flex CharStyle:Code
+\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
-tiny
+%_pptext%
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+.
+ Several of these are predefined in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-small
+stdciteformats.inc
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
+.
+ Note that these are not macros, in the sense just defined.
+ They will not be expanded.
+\end_layout
-\emph on
-normal
+\begin_layout Standard
+So here then is an example that use all these features:
\end_layout
-\end_inset
+\begin_layout LyX-Code
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
+\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
-large
+author
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ key is defined, or else prints the name of the editor, followed by the
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-larger
+_edtext
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-largest
-\end_layout
+ or its translation (it is by default
+\begin_inset Quotes eld
+\end_inset
+ed.
+\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+), if the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-huge
+editor
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ key is defined.
+ Note that this is in fact defined in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
+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
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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Note that there are two tags,
-\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
that may appear outside style and inset declarations.
See
\begin_inset CommandInset ref
-LatexCommand prettyref
+LatexCommand ref
reference "sub:General-text-class"
\end_inset
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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Note the different orders of
-\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
.
Which order we get depends upon the setting of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
: If
-\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
[
-\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
-\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
\end_inset
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
+HTMLStyle
+\end_layout
+
+\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
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] Whether to output the default CSS information LyX generates for this layout,
even if additional information is explicitly provided via
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Setting this to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
allows you to alter or augment the generated CSS, rather than to override
it completely.
Default is
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] The tag to be used for individual paragraphs of environments, replacing
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
in the examples above.
Defaults to
-\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
[
-\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
.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\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
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] The tag to be used for paragraph and item labels, replacing
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
in the examples above.
Defaults to
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
+, unless
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelType
+\end_layout
+
+\end_inset
+
+ is either
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Top_Environment
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Centered_Top_Environment
+\end_layout
+
+\end_inset
+
+, in which case it defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
.
\end_layout
\begin_layout Description
-\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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
.
+ This should
+\emph on
+not
+\emph default
+ contain any style information.
+ Use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\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
\end_inset
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Default is
-\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
Information to be output in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
section when this style is used.
This might, for example, be used to include a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
block defining an
-\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
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 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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] The tag to be used for the main label, replacing
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
in the examples above.
Defaults to
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] Marks this style as the one to be used to generate the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
tag for the XHTML file.
By default, it is false.
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file sets it to true for the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
If the inset permits multiple paragraphs---that is, if
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 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
[
-\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
-\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
\end_layout
\begin_layout Description
-\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
] Whether to output the default CSS information LyX generates for this layout,
even if additional information is explicitly provided via
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Setting this to
-\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
[
-\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 Description
-\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
] The inner tag, replacing
-\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
[
-\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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
] A label for this inset, possibly including a reference to a counter.
For example, for footnote, it might be:
-\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
Information to be output in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
section when this style is used.
This might, for example, be used to include a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
block defining an
-\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
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 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
[
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
] The tag to be used for the main label, replacing
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
in the examples above.
The default depends upon the setting of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
: If
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
is true, the default is
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
; if it is false, the default is
-\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
[
-\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
-\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
\end_inset
- is LyX's name for this type of float, as determined by the float delcaration
+ is LyX's name for this type of float, as determined by the float declaration
(see
\begin_inset CommandInset ref
LatexCommand ref
\end_layout
\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 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
[
-\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
in the example above.
The default is
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
and will rarely need changing.
\end_layout
+\begin_layout Subsection
+Bibliography formatting
+\end_layout
+
+\begin_layout Standard
+The bibliography can be formatted using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
+\end_layout
+
+\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
At present, LyX auto-generates CSS only for font information, making use
of the
-\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
,
-\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
specified in the
-\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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
The correspondence of LyX sizes and CSS sizes is a little less obvious
but nonetheless intuitive.
See the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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