-#LyX 2.1 created this file. For more info see http://www.lyx.org/
-\lyxformat 452
+#LyX 2.2 created this file. For more info see http://www.lyx.org/
+\lyxformat 508
\begin_document
\begin_header
+\save_transient_properties true
+\origin /systemlyxdir/doc/
\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
% the documentation team
% email: lyx-docs@lists.lyx.org
-\usepackage{ifpdf} % part of the hyperref bundle
-\ifpdf % if pdflatex is used
-
- % set fonts for nicer pdf view
- \IfFileExists{lmodern.sty}
- {\usepackage{lmodern}}{}
-
-\fi % end if pdflatex is used
-
% the pages of the TOC is numbered roman
% and a pdf-bookmark for the TOC is added
\let\myTOC\tableofcontents
\pdfbookmark[1]{\contentsname}{}
\myTOC
\mainmatter }
+
+% increase link area for cross-references and autoname them,
+\AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
+\@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
+\@ifpackageloaded{babel}{
+ \addto\extrasenglish{%
+ \renewcommand*{\equationautorefname}[1]{}%
+ \renewcommand{\sectionautorefname}{sec.\negthinspace}%
+ \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
+ \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
+ }
+}{}
\end_preamble
\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
logicalmkup
\end_modules
\maintain_unincluded_children false
-\begin_local_layout
-Format 35
-InsetLayout Flex:MenuItem
-LyxType charstyle
-LabelString menu
-LatexType command
-LatexName menuitem
-Font
-Family Sans
-EndFont
-Preamble
-\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_math auto
+\font_roman "lmodern" "default"
+\font_sans "lmss" "default"
+\font_typewriter "lmtt" "default"
+\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
-\font_sf_scale 100
-\font_tt_scale 100
+\font_sf_scale 100 100
+\font_tt_scale 100 100
\graphics default
-\default_output_format default
+\default_output_format pdf2
\output_sync 0
\bibtex_command default
\index_command default
\use_geometry false
\use_package amsmath 0
\use_package amssymb 0
+\use_package cancel 0
\use_package esint 0
\use_package mathdots 1
\use_package mathtools 0
\use_package mhchem 0
+\use_package stackrel 0
+\use_package stmaryrd 0
\use_package undertilde 0
\cite_engine basic
-\cite_engine_type numerical
+\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\suppress_date false
\justification true
\use_refstyle 0
+\notefontcolor #0000ff
\branch OutDated
\selected 0
\filename_suffix 0
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes true
+\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict true
-\author -712698321 "Jürgen Spitzmüller"
-\author -195340706 "Georg Baum"
-\author 5863208 "ab"
-\author 155139281 "Jrgen Spitzmller"
-\author 1082167584 "Kayvan Sylvan" kayvan@sylvan.com
-\author 1414654397 "Richard Heck"
-\author 2090807402 "usti"
\end_header
\begin_body
\begin_layout Title
-Customizing LyX: Features for the Advanced User
+Customizing \SpecialChar LyX
+: Features for the Advanced User
\end_layout
\begin_layout Author
-by the LyX Team
+by the \SpecialChar LyX
+ Team
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\noindent
-If you have comments or error corrections, please send them to the LyX Documenta
-tion mailing list,
+If you have comments or error corrections, please send them to the \SpecialChar LyX
+ Documentatio
+n mailing list,
\begin_inset CommandInset href
LatexCommand href
target "lyx-docs@lists.lyx.org"
\begin_inset Newline newline
\end_inset
-Version 2.0.x
+Version 2.2.x
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-This manual covers the customization features present in LyX.
+This manual covers the customization features present in \SpecialChar LyX
+.
In it, we discuss issues like keyboard shortcuts, screen previewing options,
- printer options, sending commands to LyX via the LyX Server, internationalizati
-on, installing new LaTeX classes and LyX layouts, etc.
+ printer options, sending commands to \SpecialChar LyX
+ via the \SpecialChar LyX
+ Server, internationalization,
+ installing new \SpecialChar LaTeX
+ classes and \SpecialChar LyX
+ layouts, etc.
We can't possibly hope to touch on everything you can change—our developers
add new features faster than we can document them—but we will explain the
most common customizations and hopefully point you in the right direction
\begin_layout Standard
Information from previous versions of this document that now seems to be
outdated is contained in the OutDated branch of this document.
- By default, this information will not appear in the LaTeX output.
+ By default, this information will not appear in the \SpecialChar LaTeX
+ output.
\end_layout
\end_inset
\end_layout
\begin_layout Chapter
-LyX configuration files
+\SpecialChar LyX
+ configuration files
\end_layout
\begin_layout Standard
-This chapter aims to help you to find your way through the LyX configuration
+This chapter aims to help you to find your way through the \SpecialChar LyX
+ configuration
files.
Before continuing to read this chapter, you should find out where your
- LyX library and user directories are by using
-\begin_inset Flex MenuItem
+ \SpecialChar LyX
+ library and user directories are by using
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
+Help\SpecialChar menuseparator
About
\begin_inset space ~
\end_inset
\end_inset
.
- 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.
+ The library directory is the place where \SpecialChar LyX
+ places its system-wide configuration
+ files; the user directory is where you can place your modified versions.
We will call the former
\begin_inset Flex Code
status collapsed
\end_inset
and the latter
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
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 MenuItem
+ to customize \SpecialChar LyX
+'s behavior.
+ You can change many of these files from within \SpecialChar LyX
+ itself through the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\end_layout
\end_inset
dialog.
- Most customization that you will want to do in LyX is possible through
- this dialog.
- However, many other inner aspects of LyX can be customized by modifying
- the files in
+ Most customization that you will want to do in \SpecialChar LyX
+ is possible through this
+ dialog.
+ However, many other inner aspects of \SpecialChar LyX
+ can be customized by modifying the
+ files in
\begin_inset Flex Code
status collapsed
\begin_layout Standard
The files, which are to be found in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-, are generated when you configure LyX.
+, are generated when you configure \SpecialChar LyX
+.
They contain various default values that are guessed by inspection.
In general, it is not a good idea to modify them, since they might be overwritt
en at any time.
\end_inset
- contains the list of packages that have been recognized by LyX.
- It is currently unused by the LyX program itself, but the information extracted
-, and more, is made available with
-\begin_inset Flex MenuItem
+ contains the list of packages that have been recognized by \SpecialChar LyX
+.
+ It is currently unused by the \SpecialChar LyX
+ program itself, but the information extracted,
+ and more, is made available with
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX
+Help\SpecialChar menuseparator
+\SpecialChar LaTeX
+
\begin_inset space ~
\end_inset
\end_inset
- directories, along with the associated LaTeX document class and their descripti
-on.
+ directories, along with the associated \SpecialChar LaTeX
+ document class and their description.
\end_layout
\begin_layout Labeling
\end_inset
- lists of various sorts of LaTeX-related files found on your system
+ lists of various sorts of \SpecialChar LaTeX
+-related files found on your system
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-doc/LaTeXConfig.lyx
+doc/\SpecialChar LaTeX
+Config.lyx
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LaTeXConfig.lyx.in
+\SpecialChar LaTeX
+Config.lyx.in
\end_layout
\end_inset
.
- It contains information on your LaTeX configuration.
+ It contains information on your \SpecialChar LaTeX
+ configuration.
\end_layout
\begin_layout Subsection
\end_inset
- that define the keybindings used in LyX.
+ that define the keybindings used in \SpecialChar LyX
+.
If there exists an internationalized version of the bind file named
\begin_inset Flex Code
status collapsed
\end_inset
- contains LyX documentation files (including the one you are currently reading).
+ contains \SpecialChar LyX
+ documentation files (including the one you are currently reading).
The file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXConfig.lyx
+\SpecialChar LaTeX
+Config.lyx
\end_layout
\end_inset
\end_inset
is the ISO language code.
- See chapter
-\begin_inset space ~
-\end_inset
-
-
+ See
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:Internationalizing-LyX"
contains example files that explain how to use some features.
In the file browser, press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
contains image files that are used by the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
dialog.
In addition, it also contains the individual icons used in the toolbar
- and the banners that can be shown when LyX is launched.
+ and the banners that can be shown when \SpecialChar LyX
+ is launched.
\end_layout
\begin_layout Labeling
\end_inset
contains keyboard keymapping files.
- See Chapter
-\begin_inset space ~
-\end_inset
-
-
+ See
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:International-Keymap-Stuff"
\end_inset
- contains the text class and module files described in Chapter
-\begin_inset space ~
-\end_inset
-
-
+ contains the text class and module files described in
\begin_inset CommandInset ref
LatexCommand ref
reference "cha:Installing-New-Document"
\end_inset
- Python scripts used to convert between LyX versions.
+ Python scripts used to convert between \SpecialChar LyX
+ versions.
These can be run from the command line if, say, you want to batch-convert
files.
\end_layout
\end_inset
contains some files that demonstrate the capabilities of the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
feature.
- Also contains some scripts used by LyX itself.
+ Also contains some scripts used by \SpecialChar LyX
+ itself.
\end_layout
\begin_layout Labeling
\end_inset
- contains the standard LyX template files described in Chapter
-\begin_inset space ~
-\end_inset
-
-
+ contains the standard \SpecialChar LyX
+ template files described in
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Creating-Templates"
+reference "subsec:Creating-Templates"
\end_inset
\end_inset
- that define the user interface to LyX.
+ that define the user interface to \SpecialChar LyX
+.
That is, the files define which items appear in which menus and the items
appearing on the toolbar.
\end_layout
\end_layout
\begin_layout Standard
-These files are used internally by LyX and you generally do not need to
- modify them unless you are a developer.
+These files are used internally by \SpecialChar LyX
+ and you generally do not need to modify
+ them unless you are a developer.
\end_layout
\begin_layout Labeling
\end_inset
- this file contains the list of LyX developers.
+ this file contains the list of \SpecialChar LyX
+ developers.
The contents are displayed with the menu entry
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
+Help\SpecialChar menuseparator
About
\begin_inset space ~
\end_inset
\end_inset
- this is a LaTeX script used during the configuration process.
+ this is a \SpecialChar LaTeX
+ script used during the configuration process.
Do not run directly.
\end_layout
\end_inset
- this is the script that is used to re-configure LyX.
+ this is a Python script that is used to re-configure \SpecialChar LyX
+.
It creates configuration files in the directory it was run from.
\end_layout
\begin_layout Subsection
-Other files needing a line or two...
+Other files needing a line or two
\end_layout
\begin_layout Labeling
\end_inset
this file contains the templates available to the new
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- feature.
+ feature, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Including-External-Material"
+
+\end_inset
+
+.
\end_layout
\begin_layout Labeling
\end_inset
- this file contains a list of all the languages currently supported by LyX.
-\change_inserted -195340706 1334775793
-
+ this file contains a list of all the languages currently supported by \SpecialChar LyX
+.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-
-\change_inserted -195340706 1334775793
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+latexfonts
+\end_layout
+
+\end_inset
+
+ contains information about the supported fonts.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
-\change_inserted -195340706 1334775793
+\begin_layout Plain Layout
layouttranslations
\end_layout
\end_inset
this file contains translations for internationalized paragraph styles
- (see sec.
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ (see
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:I18n"
+reference "subsec:I18n"
\end_inset
).
-\change_unchanged
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+unicodesymbols
+\end_layout
+
+\end_inset
+ this file contains information about unicode-encoded glyphs and the way
+ they are supported by \SpecialChar LyX
+ via \SpecialChar LaTeX
+.
\end_layout
\begin_layout Section
\end_layout
\begin_layout Standard
-Even if you are using LyX as an unprivileged user, you might want to change
- LyX configuration for your own use.
+Even if you are using \SpecialChar LyX
+ as an unprivileged user, you might want to change
+ \SpecialChar LyX
+ configuration for your own use.
The
\begin_inset Flex Code
status collapsed
\end_inset
in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
+Help\SpecialChar menuseparator
About
\begin_inset space ~
\end_inset
\begin_layout Itemize
The preferences set in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\end_layout
\begin_layout Itemize
When you reconfigure using
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Reconfigure
\end_layout
\end_inset
-, LyX runs the
+, \SpecialChar LyX
+ runs the
\begin_inset Flex Code
status collapsed
\end_inset
will be added to the list of classes in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_layout
\begin_layout Itemize
-If you get some updated documentation from LyX ftp site and cannot install
+If you get some updated documentation from \SpecialChar 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 Code
\end_inset
and the items in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Section
-Running LyX with multiple configurations
+Running \SpecialChar LyX
+ with multiple configurations
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-Invoking LyX with the command line switch
+Invoking \SpecialChar LyX
+ with the command line switch
\begin_inset Flex Code
status collapsed
\emph default
instructs the program to read the configuration from that directory, and
not from the default directory.
- (You can determine the default directory by running LyX without the
+ (You can determine the default directory by running \SpecialChar LyX
+ without the
\begin_inset Flex Code
status collapsed
\end_inset
- switch.) If the specified directory does not exist, LyX offers to create
- it for you, just like it does for the default directory on the first time
+ switch.) If the specified directory does not exist, \SpecialChar LyX
+ offers to create it
+ for you, just like it does for the default directory on the first time
you run the program.
You can modify the configuration options in this additional user directory
exactly as you would for the default directory.
which you want available from all your configurations, you must add it
to each directory separately.
- You can avoid this with the following trick: after LyX creates the additional
+ You can avoid this with the following trick: after \SpecialChar LyX
+ creates the additional
directory, most of the subdirectories (see above) are empty.
If you want the new configuration to mirror an existing one, replace the
empty subdirectory with a symbolic link to the matching subdirectory in
subdirectory, however, since it contains a file written by the configuration
script (also accessible through
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Reconfigure
\end_layout
\begin_layout Standard
The first step is to define your file formats if they are not already defined.
To do so, open the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\end_layout
dialog.
Under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File Handling\SpecialChar \menuseparator
+File Handling\SpecialChar menuseparator
File formats
\end_layout
\end_inset
press the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-New\SpecialChar \ldots{}
-
+New
\end_layout
\end_inset
button to define your new format.
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
field contains the name used to identify the format in the GUI.
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
You will also need to enter a file extension.
These are all required.
The optional
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
field is used to provide a keyboard shortcut on the menus.
(For example, pressing
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Alt-V F D
+Ctrl+D
\end_layout
\end_inset
will
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-View (Other Formats)\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+View (Other Formats)\SpecialChar menuseparator
DVI
\end_layout
\begin_layout Standard
A Format can have a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and an
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
associated with it.
For example, you might want to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
fields.
In defining this command, you can use the four variables listed in the
next section.
- The viewer is launched when you view an image in LyX or use the
-\begin_inset Flex MenuItem
+ The viewer is launched when you view an image in \SpecialChar LyX
+ or use the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
+Document\SpecialChar menuseparator
View
\end_layout
menu.
The editor is for example launched when you right-click on an image and
choose
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-
-\change_inserted -195340706 1329851811
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
.
- Therefore LyX uses the extended list of MIME types as specified by
+ Therefore \SpecialChar LyX
+ uses the extended list of MIME types as specified by
\begin_inset CommandInset href
LatexCommand href
name "freedesktop.org"
\begin_layout Standard
The
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- option tells LyX that a format is suitable for document export.
- If this is set and if a suitable conversion route exists (see sec.
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ option tells \SpecialChar LyX
+ that a format is suitable for document export.
+ If this is set and if a suitable conversion route exists (see
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Converters"
\end_inset
), the format will appear in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
Export
\end_layout
menu.
The format will also appear in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
+Document\SpecialChar menuseparator
View
\end_layout
\begin_layout Standard
The option
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- tells LyX that a format can contain vector graphics.
+ tells \SpecialChar LyX
+ that a format can contain vector graphics.
This information is used to determine the target format of included graphics
for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
export.
Included graphics may need to be converted to either
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, since
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
cannot handle other image formats.
If an included graphic is not already in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
format, it is converted to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
if the vector format option is set, and otherwise to
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-Since all conversions from one format to another take place in LyX's temporary
+Since all conversions from one format to another take place in \SpecialChar LyX
+'s temporary
directory, it is sometimes necessary to modify a file before copying it
to the temporary directory in order that the conversion may be performed.
\begin_inset Foot
\end_layout
\begin_layout Standard
-The definitions of the copiers may use four variables:
+The definitions of the copiers may use eight variables:
\end_layout
\begin_layout Labeling
\end_inset
- The LyX system directory (e.
+ The \SpecialChar LyX
+ system directory (e.
\begin_inset space \thinspace{}
\end_inset
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
The output file
-\change_inserted 1082167584 1348453985
-
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$b
+\end_layout
+
+\end_inset
-\change_inserted 1082167584 1348453986
-$$b The base name (without filename extension) in the LyX temporary directory
+ The base name (without filename extension) in the \SpecialChar LyX
+ temporary directory
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$p
+\end_layout
+
+\end_inset
-\change_inserted 1082167584 1348453986
-$$p The full directory path of the LyX temporary directory
+ The full directory path of the \SpecialChar LyX
+ temporary directory
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$r
+\end_layout
+
+\end_inset
-\change_inserted 1082167584 1348453986
-$$r The full pathname to the original LyX file being processed
+ The full pathname to the original \SpecialChar LyX
+ file being processed
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$f
+\end_layout
+
+\end_inset
-\change_inserted 1082167584 1348453986
-$$f The filename (without any directory path) of the LyX file.
+ The filename (without any directory path) of the \SpecialChar LyX
+ file.
\end_layout
\begin_layout Labeling
\end_inset
- The `LaTeX name'
-\change_inserted 1082167584 1348453720
-
+ The `\SpecialChar LaTeX
+ name'
\end_layout
\begin_layout Standard
-The latter should be the filename as it would be used in a LaTeX's
+The latter should be the filename as it would be used in a \SpecialChar LaTeX
+'s
\series bold
\backslash
\end_inset
-Save it in your local LyX directory—say,
+Save it in your local \SpecialChar LyX
+ directory—say,
\begin_inset Flex Code
status collapsed
—and make it executable, if you need to do so on your platform.
Then, in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Preferences
\end_layout
\end_inset
dialog, select under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File Handling\SpecialChar \menuseparator
+File Handling\SpecialChar menuseparator
File formats
\end_layout
\end_inset
the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
into the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-Copiers are used by LyX in various of its own conversions.
- For example, if appropriate programs are found, LyX will automatically
- install copiers for the
-\begin_inset Flex MenuItem
+Copiers are used by \SpecialChar LyX
+ in various of its own conversions.
+ For example, if appropriate programs are found, \SpecialChar LyX
+ will automatically install
+ copiers for the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
HTML file but various associated files (style files, images, etc.) are also
copied.
All these files are written to a subdirectory of the directory in which
- the original LyX file was found.
+ the original \SpecialChar LyX
+ file was found.
\begin_inset Foot
status collapsed
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, so HTML generated from
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
will end up in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
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 MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
Converters
\end_layout
\begin_layout Standard
To define a new converter, select the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
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 MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- The LyX system directory
+ The \SpecialChar LyX
+ system directory
\end_layout
\begin_layout Labeling
\begin_layout Standard
In the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- This converter runs some form of LaTeX.
- This will make LyX's LaTeX error logs available.
+ This converter runs some form of \SpecialChar LaTeX
+.
+ This will make \SpecialChar LyX
+'s \SpecialChar LaTeX
+ error logs available.
\end_layout
\begin_layout Labeling
\end_inset
- Needs the LaTeX
-\begin_inset Flex MenuItem
+ Needs the \SpecialChar LaTeX
+
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
file for the conversion.
-\change_inserted 1414654397 1337693117
-
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
-
-\change_inserted 1414654397 1337693188
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1414654397 1337693129
nice
-\change_unchanged
-
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
- file from the backend, which in practice means a LaTeX file like the one
- we would export, without
+ file from the backend, which in practice means a \SpecialChar LaTeX
+ file like the one we
+ would export, without
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 1414654397 1337693184
input@path
-\change_unchanged
-
\end_layout
\end_inset
.
-\change_unchanged
-
\end_layout
\begin_layout Labeling
\begin_layout Standard
The following three flags are not really flags at all because they take
an argument in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
The name of the directory in which the converter will dump the generated
files.
- LyX will not create this directory, and it does not copy anything into
- it, though it will copy this directory to the destination.
+ \SpecialChar 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 Code
status collapsed
\begin_layout Standard
None of these last three are presently used in any of the converters that
- are installed with LyX.
+ are installed with \SpecialChar LyX
+.
\end_layout
\begin_layout Standard
You do not have to define converters for all formats between which you want
to convert.
- For example, you will note that there is no `LyX to PostScript' converter,
- but LyX will export PostScript.
- It does so by first creating a LaTeX file (no converter needs to be defined
- for this) which is then converted to DVI using the `LaTeX to DVI' converter,
+ For example, you will note that there is no `\SpecialChar LyX
+ to PostScript' converter,
+ but \SpecialChar LyX
+ will export PostScript.
+ It does so by first creating a \SpecialChar LaTeX
+ file (no converter needs to be defined
+ for this) which is then converted to DVI using the `\SpecialChar LaTeX
+ to DVI' converter,
and finally converting the resulting DVI file to PostScript.
- LyX finds such `chains' of converters automatically, and it will always
- choose the shortest possible chain.
+ \SpecialChar LyX
+ finds such `chains' of converters automatically, and it will always choose
+ the shortest possible chain.
You can, though, still define multiple conversion methods between file
formats.
- For example, the standard LyX configuration provides three ways to convert
- LaTeX to PDF: Directly, using
-\begin_inset Flex MenuItem
+ For example, the standard \SpecialChar LyX
+ configuration provides five ways to convert
+ \SpecialChar LaTeX
+ to PDF:
+\end_layout
+
+\begin_layout Enumerate
+Directly, using
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-; via (DVI and) PostScript, using
-\begin_inset Flex MenuItem
+
+\end_layout
+
+\begin_layout Enumerate
+via (DVI and) PostScript, using
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-; or via DVI, using
-\begin_inset Flex MenuItem
+
+\end_layout
+
+\begin_layout Enumerate
+via DVI, using
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-.
- To define such alternate chains, you must define multiple target `file
- formats', as described in section
+
+\end_layout
+
+\begin_layout Enumerate
+directly using
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Xe\SpecialChar TeX
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Enumerate
+directly using
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Lua\SpecialChar TeX
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+To define such alternate chains, you must define multiple target `file formats',
+ as described in
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Formats"
.
For example, in the standard configuration, the formats named
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-,
-\begin_inset Flex MenuItem
+ (for
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+ps2pdf
+\end_layout
+
+\end_inset
+
+),
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-, and
-\begin_inset Flex MenuItem
+ (for
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+pdflatex
+\end_layout
+
+\end_inset
+
+),
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- are defined, all of which share the extension
-\begin_inset Flex MenuItem
+ (for
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+dvipdfm
+\end_layout
+
+\end_inset
+
+),
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+pdf4
+\end_layout
+
+\end_inset
+
+ (for
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Xe\SpecialChar TeX
+
+\end_layout
+
+\end_inset
+
+), and
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+pdf5
+\end_layout
+
+\end_inset
+
+ (for
+\begin_inset Flex Noun
+status collapsed
+
+\begin_layout Plain Layout
+Lua\SpecialChar TeX
+
+\end_layout
+
+\end_inset
+
+) are defined, all of which share the extension
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Chapter
-Internationalizing LyX
+Internationalizing \SpecialChar LyX
+
\begin_inset CommandInset label
LatexCommand label
name "cha:Internationalizing-LyX"
\end_layout
\begin_layout Standard
-LyX supports using a translated interface.
- Last time we checked, LyX provided text in thirty languages.
+\SpecialChar LyX
+ supports using a translated interface.
+ Last time we checked, \SpecialChar LyX
+ provided text in thirty languages.
The language of choice is called your
\emph on
locale
\begin_layout Plain Layout
If you are a fluent speaker of a language other than English, joining these
- teams is a great way to give back to the LyX community!
+ teams is a great way to give back to the \SpecialChar LyX
+ community!
\end_layout
\end_inset
- will of course try to fix these shortcomings in future versions of LyX.
+ will of course try to fix these shortcomings in future versions of \SpecialChar LyX
+.
\end_layout
\begin_layout Section
-Translating LyX
+Translating \SpecialChar LyX
+
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-LyX uses the GNU
+\SpecialChar LyX
+ uses the GNU
\begin_inset Flex Code
status collapsed
\end_inset
library to handle the internationalization of the interface.
- To have LyX speak your favorite language in all menus and dialogs, you
- need a
+ To have \SpecialChar LyX
+ speak your favorite language in all menus and dialogs, you need
+ a
\begin_inset Flex Code
status collapsed
.
It is possible to do this just for yourself, but if you're going to do
it, you might as well share the results of your labors with the rest of
- the LyX community.
- Send a message to the LyX developers' list for more information about how
+ the \SpecialChar LyX
+ community.
+ Send a message to the \SpecialChar LyX
+ developers' list for more information about how
to proceed.
\end_layout
\end_layout
\begin_layout Itemize
-Check out the LyX source code.
+Check out the \SpecialChar LyX
+ source code.
(See the
\begin_inset CommandInset href
LatexCommand href
name "information on the web"
-target "http://www.lyx.org/HowToUseSVN"
+target "http://www.lyx.org/HowToUseGIT"
\end_inset
\end_inset
- files, as well.
+ files, as well, see
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
+\backslash
+#PO-Mode
+\end_layout
+
+\end_inset
+
+.
\end_layout
\end_inset
\end_inset
--file could be added to the LyX distribution, so others can use it.
- Adding it involves making additional changes to LyX.
+ file could be added to the \SpecialChar LyX
+ distribution, so others can use it.
+ Adding it involves making additional changes to \SpecialChar LyX
+.
So send an email to the developers' mailing list if you're interested in
doing that.
\end_layout
message when no translation is used.
Therefore you have to put it in double square brackets at the end of the
message (see the example above).
- The translation mechanism of LyX ensures that everything in double square
+ The translation mechanism of \SpecialChar LyX
+ ensures that everything in double square
brackets at the end of messages is removed before displaying the message.
\end_layout
\begin_layout Standard
The online documentation (in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and the locale is set accordingly, these will be used automagically by
- LyX.
- LyX looks for translated versions as
+ \SpecialChar LyX
+.
+ \SpecialChar LyX
+ looks for translated versions as
\begin_inset Flex Code
status collapsed
\end_inset
(
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
+Help\SpecialChar menuseparator
Introduction
\end_layout
\end_inset
directory.
-\end_layout
+\begin_inset Note Greyedout
+status open
-\begin_layout Itemize
-Sometimes the original document (from the LyX-team) will be updated.
- Use the source viewer at
-\begin_inset CommandInset href
-LatexCommand href
-name "http://www.lyx.org/trac/timeline"
-target "http://www.lyx.org/trac/timeline"
+\begin_layout Plain Layout
+\series bold
+Note:
+\series default
+ For a complex document with external material (images, etc.), if you make
+ a copy e.
+\begin_inset space \thinspace{}
\end_inset
- to see what has been changed.
- That way you can easily see which parts of the translated document need
- to be updated.
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
+
+in a temp dir, beware that the links to external material may be broken
+ when the document is moved to a different place.
+ The best way is to retrieve the \SpecialChar LyX
+ tree from git (see
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.lyx.org/HowToUseGIT
+\end_layout
+
+\end_inset
+
+) and to edit the doc file in place.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+Sometimes the original document (from the \SpecialChar LyX
+ team) will be updated.
+ Use the source viewer at
+\begin_inset CommandInset href
+LatexCommand href
+name "http://www.lyx.org/trac/timeline"
+target "http://www.lyx.org/trac/timeline"
+
+\end_inset
+
+ to see what has been changed.
+ That way you can easily see which parts of the translated document need
+ to be updated.
+\end_layout
\begin_layout Standard
If you ever find an error in the original document, fix it and notify the
\end_inset
- marks comments, quotes start and end LaTeX-style commands.
+ marks comments, quotes start and end \SpecialChar LaTeX
+-style commands.
To enter quote, you'll need to use
\begin_inset Flex Code
status collapsed
\begin_layout Standard
An example of a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
statement to cause the symbol
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
to be output for the keystroke
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
Note that a
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\family default
\emph default
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
This allows you to press
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
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 MenuItem
+\begin_inset Flex Noun
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
+ The \SpecialChar LyX
+ distribution currently includes at least the
\begin_inset Flex Code
status collapsed
\begin_layout Standard
For example, in order to map
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-If LyX cannot find a mapping for the string produced by the keystroke or
- a deadkey sequence, it will check if it looks like an accented char and
- try to draw an accent over the character on screen.
+If \SpecialChar LyX
+ cannot find a mapping for the string produced by the keystroke or a
+ deadkey sequence, it will check if it looks like an accented char and try
+ to draw an accent over the character on screen.
\end_layout
\begin_layout Subsection
.
You could bind the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-] to the LyX command
+] to the \SpecialChar LyX
+ command
\begin_inset Flex Code
status collapsed
file.
Now, whenever you type the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Quotes erd
\end_inset
-, however, LyX will complain with a beep, since a
+, however, \SpecialChar LyX
+ will complain with a beep, since a
\begin_inset Quotes eld
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
never takes a circumflex accent.
Hitting
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
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 MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
One common way to bind dead-keys is to use
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
acts in some ways just like
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
- and then binding this symbolic key to the corresponding LyX command.
+ and then binding this symbolic key to the corresponding \SpecialChar LyX
+ command.
\begin_inset Foot
status collapsed
files.
I have my
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
symbolic keys bound such things as
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
key: One of the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
keys, a spare function key, etc.
- As for the LyX commands that produce accents, check the entry for
+ As for the \SpecialChar LyX
+ commands that produce accents, check the entry for
\begin_inset Flex Code
status collapsed
\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 MenuItem
+ is automatically configured when \SpecialChar LyX
+ starts up, via the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
+Edit\SpecialChar menuseparator
Preferences
\end_layout
\begin_layout Standard
In this chapter, we describe the procedures for creating and installing
- new LyX layout and template files, as well as offer a refresher on correctly
- installing new LaTeX document classes.
+ new \SpecialChar LyX
+ layout and template files, as well as offer a refresher on correctly
+ installing new \SpecialChar LaTeX
+ document classes.
\end_layout
\begin_layout Standard
First, let us a say a few words about how one ought to think about the relation
- between LyX and LaTeX.
- The thing to understand is that, in a certain sense, LyX doesn't know anything
- about LaTeX.
- Indeed, from LyX's point of view, LaTeX is just one of several
+ between \SpecialChar LyX
+ and \SpecialChar LaTeX
+.
+ The thing to understand is that, in a certain sense, \SpecialChar LyX
+ doesn't know anything
+ about \SpecialChar LaTeX
+.
+ Indeed, from \SpecialChar LyX
+'s point of view, \SpecialChar LaTeX
+ is just one of several
\begin_inset Quotes eld
\end_inset
in which it is capable of producing output.
Other such formats are DocBook, plaintext, and XHTML.
- LaTeX is, of course, a particularly important format, but very little of
- the information LyX has about LaTeX is actually contained in the program
- itself.
+ \SpecialChar LaTeX
+ is, of course, a particularly important format, but very little of the
+ information \SpecialChar LyX
+ has about \SpecialChar LaTeX
+ is actually contained in the program itself.
\begin_inset Foot
status collapsed
\begin_inset Quotes erd
\end_inset
- into LyX.
+ into \SpecialChar LyX
+.
But the developers generally regard this as a Bad Thing.
\end_layout
\end_inset
, is contained in `layout files'.
- Similarly, LyX itself does not know much about DocBook or XHTML.
+ Similarly, \SpecialChar LyX
+ itself does not know much about DocBook or XHTML.
What it knows is contained in layout files.
\end_layout
\begin_layout Standard
You can think of the layout file for a given document class as a translation
- manual between LyX constructs---paragraphs with their corresponding styles,
- certain sorts of insets, etc---and the corresponding LaTeX, DocBook, or
- XHTML constructs.
- Almost everything LyX knows about
+ manual between \SpecialChar LyX
+ constructs—paragraphs with their corresponding styles,
+ certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
+, DocBook, or XHTML
+ constructs.
+ Almost everything \SpecialChar LyX
+ knows about
\begin_inset Flex Code
status collapsed
\end_inset
- tells LyX how paragraphs that are marked with the Section, Subsection,
- etc, styles can be translated into corresponding LaTeX, DocBook, and XHTML
- commands and tags.
+ tells \SpecialChar LyX
+ how paragraphs that are marked with the Section, Subsection, etc,
+ styles can be translated into corresponding \SpecialChar LaTeX
+, DocBook, and XHTML commands
+ and tags.
The
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Standard
-Defining the LyX--LaTeX correspondence is not the only thing layout files
- do, though.
- Their other job is to define how the LyX constructs themselves will appear
+Defining the \SpecialChar LyX
+–\SpecialChar LaTeX
+ correspondence is not the only thing layout files do, though.
+ Their other job is to define how the \SpecialChar LyX
+ constructs themselves will appear
on-screen.
The fact that layout files have these two jobs is often a source of confusion,
because they are completely separate.
- Telling LyX how to translate a certain paragraph style into LaTeX does
- not tell LyX how to display it; conversely, telling LyX how to display
- a certain paragraph style does not tell LyX how to translate it into LaTeX
- (let alone tell LaTeX how to display it).
- So, in general, when you define a new LyX construct, you must always do
- two quite separate things: (i)
+ Telling \SpecialChar LyX
+ how to translate a certain paragraph style into \SpecialChar LaTeX
+ does not tell
+ \SpecialChar LyX
+ how to display it; conversely, telling \SpecialChar LyX
+ how to display a certain paragraph
+ style does not tell \SpecialChar LyX
+ how to translate it into \SpecialChar LaTeX
+ (let alone tell \SpecialChar LaTeX
+ how to
+ display it).
+ So, in general, when you define a new \SpecialChar LyX
+ construct, you must always do two
+ quite separate things: (i)
\begin_inset space ~
\end_inset
-tell LyX how to translate it into LaTeX and (ii)
+tell \SpecialChar LyX
+ how to translate it into \SpecialChar LaTeX
+ and (ii)
\begin_inset space ~
\end_inset
-tell LyX how to display it.
+tell \SpecialChar LyX
+ how to display it.
\end_layout
\begin_layout Standard
-Much the same is true, of course, as regards LyX's other backend formats,
- though XHTML is in some ways different, because in that case LyX
+Much the same is true, of course, as regards \SpecialChar LyX
+'s other backend formats, though
+ XHTML is in some ways different, because in that case \SpecialChar LyX
+
\emph on
is
\emph default
able, to some extent, to use information about how it should display a
paragraph on the screen to output information (in the form of CSS) about
how the paragraph should be displayed in a browser.
- Even in this case, however, the distinction between what LyX does internally
+ Even in this case, however, the distinction between what \SpecialChar LyX
+ does internally
and how things are rendered externally remains in force, and the two can
be controlled separately.
See
\end_layout
\begin_layout Section
-Installing new LaTeX files
+Installing new \SpecialChar LaTeX
+ files
\end_layout
\begin_layout Standard
-Some installations may not include a LaTeX package or class file that you
- would like to use within LyX.
- For example, you might need FoilTeX, a package for preparing slides for
- overhead projectors.
- Modern LaTeX distributions like TeXLive (2008 or newer) or MiKTeX provide
- a user interface for installing such packages.
- For example, with MiKTeX, you start the program
+Some installations may not include a \SpecialChar LaTeX
+ package or class file that you would
+ like to use within \SpecialChar LyX
+.
+ For example, you might need Foil\SpecialChar TeX
+, a package for preparing slides for overhead
+ projectors.
+ Modern \SpecialChar LaTeX
+ distributions like \SpecialChar TeX
+Live (2008 or newer) or MiK\SpecialChar TeX
+ provide a user interface
+ for installing such packages.
+ For example, with MiK\SpecialChar TeX
+, you start the program
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-If your LaTeX distribution does not provide such a `package manager', or
- if the package is not available from your distribution, then follow these
- steps to install it manually:
+If your \SpecialChar 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
\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
+ (is the case for Foil\SpecialChar TeX
+) then open a console, change to the folder of this
+ file and execute the command
\begin_inset Flex Code
status collapsed
.
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.
+ Most \SpecialChar 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.
+\begin_inset Separator latexpar
+\end_inset
+
+
\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.
+ for all users on your system, then install it in your `local' \SpecialChar TeX
+ tree, otherwise
+ install it in your own `user' \SpecialChar TeX
+ tree.
Where these trees should be created, if they do not already exist, depends
on your system.
To find this out, look in the file
\end_inset
- The location of the `local' TeX tree is defined by the
+ The location of the `local' \SpecialChar TeX
+ tree is defined by the
\begin_inset Flex Code
status collapsed
\end_inset
-.
- The location of the `user' TeX tree is defined by
+ or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
+Live
+ distribution.
+ The location of the `user' \SpecialChar TeX
+ tree is defined by
\begin_inset Flex Code
status collapsed
$HOME/texmf
\end_layout
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\family sans
+\lang french
+$HOME/.texliveXXXX
+\end_layout
+
\end_inset
.
\begin_layout Enumerate
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
+ your system, change to the folder where \SpecialChar LaTeX
+ is installed and then change to
+ the subfolder
\begin_inset Flex Code
status collapsed
\end_inset
.
- (For MiKTeX, this would be by default the folder
+ (For MiK\SpecialChar TeX
+, this would be by default the folder
\begin_inset Flex Code
status collapsed
.)
\begin_inset Foot
-status open
+status collapsed
\begin_layout Plain Layout
Note that this will be the correct path only on English installations.
\end_inset
If the package should only available for you or you don't have admin permissions
-, do the same, but in the local LaTeX folder.
+, do the same, but in the local \SpecialChar LaTeX
+ folder.
E.
\begin_inset space \thinspace{}
\end_inset
-g., for MiKTeX
+g., for MiK\SpecialChar TeX
+
\begin_inset space ~
\end_inset
\end_deeper
\begin_layout Enumerate
-Now one only need to tell LaTeX that there are new files.
- This depends on the used LaTeX-Distribution:
+Now one only need to tell \SpecialChar LaTeX
+ that there are new files.
+ This depends on the used \SpecialChar LaTeX
+-Distribution:
+\begin_inset Separator latexpar
+\end_inset
+
+
\end_layout
\begin_deeper
\begin_layout Enumerate
-For TeXLive execute the command
+For \SpecialChar TeX
+Live execute the command
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Enumerate
-For MiKTeX, if you have installed the package for all users, start the program
+For MiK\SpecialChar TeX
+, if you have installed the package for all users, start the program
\begin_inset Quotes eld
\end_inset
\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
+Finally, you need to tell \SpecialChar LyX
+ that there are new packages available.
+ So, in \SpecialChar LyX
+, use the menu
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Tools
\family sans
-\SpecialChar \menuseparator
+\SpecialChar menuseparator
Reconfigure
\end_layout
\end_inset
- and then restart LyX.
+ and then restart \SpecialChar LyX
+.
\end_layout
\begin_layout Standard
\begin_inset space ~
\end_inset
-(FoilTe
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-x)
+(FoilTex)
\end_layout
\end_inset
will now be available under
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Document Class
\end_layout
\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
+If you would like to use a \SpecialChar LaTeX
+ document class that is not even listed in the
+ menu
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Document Class
\end_layout
\end_layout
\begin_layout Standard
-This section describes the various sorts of LyX files that contain layout
- information.
+This section describes the various sorts of \SpecialChar LyX
+ files that contain layout informati
+on.
These files describe various paragraph and character styles, determining
- how LyX should display them and how they should be translated into LaTeX,
- DocBook, XHTML, or whatever output format is being used.
+ how \SpecialChar LyX
+ should display them and how they should be translated into \SpecialChar LaTeX
+, DocBook,
+ XHTML, or whatever output format is being used.
\end_layout
We shall try to provide a thorough description of the process of writing
layout files here.
However, there are so many different types of documents supported even
- by just LaTeX that we can't hope to cover every different possibility or
- problem you might encounter.
- The LyX users' list is frequented by people with lots of experience with
- layout design who are willing to share what they've learned, so please
- feel free to ask questions there.
+ by just \SpecialChar LaTeX
+ that we can't hope to cover every different possibility or problem
+ you might encounter.
+ The \SpecialChar LyX
+ users' list is frequented by people with lots of experience with layout
+ design who are willing to share what they've learned, so please feel free
+ to ask questions there.
\end_layout
\begin_layout Standard
As you prepare to write a new layout, it is extremely helpful to look at
- the layouts distributed with LyX.
- If you write a LyX layout for a LaTeX document class that might also be
- used by others, or write a module that might be useful to others, then
- you should consider posting your layout to the
+ the layouts distributed with \SpecialChar LyX
+.
+ If you write a \SpecialChar LyX
+ layout for a \SpecialChar LaTeX
+ document class that might also be used by
+ others, or write a module that might be useful to others, then you should
+ consider posting your layout to the
\begin_inset CommandInset href
LatexCommand href
name "layout section on the LyX wiki"
\end_inset
- or even to the LyX developers' list, so that it might be included in LyX
+ or even to the \SpecialChar LyX
+ developers' list, so that it might be included in \SpecialChar LyX
itself.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Note that LyX is licensed under the General Public License, so any material
- that is contributed to LyX must be similarly licensed.
+Note that \SpecialChar LyX
+ is licensed under the General Public License, so any material
+ that is contributed to \SpecialChar LyX
+ must be similarly licensed.
\end_layout
\end_inset
Layout modules
\begin_inset CommandInset label
LatexCommand label
-name "sub:Layout-modules"
+name "subsec:Layout-modules"
\end_inset
\end_inset
- extension and provide LyX with information about document classes.
- As of LyX 1.6, however, layout information can also be contained in layout
-
+ extension and provide \SpecialChar LyX
+ with information about document classes.
+ Since \SpecialChar LyX
+ 1.6 layout information can also be contained in layout
\emph on
modules
\emph default
\end_inset
extension.
- Modules are to LaTeX packages much as layouts are to LaTeX classes, and
- some modules—such as the
+ Modules are to \SpecialChar LaTeX
+ packages much as layouts are to \SpecialChar LaTeX
+ classes, and some modules—such
+ as the
\begin_inset Flex Code
status collapsed
requires editing that file.
Modules, by contrast, are selected in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
- folder, you will need to reconfigure and then restart LyX for the module
- to appear in the menu.
+ folder, you will need to reconfigure and then restart \SpecialChar LyX
+ for the module to
+ appear in the menu.
However, changes you make to the module will be seen immediately, if you
open
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
usly working on actual documents
\emph default
.
- Though of course the developers strive to keep LyX stable in such situations,
+ Though of course the developers strive to keep \SpecialChar LyX
+ stable in such situations,
syntax errors and the like in your module file could cause strange behavior.
\end_layout
\end_layout
\begin_layout Standard
-Modules are to LyX as packages are to LaTeX.
+Modules are to \SpecialChar LyX
+ as packages are to \SpecialChar 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
+ What you need is \SpecialChar LyX
+'s
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
You will find it under
\family sans
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Local Layout
\family default
.
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
+ (In \SpecialChar LyX
+ 2.1, the current layout format is 48.) You should be aware that local
+ layout is not supported by versions of \SpecialChar LyX
+ prior to 1.6, so you should not
+ use it if you want to be able to export your document to \SpecialChar 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.
+ 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 \SpecialChar LyX
+ 1.6.
\end_layout
\begin_layout Standard
\end_inset
- pane, LyX will enable the
+ pane, \SpecialChar LyX
+ will enable the
\begin_inset Quotes eld
\end_inset
\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
+ Clicking this button will cause \SpecialChar LyX
+ to determine whether what you have entered
+ is valid layout information for the chosen format.
+ \SpecialChar 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.
+ These will be written to the terminal, however, if \SpecialChar 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 Subsection
Layout for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
There are two situations you are likely to encounter when wanting to support
- a new LaTeX document class, involving style (
+ a new \SpecialChar LaTeX
+ document class, involving style (
\begin_inset Flex Code
status collapsed
\end_inset
-) files and LaTeX2e class (
+) files and \SpecialChar LaTeX2e
+ class (
\begin_inset Flex Code
status collapsed
document class.
For the sake of the example, we'll assume that the style file is called
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
and that it is meant to be used with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\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
+ and \SpecialChar LyX
+ allows you to specify your local directory on startup, too, using
the
\begin_inset Flex Code
status collapsed
\begin_layout LyX-Code
\backslash
-DeclareLaTeXClass{report}
+Declare\SpecialChar LaTeX
+Class{report}
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
\backslash
-DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
+Declare\SpecialChar LaTeX
+Class[report, myclass.sty]{report (myclass)}
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-Start LyX and select
-\begin_inset Flex MenuItem
+Start \SpecialChar LyX
+ and select
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Reconfigure
\end_layout
\end_inset
.
- Then restart LyX and try creating a new document.
+ Then restart \SpecialChar LyX
+ and try creating a new document.
You should see "
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
" as a document class option in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\begin_layout Standard
If
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout LyX-Code
-Format 21
+Format 35
\begin_inset Newline newline
\end_inset
\begin_layout Subsection
Layout for
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
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 MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-DeclareLaTeXClass
+Declare\SpecialChar LaTeX
+Class
\end_layout
\end_inset
\end_inset
-: LyX assumes that the document class has the same name as the layout file.
+: \SpecialChar LyX
+ assumes that the document class has the same name as the layout file.
\end_layout
\begin_layout LyX-Code
\backslash
-DeclareLaTeXClass[thesis,book]{thesis}
+Declare\SpecialChar LaTeX
+Class[thesis,book]{thesis}
\end_layout
\begin_layout Standard
layout.
We strongly suggest copying an existing layout file which uses a similar
- LaTeX class and then modifying it, if you can do so.
+ \SpecialChar LaTeX
+ class and then modifying it, if you can do so.
At least use an existing file as a starting point so you can find out what
items you need to worry about.
Again, the specifics are covered below.
Creating templates
\begin_inset CommandInset label
LatexCommand label
-name "sub:Creating-Templates"
+name "subsec:Creating-Templates"
\end_inset
for it, too.
A template acts as a kind of tutorial for your layout, showing how it might
be used, though containing dummy content.
- You can of course look at the various templates included with LyX for ideas.
+ You can of course look at the various templates included with \SpecialChar LyX
+ for ideas.
\end_layout
\begin_layout Standard
-Templates are created just like usual documents: using LyX.
+Templates are created just like usual documents: using \SpecialChar LyX
+.
The only difference is that usual documents contain all possible settings,
including the font scheme and the paper size.
Usually a user doesn't want a template to overwrite his preferred settings
\end_inset
- from the template LyX file.
+ from the template \SpecialChar LyX
+ file.
This can be done with any simple text-editor, for example
\begin_inset Flex Code
status collapsed
\end_inset
.
-
\end_layout
\begin_layout Standard
\end_inset
to the same place, and redefine the template path in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
Paths
\end_layout
.
This template is loaded every time you create a new document with
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-File\SpecialChar \menuseparator
+File\SpecialChar menuseparator
New
\end_layout
\end_inset
in order to provide useful defaults.
- To create this template from inside LyX, all you have to do is to open
- a document with the correct settings, and use the
-\begin_inset Flex MenuItem
+ To create this template from inside \SpecialChar LyX
+, all you have to do is to open a document
+ with the correct settings, and use the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-The format of layout files changes with each LyX release, so old layout
- files need to be converted to the new format.
- This process has been automated since LyX 1.4: If LyX reads a layout file
- in an older format, it automatically calls the script
+The format of layout files changes with each \SpecialChar LyX
+ release, so old layout files
+ need to be converted to the new format.
+ If \SpecialChar LyX
+ reads a layout file in an older format, it automatically calls the
+ script
\begin_inset Flex Code
status collapsed
to convert it to a temporary file in current format.
The original file is left untouched.
If you use the layout file often, then, you may want to convert it permanently,
- so that LyX does not have to do so itself every time.
+ so that \SpecialChar LyX
+ does not have to do so itself every time.
To do this, you can call the converter manually:
\end_layout
-\begin_layout LyX-Code
-mv myclass.layout myclass.old
+\begin_layout Enumerate
+rename the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+myclass.layout
\end_layout
-\begin_layout LyX-Code
+\end_inset
+
+ to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+myclass.old
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Enumerate
+Call the command
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
\end_layout
-\begin_layout Standard
-You need to replace
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+where
\begin_inset Flex Code
status collapsed
\end_inset
- with the name of your LyX system directory, of course.
+ is the name of your \SpecialChar LyX
+ system directory.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-When it's finally time to get your hands dirty and create or edit your own
- layout file, the following sections describe what you're up against.
- Our advice is to go slowly, save and test often, listen to soothing music,
- and enjoy one or two of your favorite adult beverages; more if you are
- getting particularly stuck.
- It's really not that hard, except that the multitude of options can become
- overwhelming if you try to do too much in one sitting.
- Go have another adult beverage, just for good measure.
+The following sections describe how layout files are structured and written.
+ Our advice is to go slowly, save and test often.
+ It is really not that hard, except that the multitude of options can become
+ overwhelming, especially if you try to check out too many at once.
+ It becomes easier if you use existing layouts of \SpecialChar LyX
+ as examples/reference
+ or if you modify an existing layout to your needs.
\end_layout
\begin_layout Standard
\end_inset
are really the same tag.
- The possible values are printed in brackets after the feature's name.
- The default value if a feature isn't specified inside a text class-description
- is typeset
+ The possible arguments are printed in brackets after the tag's name.
+ The default argument is typeset
\begin_inset Flex Code
status collapsed
\end_layout
\begin_layout Subsection
-The document class declaration
-\change_inserted -712698321 1349766602
- and classification
-\change_unchanged
-
+The document class declaration and classification
\end_layout
\begin_layout Standard
\end_inset
- files should begin with
-\change_deleted -712698321 1349766533
-a
-\change_unchanged
-line
-\change_inserted -712698321 1349766536
-s
-\change_unchanged
- like:
+ files should begin with lines like:
\end_layout
\begin_layout LyX-Code
\size small
#
\backslash
-DeclareLaTeXClass{
-\change_deleted -712698321 1349766193
-article
-\change_inserted -712698321 1349766201
-Article (Standard Class)
-\change_unchanged
-}
-\change_inserted -712698321 1349766538
-
+DeclareLaTeXClass{Article (Standard Class)}
\end_layout
\begin_layout LyX-Code
-\change_inserted -712698321 1349766581
-
\size small
#
\backslash
DeclareCategory{Articles}
-\change_unchanged
-
\end_layout
\begin_layout Standard
-The second
-\change_inserted -712698321 1349766695
-and third
-\change_unchanged
-line
-\change_inserted -712698321 1349766626
-s
-\change_unchanged
-
-\change_deleted -712698321 1349766628
-is
-\change_inserted -712698321 1349766628
-are
-\change_unchanged
- used when you (re)configure LyX.
- The layout file is read by the LaTeX script
+The second and third lines are used when you (re)configure \SpecialChar LyX
+.
+ The layout file is read by the \SpecialChar LaTeX
+ script
\begin_inset Flex Code
status collapsed
\end_inset
is ignored.
- The first line is just a LaTeX comment,
-\change_deleted -712698321 1349766656
-and
-\change_unchanged
-the second one contains the
-\change_inserted -712698321 1349766650
-mandatory
-\change_unchanged
-declaration of the text class
-\change_inserted -712698321 1349766689
-, and the third line contains the optional classification of the class
-\change_unchanged
-.
+ The first line is just a \SpecialChar LaTeX
+ comment, the second one contains the mandatory
+ declaration of the text class and the third line contains the optional
+ classification of the class.
If these lines appear in a file named
\begin_inset Flex Code
status collapsed
\end_inset
- (the name of the layout file) which uses the LaTeX document class
+ (the name of the layout file) which uses the \SpecialChar LaTeX
+ document class
\begin_inset Flex Code
status collapsed
\begin_inset Quotes eld
\end_inset
-
-\change_deleted -712698321 1349766253
-article
-\change_inserted -712698321 1349766260
Article (Standard Class)
-\change_unchanged
-
\begin_inset Quotes erd
\end_inset
that appears above is used as a description of the text class in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
dialog.
-
-\change_inserted -712698321 1349767097
The category (
\begin_inset Quotes eld
\end_inset
\end_inset
in the example) is also used in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1349766801
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\end_inset
group.
-\change_unchanged
-
\end_layout
\begin_layout Standard
\size small
#
\backslash
-DeclareLaTeXClass[article]{
-\change_deleted -712698321 1349766303
-a
-\change_inserted -712698321 1349766303
-A
-\change_unchanged
-rticle (with
-\change_deleted -712698321 1349766338
-m
-\change_inserted -712698321 1349766338
-M
-\change_unchanged
-y
-\change_deleted -712698321 1349766340
-o
-\change_inserted -712698321 1349766340
-O
-\change_unchanged
-wn
-\change_deleted -712698321 1349766343
-h
-\change_inserted -712698321 1349766343
-H
-\change_unchanged
-eadings)}
-\change_inserted -712698321 1349767223
-
+DeclareLaTeXClass[article]{Article (with My Own Headings)}
\end_layout
\begin_layout LyX-Code
-\change_inserted -712698321 1349767223
-
\size small
#
\backslash
DeclareCategory{Articles}
-\change_unchanged
-
\end_layout
\begin_layout Standard
\end_inset
-, associated with the LaTeX document class
+, associated with the \SpecialChar LaTeX
+ document class
\begin_inset Flex Code
status collapsed
\begin_inset Quotes eld
\end_inset
-
-\change_deleted -712698321 1349766329
-a
-\change_inserted -712698321 1349766329
-A
-\change_unchanged
-rticle (with
-\change_deleted -712698321 1349766347
-m
-\change_inserted -712698321 1349766347
-M
-\change_unchanged
-y
-\change_deleted -712698321 1349766350
-o
-\change_inserted -712698321 1349766350
-O
-\change_unchanged
-wn
-\change_deleted -712698321 1349766352
-h
-\change_inserted -712698321 1349766352
-H
-\change_unchanged
-eadings)
+Article (with My Own Headings)
\begin_inset Quotes erd
\end_inset
\size small
#
\backslash
-DeclareLaTeXClass[article,foo.sty]{
-\change_deleted -712698321 1349766366
-a
-\change_inserted -712698321 1349766366
-A
-\change_unchanged
-rticle (with
-\change_deleted -712698321 1349766369
-m
-\change_inserted -712698321 1349766369
-M
-\change_unchanged
-y
-\change_deleted -712698321 1349766371
-o
-\change_inserted -712698321 1349766371
-O
-\change_unchanged
-wn
-\change_deleted -712698321 1349766374
-h
-\change_inserted -712698321 1349766374
-H
-\change_unchanged
-eadings)}
-\change_inserted -712698321 1349767240
-
+DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
\end_layout
\begin_layout LyX-Code
-\change_inserted -712698321 1349767240
-
\size small
#
\backslash
DeclareCategory{Articles}
-\change_unchanged
-
\end_layout
\begin_layout Standard
\size small
#
\backslash
-DeclareDocBookClass[article]{SGML (DocBook
-\change_deleted -712698321 1349766387
-a
-\change_inserted -712698321 1349766387
-A
-\change_unchanged
-rticle)}
-\change_inserted -712698321 1349767247
-
+DeclareDocBookClass[article]{SGML (DocBook Article)}
\end_layout
\begin_layout LyX-Code
-\change_inserted -712698321 1349767302
-
\size small
#
\backslash
DeclareCategory{Articles (DocBook)}
-\change_unchanged
-
\end_layout
\begin_layout Standard
#
\backslash
DeclareLaTeXClass[class,package.sty]{layout description}
-\change_inserted -712698321 1349767329
-
\end_layout
\begin_layout LyX-Code
-\change_inserted -712698321 1349767339
-
\size small
#
\backslash
DeclareCategory{category}
-\change_unchanged
-
\end_layout
\begin_layout Standard
-The class need only be specified if the name of the LaTeX class file and
- the name of the layout file are different or if there are packages to load.
- If the name of the class file is not specified, then LyX will simply assume
+The class need only be specified if the name of the \SpecialChar LaTeX
+ class file and the
+ name of the layout file are different or if there are packages to load.
+ If the name of the class file is not specified, then \SpecialChar LyX
+ will simply assume
that it is the same as the name of the layout file.
\end_layout
\end_inset
, run
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
+Tools\SpecialChar menuseparator
Reconfigure
\end_layout
\end_inset
-, exit LyX and restart.
+, exit \SpecialChar LyX
+ and restart.
Then your new text class should be available along with the others.
\end_layout
\begin_layout Standard
Once the layout file is installed, you can edit it and see your changes
- without having to reconfigure or to restart LyX.
+ without having to reconfigure or to restart \SpecialChar LyX
+.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-In versions of LyX prior to 1.6, this was not true.
+In versions of \SpecialChar LyX
+ prior to 1.6, this was not true.
As a result, editing layout files was very time consuming, since you had
- constantly to restart LyX to see changes.
+ constantly to restart \SpecialChar LyX
+ to see changes.
\end_layout
\end_inset
- You can force a reload of the current layout by using the LyX function
-
-\begin_inset Flex MenuItem
+ You can force a reload of the current layout by using the \SpecialChar LyX
+ function
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Warning
\emph default
:
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
y working on a document that you care about.
Use a test document.
Syntax errors and the like in your layout file could cause peculiar behavior.
- In particular, such errors could cause LyX to regard the current layout
- as invalid and to attempt to switch to some other layout.
+ In particular, such errors could cause \SpecialChar LyX
+ to regard the current layout as
+ invalid and to attempt to switch to some other layout.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Really bad syntax errors may even caused LyX to exit.
- This is because certain sorts of errors may make LyX unable to read
+Really bad syntax errors may even caused \SpecialChar LyX
+ to exit.
+ This is because certain sorts of errors may make \SpecialChar LyX
+ unable to read
\emph on
any
\emph default
\end_inset
- The LyX team strives to keep LyX stable in such situations, but safe is
- better than sorry.
+ The \SpecialChar LyX
+ team strives to keep \SpecialChar LyX
+ stable in such situations, but safe is better
+ than sorry.
\begin_inset Foot
status collapsed
\begin_layout Standard
The mandatory argument, in curly brackets, is the name of the module, as
it should appear in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Modules
\end_layout
\end_inset
.
- The argument in square brackets is optional: It declares any LaTeX packages
+ The argument in square brackets is optional: It declares any \SpecialChar LaTeX
+ packages
on which the module depends.
- Please note that only packages about which LyX knows should be listed in
- the square brackets.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The list of such packages is documented only in the source code.
-\end_layout
-
-\end_inset
-
- LyX will not check for arbitrary packages.
It is also possible to use the form
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-Preferably in English if the module should be published with LyX.
+Preferably in English if the module should be published with \SpecialChar 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
\begin_layout Standard
The description is used in
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
+Settings\SpecialChar menuseparator
Modules
\end_layout
no
\emph default
excluded module may be used.
- Note that modules are identified here by their
-\emph on
-filenames
-\emph default
- without the
+ Note that modules are identified here by their filenames without the
\begin_inset Flex Code
status collapsed
\end_inset
-] The format of the layout file.
+] The format number of the layout file.
\end_layout
\begin_layout Standard
-This tag was introduced with LyX 1.4.0.
- Layout files from LyX 1.3.x and earlier don't have an explicit file format
- and are considered to be of format 1.
- The format for the present version of LyX is format 21.
- But each version of LyX is capable of reading earlier versions' layout
- files, just as they are capable of reading files produced by earlier versions
- of LyX.
+This tag was introduced with \SpecialChar LyX
+
+\begin_inset space ~
+\end_inset
+
+1.4.0.
+ Layout files from older \SpecialChar LyX
+ versions do not have an explicit file format and
+ are considered to have
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
+\begin_inset space ~
+\end_inset
+
+1
+\end_layout
+
+\end_inset
+
+.
+ The format for the present version of \SpecialChar LyX
+ is format 59.
+ But each version of \SpecialChar LyX
+ is capable of reading earlier versions' layout files,
+ just as they are capable of reading files produced by earlier versions
+ of \SpecialChar LyX
+.
There is, however, no provision for converting to earlier formats.
- So LyX 1.6.x will not read layout files in format 21 but only files in format
- 11 or earlier.
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
-name "sub:General-text-class"
+name "subsec:General-text-class"
\end_inset
\end_inset
- block when this document class is output to XHTML.
+ block when the document is output to XHTML.
Typically, this would be used to output CSS style information, but it can
be used for anything that can appear in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLStyles
-\end_layout
-
-\end_inset
-
- Adds CSS styling information.
- This will either be output in a
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
-\end_layout
-
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
- block or, if the user has so chosen, to a separate CSS file.Must end with
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-EndStyles
+AddToPreamble
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+ Adds information to the document preamble.
+ Must end with
+\begin_inset Newline newline
\end_inset
-.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-AddToPreamble
-\end_layout
-
-\end_inset
- Adds information to the document preamble.
- Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
Defines formats for use in the display of bibliographic information.
- See Section
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Citation-format-description"
+reference "subsec:Citation-format-description"
\end_inset
\end_inset
Describes various global options supported by the document class.
- See Section
-\begin_inset space ~
-\end_inset
-
-
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:ClassOptions"
+reference "subsec:ClassOptions"
\end_inset
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\emph default
to having one or two columns.
Can be changed in the
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
+Document\SpecialChar menuseparator
Settings
\end_layout
\begin_inset Newline newline
\end_inset
-See Section
-\begin_inset space ~
-\end_inset
-
-
+See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Counters"
+reference "subsec:Counters"
\end_inset
\end_inset
Sets the default font used to display the document.
- See Section
-\begin_inset space ~
-\end_inset
-
-
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Font-description"
+reference "subsec:Font-description"
\end_inset
status collapsed
\begin_layout Plain Layout
-string]
+<module>
\end_layout
\end_inset
- Specifies a module to be included by default with this document class.
- The module should be specified by filename without the
+] Specifies a module to be included by default with this document class.
+ The module is specified as filename without the
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-string
+<style>
\end_layout
\end_inset
] This is the style that will be assigned to new paragraphs, usually
-\begin_inset Flex MenuItem
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-string
+<module>
\end_layout
\end_inset
-] This tag indicates that the module in question—which should be specified
- by filename without the
+] This tag indicates that the module (which is specified by filename without
+ the
\begin_inset Flex Code
status collapsed
\end_inset
- extension—cannot be used with this document class.
+ extension) cannot be used with this document class.
This might be used in a journal-specific layout file to prevent, say, the
use of the
\begin_inset Flex Code
Modules have their own way of excluding other modules (see
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Layout-modules"
+reference "subsec:Layout-modules"
\end_inset
\end_inset
Defines a new float.
- See Section
-\begin_inset space ~
-\end_inset
-
-
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Floats"
+reference "subsec:Floats"
\end_inset
\end_inset
declarations.
- (Use
+ (Use
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
status collapsed
\begin_layout Plain Layout
-HTMLStyles
+HTMLTOCSection
\end_layout
\end_inset
- Sets CSS styling information.
- This will either be output in a
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\end_inset
+] The style to use for the table of contents, bibliography, and so forth,
+ when the document is output to HTML.
+ For articles, this should normally be
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Section
+\end_layout
-\begin_inset Quotes erd
\end_inset
- block or, if the user has so chosen, to a separate CSS file.
- Note that this will completely override any prior
+; for books
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyles
+Chapter
\end_layout
\end_inset
- or
+.
+ If it is not given, then \SpecialChar LyX
+ will attempt to figure out which layout to use.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLStyles
+IfCounter
\end_layout
\end_inset
- declarations.
- (Use
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLStyles
+<counter>
\end_layout
\end_inset
- if you just want to add material.) Must end with
+] Modifies the properties of the given counter.
+ If the counter does not exist, the statement is ignored.
+ Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndStyles
+End
\end_layout
\end_inset
\end_inset
.
+\begin_inset Newline newline
+\end_inset
+
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
+
+\end_inset
+
+ for details on counters.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTOCSection
+Input
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<filename>
\end_layout
\end_inset
-] The layout to use for the table of contents, bibliography, and so forth,
- when the document is output to HTML.
- For articles, this should normally be Section; for books, Chapter.
- If it is not given, then LyX will attempt to figure out which layout to
- use.
+] This allows you to include another layout definition file within yours
+ to avoid duplicating commands.
+ Common examples are the standard layout files, for example,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdclass.inc
+\end_layout
+
+\end_inset
+
+, which contains most of the basic layouts.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IfCounter
+InsetLayout
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<type>
\end_layout
\end_inset
-] Modifies the properties of the given counter.
- If the counter does not exist, the section is ignored.
+] This section (re-)defines the layout of an inset.
+ It can be applied to an existing inset or to a new, user-defined inset,
+ e.g., a new character style.
Must end with
\begin_inset Quotes eld
\end_inset
\begin_inset Newline newline
\end_inset
-See Section
-\begin_inset space ~
-\end_inset
-
-
+See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Counters"
+reference "subsec:Flex-insets-and"
\end_inset
- for details on counters.
+ for more information.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-IfStyle
+LeftMargin
\end_layout
\end_inset
\end_inset
-] Modifies the properties of the given paragraph style.
- If the style does not exist, the section is ignored.
- Must end with
+] A string that indicates the width of the left margin on the screen, for
+ example,
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+MMMMM
\end_layout
\end_inset
\end_inset
.
-\end_layout
+ (Note that this is not a `length', like
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+2ex
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Input
+.)
\end_layout
-\end_inset
-
- As its name implies, this command allows you to include another layout
- definition file within yours to avoid duplicating commands.
- Common examples are the standard layout files, for example,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdclass.inc
+ModifyStyle
\end_layout
\end_inset
-, which contains most of the basic layouts.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+<style>
\end_layout
\end_inset
- This section (re-)defines the layout of an inset.
- It can be applied to an existing inset or to a new, user-defined inset,
- e.g., a new character style.
+] Modifies the properties of the given paragraph style.
+ If the style does not exist, this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
-\begin_inset Newline newline
-\end_inset
-
-See Section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Flex-insets-and"
-
-\end_inset
-
- for more information.
-
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LeftMargin
+NoCounter
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<counter>
\end_layout
\end_inset
-] A string that indicates the width of the left margin on the screen, for
- example,
-\begin_inset Quotes eld
-\end_inset
-
-MMMMM
-\begin_inset Quotes erd
-\end_inset
-
-.
- (Note that this is not a `length', like
-\begin_inset Quotes eld
-\end_inset
-
-2ex
-\begin_inset Quotes erd
-\end_inset
-
-.)
+] Deletes an existing counter, usually one defined in an included file.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NoCounter
+NoFloat
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+<float>
\end_layout
\end_inset
-] This command deletes an existing counter, usually one defined in an included
- file.
+] Deletes an existing float.
+ This is particularly useful when you want to suppress a float that has
+ been defined in an input file.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NoFloat
+NoStyle
\end_layout
\end_inset
- This command deletes an existing float.
- This is particularly useful when you want to suppress a float that has
- been defined in an input file.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NoStyle
+<style>
\end_layout
\end_inset
- This command deletes an existing style.
- This is particularly useful when you want to suppress a style that has
- be defined in an input file.
+] Deletes an existing style.
\end_layout
\begin_layout Description
\end_inset
- A string indicating the file format (as defined in the Preferences dialog)
- produced by this class.
- It is mainly useful when
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+<format>
\end_layout
\end_inset
- is `literate' and one wants to define a new type of literate document.
- This string is reset to `docbook', `latex', or `literate' when the correspondin
-g
+] The file format (as defined in the \SpecialChar LyX
+ preferences) produced by this document
+ class.
+ It is mainly useful when
\begin_inset Flex Code
status collapsed
\end_inset
- parameter is encountered.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OutputType
+literate
\end_layout
\end_inset
- A string indicating what sort of output documents using this class will
- produce.
- At present, the options are: `docbook', `latex', and `literate'.
-\end_layout
+ and one wants to define a new type of literate document.
+ The format is reset to
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PageStyle
+docbook
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+ or
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-plain
+latex
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+ when the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-empty
+OutputType
\end_layout
\end_inset
-,
+ parameter is encountered.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-headings
+OutputType
\end_layout
\end_inset
-] The default pagestyle.
- Can be changed in the
-\begin_inset Flex MenuItem
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+
+\emph on
+lat
+\emph default
+ex
\end_layout
\end_inset
- dialog.
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+docbook
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+literate
\end_layout
\end_inset
- Sets the preamble for the LaTeX document.
- Note that this will completely override any prior
+] Specifies what sort of output documents using this class will produce.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+PackageOptions
\end_layout
\end_inset
- or
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+string
\end_layout
\end_inset
- declarations.
- (Use
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToPreamble
+string
\end_layout
\end_inset
- if you just want to add material to the preamble.) Must end with
+] Specifies options, given in the second string, for the package named by
+ the first string.
+ For example,
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-EndPreamble
+PackageOptions natbib square
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ will cause
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+natbib
\end_layout
\end_inset
- [
+ to be loaded with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+square
\end_layout
\end_inset
-] [
+ option.
+ (For \SpecialChar TeX
+perts, this causes \SpecialChar LyX
+ to output:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+PassOptionsToPackage{natbib}{square}
\end_layout
\end_inset
-,
+ prior to loading
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+natbib
\end_layout
\end_inset
-] Whether the class already provides the feature
+.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+PageStyle
\end_layout
\end_inset
-.
- A feature is in general the name of a package (
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-amsmath
+
+\emph on
+plain
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-makeidx
+empty
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) or a macro (
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-url
+headings
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+] The default pagestyle.
+ Can be changed in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-boldsymbol
+Document\SpecialChar menuseparator
+Settings
\end_layout
\end_inset
-,\SpecialChar \ldots{}
-); the complete list of supported features is unfortunately not documented
- outside the LyX source code—but see
+ dialog.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXFeatures.cpp
+Preamble
\end_layout
\end_inset
- if you're interested.
-
-\begin_inset Flex MenuItem
+ Sets the preamble for the \SpecialChar LaTeX
+ document.
+ Note that this will completely override any prior
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Help\SpecialChar \menuseparator
-LaTeX Configuration
+Preamble
\end_layout
\end_inset
- also gives an overview of the supported packages.
-\end_layout
-
-\begin_layout Description
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ProvidesModule
+AddToPreamble
\end_layout
\end_inset
- [
+ declarations.
+ (Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+AddToPreamble
\end_layout
\end_inset
-] Indicates that this layout provides the functionality of the module mentioned,
- which should be specified by the filename without the
+ if you just want to add material to the preamble.) Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.module
+EndPreamble
\end_layout
\end_inset
- extension.
- This will typically be used if the layout includes the module directly,
- rather than using the
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultModule
+Provides
\end_layout
\end_inset
- tag to indicate that it ought to be used.
- It could also be used in a module that provided an alternate implementation
- of the same functionality.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout Description
+\end_inset
+
+] [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Requires
+
+\emph on
+0
\end_layout
\end_inset
- [
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+1
\end_layout
\end_inset
-] Whether the class requires the feature
+] Whether the class already provides the feature
\begin_inset Flex Code
status collapsed
\end_inset
.
- Multiple features must be separated by commas.
- Note that you can only request supported features.
- (Again, see
+ A feature is in general the name of a package (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXFeatures.cpp
+amsmath
\end_layout
\end_inset
- for a list of these.)
-\end_layout
-
-\begin_layout Description
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+makeidx
\end_layout
\end_inset
- A string that indicates the width of the right margin on the screen, for
- example,
-\begin_inset Quotes eld
+) or a macro (e.
+\begin_inset space \thinspace{}
\end_inset
-MMMMM
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-.
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SecNumDepth
+url
\end_layout
\end_inset
- Sets which divisions get numbered.
- Corresponds to the
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-secnumdepth
+boldsymbol
\end_layout
\end_inset
- counter in LaTeX.
+).
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
+
+\end_inset
+
+ for the list of features.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Sides
+ProvidesModule
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+string
\end_layout
\end_inset
-,
+] Indicates that this layout provides the functionality of the module mentioned,
+ which should be specified by the filename without the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-2
+.module
\end_layout
\end_inset
-] Whether the class-default should be printing on one or both sides of the
- paper.
- Can be changed in the
-\begin_inset Flex MenuItem
+ extension.
+ This will typically be used if the layout includes the module directly,
+ rather than using the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Document\SpecialChar \menuseparator
-Settings
+DefaultModule
\end_layout
\end_inset
- dialog.
+ tag to indicate that it ought to be used.
+ It could also be used in a module that provided an alternate implementation
+ of the same functionality.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Style
+ProvideStyle
\end_layout
\end_inset
- This sequence defines a paragraph style.
- If the style does not yet exist, it is created; if it does exist, its parameter
-s are modified.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+] Creates a new paragraph style if it does not already exist.
+ If the style does exist, this section is ignored.
Must end with
\begin_inset Quotes eld
\end_inset
\end_inset
.
-\begin_inset Newline newline
-\end_inset
-
-See Section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Paragraph-Styles"
-
-\end_inset
-
- for details on paragraph styles.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+Requires
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="maketitle"
+string
\end_layout
\end_inset
-] The name of the command or environment to be used with
+] Whether the class requires the feature
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+string
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-TitleLatexType
-\end_layout
+ Multiple features must be separated by commas.
+ Note that you can only request supported features.
+ (See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
\end_inset
- [
+ for the list of features.).
+ If you require a package with specific options, you can additionally use
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-CommandAfter
+PackageOptions
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Environment
+.
\end_layout
-\end_inset
-
-] Indicates what kind of markup is used to define the title of a document.
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CommandAfter
+RightMargin
\end_layout
\end_inset
- means that the macro with name
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+string
\end_layout
\end_inset
- will be inserted after the last layout which has
+] A string that indicates the width of the right margin on the screen, for
+ example,
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-InTitle 1
+MMMMM
\end_layout
\end_inset
\end_inset
.
-
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+SecNumDepth
\end_layout
\end_inset
- corresponds to the case where the block of paragraphs which have
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InTitle 1
+int=3
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+] Sets which divisions get numbered.
+ Corresponds to the
+\begin_inset Newline newline
\end_inset
- should be enclosed into the
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+secnumdepth
\end_layout
\end_inset
- environment.
+ counter in \SpecialChar LaTeX
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TocDepth
+Sides
\end_layout
\end_inset
- Sets which divisions are included in the table of contents.
- Corresponds to the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tocdepth
+
+\emph on
+1
\end_layout
\end_inset
- counter in LaTeX.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Subsection
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+2
\end_layout
\end_inset
- section
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:ClassOptions"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex Code
+] Whether the class-default should be printing on one or both sides of the
+ paper.
+ Can be changed in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-ClassOptions
+Document\SpecialChar menuseparator
+Settings
\end_layout
\end_inset
- section can contain the following entries:
+ dialog.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-FontSize
+Style
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="10|11|12"
+<name>
\end_layout
\end_inset
-] The list of available font sizes for the document's main font, separated
- by
+] This sequence defines a paragraph style.
+ If the style does not yet exist, it is created; if it does exist, its parameter
+s are modified.
+ Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-|
+End
\end_layout
\end_inset
\end_inset
.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Header
-\end_layout
-
-\end_inset
-
- Used to set the DTD line with XML-based output classes.
- E.
-\begin_inset space \thinspace{}
+\begin_inset Newline newline
\end_inset
-g.: PUBLIC
-\begin_inset Quotes eld
-\end_inset
+See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
--//OASIS//DTD DocBook V4.2//EN
-\begin_inset Quotes erd
\end_inset
-.
+ for details on paragraph styles.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PageStyle
+TitleLatexName
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string="empty|plain|headings|fancy"
+string="maketitle"
\end_layout
\end_inset
-] The list of available page styles, separated by
-\begin_inset Quotes eld
-\end_inset
-
-
+] The name of the command or environment to be used with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-|
+TitleLatexType
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
status collapsed
\begin_layout Plain Layout
-Other
+TitleLatexType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+CommandAfter
\end_layout
\end_inset
-] Some document class options, separated by a comma, that will be added
- to the optional part of the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-documentclass
+Environment
\end_layout
\end_inset
- command.
+] Indicates what kind of markup is used to define the title of a document.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CommandAfter
\end_layout
-\begin_layout Standard
-The
+\end_inset
+
+ means that the macro with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ClassOptions
+TitleLatexName
\end_layout
\end_inset
- section must end with
+ will be inserted after the last layout which has
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-End
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
\end_layout
\end_inset
\end_inset
.
-\end_layout
+
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Paragraph styles
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Paragraph-Styles"
+\begin_layout Plain Layout
+Environment
+\end_layout
\end_inset
+ corresponds to the case where all layouts which have
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout Standard
-A paragraph style description looks like this:
-\begin_inset Foot
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that this will either define a new style or modify an existing one.
+InTitle
+\begin_inset space ~
+\end_inset
+
+1
\end_layout
\end_inset
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-Style
-\family roman
-\emph on
-name
-\end_layout
+ should be enclosed into the
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- ...
+\begin_layout Plain Layout
+TitleLatexName
\end_layout
-\begin_layout LyX-Code
-End
-\end_layout
+\end_inset
-\begin_layout Standard
-where the following commands are allowed:
+ environment.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Align
+TocDepth
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+int=3
+\end_layout
-\emph on
-block
-\emph default
-, left, right, center
+\end_inset
+
+] Sets which divisions are included in the table of contents.
+ Corresponds to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tocdepth
\end_layout
\end_inset
-] Paragraph alignment.
+ counter in \SpecialChar LaTeX
+.
\end_layout
-\begin_layout Description
+\begin_layout Subsection
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AlignPossible
+ClassOptions
\end_layout
\end_inset
- [
+ section
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:ClassOptions"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-block
-\emph default
-, left, right, center
+ClassOptions
\end_layout
\end_inset
-] A comma separated list of permitted alignments.
- (Some LaTeX styles prohibit certain alignments, since those wouldn't make
- sense.
- For example a right-aligned or centered enumeration isn't possible.)
-\change_inserted -712698321 1353679769
-
+ section can contain the following entries:
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1353680268
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353679781
-Argument
+FontSize
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353679772
-int
+string="10|11|12"
\end_layout
\end_inset
-] Defines argument number <int> of a command\SpecialChar \slash{}
-environment associated with
- the current style.
- This is useful for things like section headings, and only makes sense with
- LaTeX.
- Every (optional or required) argument of a command or environment -- except
- for the required argument that is associated with the content of the paragraph
- itself -- has a separate definition, where the number specifies the order
- of the arguments.
- The definition must end with
+] The list of available font sizes for the document's main font, separated
+ by
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680069
-EndArgument
+|
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
- So a command with two optional arguments has:
\end_layout
-\begin_deeper
-\begin_layout Quote
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\change_inserted -712698321 1353680127
+\begin_layout Plain Layout
+Header
+\end_layout
-\family typewriter
-Argument 1
-\end_layout
-
-\begin_layout Quote
-
-\change_inserted -712698321 1353680195
-
-\family typewriter
-...
-\end_layout
-
-\begin_layout Quote
-
-\change_inserted -712698321 1353680135
-
-\family typewriter
-EndArgument
-\end_layout
-
-\begin_layout Quote
-
-\change_inserted -712698321 1353680140
-
-\family typewriter
-Argument 2
-\end_layout
-
-\begin_layout Quote
-
-\change_inserted -712698321 1353680197
+\end_inset
-\family typewriter
-...
-\end_layout
+ Used to set the DTD line with XML-based output classes.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Quote
+g.: PUBLIC
+\begin_inset Quotes eld
+\end_inset
-\change_inserted -712698321 1353680147
+-//OASIS//DTD DocBook V4.2//EN
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-EndArgument
+.
\end_layout
-\begin_layout Standard
-
-\change_inserted -712698321 1353680528
-Inside the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680412
-Argument
+PageStyle
\end_layout
\end_inset
- definition, the following specifications are possible:
-\end_layout
-
-\begin_layout Itemize
-
-\change_inserted -712698321 1355076779
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680543
-LabelString
-\change_unchanged
-
+string="empty|plain|headings|fancy"
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680567
-[string]
-\end_layout
-
+] The list of available page sty\SpecialChar softhyphen
+les, separated by
+\begin_inset Quotes eld
\end_inset
- The string that will appear both in the menu (to insert this argument)
- and on the argument inset button (unless you also specify a separate
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355076779
-MenuString
+|
\end_layout
\end_inset
-).
- For the menu, you can define an accelerator by appending the respective
- character to the string, divided by
-\begin_inset Quotes eld
-\end_inset
-|
\begin_inset Quotes erd
\end_inset
- (e.
-\begin_inset space \thinspace{}
-\end_inset
+.
+\end_layout
-g.
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+Other
+\end_layout
-\change_inserted -712698321 1353691482
-\begin_inset Quotes eld
-\end_inset
-
-Short Title|S
-\begin_inset Quotes erd
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
-\change_unchanged
-
+\begin_layout Plain Layout
+string=""
\end_layout
\end_inset
-).
-\end_layout
-
-\begin_layout Itemize
-
-\change_inserted -712698321 1355076754
+] Some document class options, separated by a comma, that will be added
+ to the optional part of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1355076658
-MenuString
+\backslash
+documentclass
\end_layout
\end_inset
-
+ command.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355076654
-[string]
+ClassOptions
\end_layout
\end_inset
- A separate string for the menu.
- You can define an accelerator by appending the respective character to
- the string, divided by
+ section must end with
\begin_inset Quotes eld
\end_inset
-|
-\begin_inset Quotes erd
-\end_inset
-
- (e.
-\begin_inset space \thinspace{}
-\end_inset
-g.
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+End
+\end_layout
-\change_inserted -712698321 1355076654
-\begin_inset Quotes eld
\end_inset
-Short Title|S
+
\begin_inset Quotes erd
\end_inset
-
+.
\end_layout
-\end_inset
-
-).
- This specification is optional.
- If it is not given the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1355076736
-LabelString
-\change_unchanged
-
-\end_layout
+\begin_layout Subsection
+Paragraph styles
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Styles"
\end_inset
- will be used instead for the menu.
-\end_layout
-\begin_layout Itemize
+\end_layout
-\change_inserted -712698321 1353680665
-\begin_inset Flex Code
+\begin_layout Standard
+A paragraph style description looks like this:
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680616
-Tooltip
+Note that this will either define a new style or modify an existing one.
\end_layout
\end_inset
-
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
+\end_layout
-\change_inserted -712698321 1353680623
-[string]
+\begin_layout LyX-Code
+Style
+\family roman
+\emph on
+name
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ ...
+\end_layout
- A longer explanatory text that appears in the tooltip when hovering over
- the argument inset.
+\begin_layout LyX-Code
+End
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+where the following commands are allowed:
+\end_layout
-\change_inserted -712698321 1353680874
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680732
-Mandatory
+Align
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1353680738
-[int=0]
+\emph on
+block
+\emph default
+, left, right, center
\end_layout
\end_inset
- Declare if this is a mandatory
-\change_inserted 2090807402 1353765594
-(1)
-\change_inserted -712698321 1353680874
-or an optional
-\change_inserted 2090807402 1353765599
-(0)
-\change_inserted -712698321 1353680874
-argument.
- Mandatory arguments will be output empty if not given, while optional arguments
- will not be output at all.
- By default, mandatory arguments are delimited by
+] Paragraph alignment.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680808
-{...}
-\change_unchanged
-
+AlignPossible
\end_layout
\end_inset
-, while optional arguments are delimited by
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1353680833
-[...]
+\emph on
+block
+\emph default
+, left, right, center
\end_layout
\end_inset
-
+] A comma separated list of permitted alignments.
+ (Some \SpecialChar LaTeX
+ styles prohibit certain alignments, since those wouldn't make sense.
+ For example a right-aligned or centered enumeration isn't possible.)
\end_layout
-\begin_layout Itemize
-
-\change_inserted -712698321 1353917199
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680879
-Requires
+Argument
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353680874
-[int=0]
+int
\end_layout
\end_inset
- defines another argument (by its number) which this argument requires to
- be output if it is itself output.
- E.
-\begin_inset space \thinspace{}
-\end_inset
-
-g., in LaTeX commands, optional arguments often require previous optional
- arguments to be output (at least empty), as in
+] Defines argument number <int> of a command\SpecialChar breakableslash
+environment associated with
+ the current style.
+ This is useful for things like section headings, and only makes sense with
+ \SpecialChar LaTeX
+.
+ Every (optional or required) argument of a command or environment – except
+ for the required argument that is associated with the content of the paragraph
+ itself – has a separate definition, where the number specifies the order
+ of the arguments.
+ The definition must end with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353688183
-
-\backslash
-command[][arg]{text}
-\change_unchanged
-
+EndArgument
\end_layout
\end_inset
.
- This can be achieved by the statement
-\begin_inset Flex Code
-status collapsed
+ So a command with two optional arguments has:
+\begin_inset Separator latexpar
+\end_inset
-\begin_layout Plain Layout
-\change_inserted -712698321 1353681031
-Requires 1
-\change_unchanged
+\end_layout
+\begin_deeper
+\begin_layout Quote
+
+\family typewriter
+Argument 1
\end_layout
-\end_inset
+\begin_layout Quote
- within
-\begin_inset Flex Code
-status collapsed
+\family typewriter
+...
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Quote
-\change_inserted -712698321 1353681045
-Argument 2
-\change_unchanged
+\family typewriter
+EndArgument
+\end_layout
+
+\begin_layout Quote
+\family typewriter
+Argument 2
\end_layout
-\end_inset
+\begin_layout Quote
-.
+\family typewriter
+...
\end_layout
-\begin_layout Itemize
+\begin_layout Quote
+
+\family typewriter
+EndArgument
+\end_layout
-\change_inserted -712698321 1354263104
+\begin_layout Standard
+Inside the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+Argument
+\end_layout
-\change_inserted -712698321 1353681072
-LeftDelim
-\change_unchanged
+\end_inset
+ definition, the following specifications are possible:
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681067
[string]
\end_layout
\end_inset
- defines a custom left delimiter (instead of
+ The string that will appear both in the menu (to insert this argument)
+ and on the argument inset button (unless you also specify a separate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681127
-{
-\change_unchanged
-
+MenuString
\end_layout
\end_inset
- or
-\begin_inset Flex Code
-status collapsed
+).
+ For the menu, you can define an accelerator by appending the respective
+ character to the string, divided by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+|
+\begin_inset Quotes erd
+\end_inset
-\change_inserted -712698321 1353681133
-[
-\change_unchanged
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
+\begin_inset Quotes eld
\end_inset
-).
- A line break in the output can be indicated by
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1354263104
-<br/>
+Short Title|S
\end_layout
\end_inset
-.
-\change_unchanged
+\begin_inset Quotes erd
+\end_inset
+
+).
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1355144479
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681149
-RightDelim
+MenuString
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681146
[string]
\end_layout
\end_inset
- defines a custom right delimiter (instead of
-\begin_inset Flex Code
-status collapsed
+ A separate string for the menu.
+ You can define an accelerator by appending the respective character to
+ the string, divided by
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+|
+\begin_inset Quotes erd
+\end_inset
-\change_inserted -712698321 1353681158
-}
-\end_layout
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
- or
+
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681161
-]
+Short Title|S
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
).
- A line break in the output can be indicated by
+ This specification is optional.
+ If it is not given the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1354263106
-<br/>
+LabelString
\end_layout
\end_inset
-.
+ will be used instead for the menu.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1355144578
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355144487
-PresetArg
-\change_unchanged
-
+Tooltip
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355144500
[string]
\end_layout
\end_inset
- defines an argument that is inserted in any case (alone or in addition
- to user-specified arguments).
- Multiple arguments need to be separated by comma.
-\change_unchanged
-
+ A longer explanatory text that appears in the tooltip when hovering over
+ the argument inset.
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353917320
-Font
+Mandatory
\end_layout
\end_inset
- The font used for the argument content.
- See section
-\begin_inset space ~
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\emph on
+0
+\end_layout
\end_inset
-.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Itemize
-\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353917320
-LabelFont
+1
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
+] Declare if this is a mandatory (1) or an optional (0) argument.
+ Mandatory arguments will be output empty if not given, while optional arguments
+ will not be output at all.
+ By default, mandatory arguments are delimited by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+{...}
+\end_layout
+
\end_inset
+, while optional arguments are delimited by
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+[...]
+\end_layout
\end_inset
-.
+
\end_layout
\begin_layout Itemize
-
-\change_inserted -712698321 1353917320
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353917320
-Decoration
+Requires
\end_layout
\end_inset
- can be
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353917320
-Classic
+[int=0]
\end_layout
\end_inset
-,
+ defines another argument (by its number) which this argument requires to
+ be output if it is itself output.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., in \SpecialChar LaTeX
+ commands, optional arguments often require previous optional arguments
+ to be output (at least empty), as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1353917320
-Minimalistic
+\backslash
+command[][argument]{text}
\end_layout
\end_inset
-, or
+.
+ This can be achieved by the statement
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353917320
-Conglomerate
+Requires 1
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Default is
+ within
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353917320
-Classic
+Argument 2
\end_layout
\end_inset
.
-\change_inserted 155139281 1354198988
-
\end_layout
-\begin_layout Standard
-
-\change_inserted 155139281 1354199102
-Arguments for list
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 155139281 1354199013
-
-\backslash
-item
-\change_unchanged
-
+LeftDelim
\end_layout
\end_inset
-s (as in
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 155139281 1354199102
-
-\backslash
-item[foo]
-\change_unchanged
-
+[string]
\end_layout
\end_inset
-) have the prefix
+ defines a custom left delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 155139281 1354199044
-item:
-\change_unchanged
-
+{
\end_layout
\end_inset
- followed by the number (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 155139281 1354199064
-Argument item:1
-\change_unchanged
-
+[
\end_layout
\end_inset
-)
-\change_unchanged
-
-\end_layout
-
-\end_deeper
-\begin_layout Description
+).
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+<br/>
\end_layout
\end_inset
- Note that this will completely override any prior
+.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+RightDelim
\end_layout
\end_inset
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndBabelPreamble
+[string]
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:I18n"
-
-\end_inset
-
- for details on its use.
-\end_layout
-
-\begin_layout Description
+ defines a custom right delimiter (instead of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BottomSep
+}
\end_layout
\end_inset
- [
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+]
\end_layout
\end_inset
-]
-\begin_inset Foot
+).
+ A line break in the output can be indicated by
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that a `float' here is a real number, such as: 1.5.
+<br/>
\end_layout
\end_inset
- The vertical space with which the last of a chain of paragraphs with this
- style is separated from the following paragraph.
- If the next paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Category
+DefaultArg
\end_layout
\end_inset
\end_inset
- The category for this style.
- This is used to group related styles in the style combobox on the toolbar.
- Any string can be used, but you may want to use existing categories with
- your own styles.
-
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-CommandDepth
-\end_layout
+ defines an argument that is inserted if and only if no user-specified arguments
+ were given, i.
+\begin_inset space \thinspace{}
+\end_inset
+e.
+\begin_inset space \space{}
\end_inset
- Depth of XML command.
- Used only with XML-type formats.
+if no argument inset has been inserted (note that also an empty argument
+ inset omits the DefaultArg).
+ Multiple arguments need to be separated by comma.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+PresetArg
\end_layout
\end_inset
\end_inset
- Copies all the features of an existing style into the current one.
-
+ defines an argument that is inserted in any case (alone or in addition
+ to user-specified arguments).
+ Multiple arguments need to be separated by comma.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DependsOn
+Font
\end_layout
\end_inset
- The name of a style whose preamble should be output
-\emph on
-before
-\emph default
- this one.
- This allows to ensure some ordering of the preamble snippets when macros
- definitions depend on one another.
-\begin_inset Foot
+ The font used for the argument content, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that, besides that functionality, there is no way to ensure any ordering
- of preambles.
- The ordering that you see in a given version of LyX may change without
- warning in later versions.
+LabelFont
\end_layout
\end_inset
+ The font used for the label; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabeltype
+Decoration
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-No_Label
+Classic
\emph default
-, Box, Filled_Box, Static
+, Minimalistic, Conglomerate
\end_layout
\end_inset
-] The type of label that stands at the end of the paragraph (or sequence
- of paragraphs if
+] describes the rendering style used for the inset's frame and buttons.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+AutoInsert
\end_layout
\end_inset
- is
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+[int=0]
\end_layout
\end_inset
-,
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+1
\end_layout
\end_inset
- or
+, this argument is automatically inserted when the respective style is selected.
+ Currently, only one argument per style\SpecialChar breakableslash
+layout can be automatically inserted.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+InsertCotext
\end_layout
\end_inset
-).
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-No_Label
+[int=0]
\end_layout
\end_inset
- means
-\begin_inset Quotes eld
-\end_inset
-
-nothing
-\begin_inset Quotes erd
-\end_inset
-
-,
+ If this is set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+1
\end_layout
\end_inset
- (resp.
+, this argument will be inserted with a copy of the co-text (either selected
+ text or the whole paragraph) as content.
+\end_layout
+
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\begin_inset space ~
-\end_inset
-
-Filled_Box
+PassThruChars
\end_layout
\end_inset
-) is a white (resp.
-\begin_inset space ~
-\end_inset
-
-black) square suitable for end of proof markers,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+string of characters
\end_layout
\end_inset
- is an explicit text string.
+]
+\family typewriter
+
+\family default
+Defines individual characters that should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
+ Note that, contrary to PassThru, this needs to be explicitly defined for
+ arguments.
+ That is, arguments do not inherit PassThruChars from their parent inset
+ or layout.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+By default, the text entered in the \SpecialChar LyX
+ workarea in the respective layout is
+ the last (mandatory) argument of a command if the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelString
+LatexType
\end_layout
\end_inset
- [
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Command
\end_layout
\end_inset
-] The string used for a label with a
+.
+ However, arguments with the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+post:
\end_layout
\end_inset
-
+ are output after this workarea argument.
+ Note that post-argument numbering restarts at 1, so the first argument
+ following the workarea argument is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLabelType
+post:1
\end_layout
\end_inset
.
-
-\end_layout
-
-\begin_layout Description
+ Post-arguments are ignored in any other
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+LatexType
\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
-
+ than
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+\begin_layout Plain Layout
+Command
+\end_layout
\end_inset
.
- Note that defining this font automatically defines the
+\end_layout
+
+\begin_layout Standard
+Arguments for list
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\backslash
+item
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+s (as in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\backslash
+item[foo]
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+) have the prefix
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+item:
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
+ followed by the number (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-[
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Argument item:1
\end_layout
\end_inset
-,
+).
+\end_layout
+
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+BabelPreamble
\end_layout
\end_inset
-] Usually LyX doesn't allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example, when typing
- program code or plain LaTeX code.
- For this reason,
+ Note that this will completely override any prior
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+BabelPreamble
\end_layout
\end_inset
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
-\end_layout
+ declaration for this style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+EndBabelPreamble
\end_layout
\end_inset
- These tags are used with XHTML output.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Paragraph-Style-XHTML"
+reference "subsec:I18n"
\end_inset
-.
+ for details on its use.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InnerTag
+BottomSep
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InPreamble
+float=0
\end_layout
\end_inset
-
-\begin_inset Flex Code
+]
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-[1, 0]
+Note that a `float' here is a real number, such as: 1.5.
\end_layout
\end_inset
- If 1, marks the style as to be included in the document preamble rather
- than in the document body.
- This is useful for document classes that want such information as the title
- and author to appear in the preamble.
- Note that this works only for styles for which the
+ The vertical space with which the last of a chain of paragraphs with this
+ style is separated from the following paragraph.
+ If the next paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Category
\end_layout
\end_inset
- is
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+string
\end_layout
\end_inset
- or
+] The category for this style.
+ This is used to group related styles in the style combobox on the toolbar.
+ Any string can be used, but you may want to use existing categories with
+ your own styles.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+CommandDepth
\end_layout
\end_inset
-.
+ Depth of XML command.
+ Used only with XML-type formats.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InTitle
+CopyStyle
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[1, 0]
+string
\end_layout
\end_inset
- If 1, marks the style as being part of a title block (see also the
+] Copies all the features of an existing style into the current one.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+DependsOn
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TitleLatexName
+<name>
\end_layout
\end_inset
- global entries).
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
+] The name of a style whose preamble should be output
+\emph on
+before
+\emph default
+ this one.
+ This allows to ensure some ordering of the preamble snippets when macros
+ definitions depend on one another.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-ItemSep
+Note that, besides that functionality, there is no way to ensure any ordering
+ of preambles.
+ The ordering that you see in a given version of \SpecialChar LyX
+ may change without warning
+ in later versions.
\end_layout
\end_inset
- [
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+EndLabeltype
\end_layout
\end_inset
-] This provides extra space between paragraphs that have the same style.
- If you put other styles into an environment, each is separated with the
- environment's
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parsep
+
+\emph on
+No_Label
+\emph default
+, Box, Filled_Box, Static
\end_layout
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+] The type of label that stands at the end of the paragraph (or sequence
+ of paragraphs if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+LatexType
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
-\end_layout
+ is
+\begin_inset Newline newline
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ItemTag
+Environment
\end_layout
\end_inset
- [[FIXME]] (Used only with XML-type formats.)
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+Item_Environment
\end_layout
\end_inset
- [
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+List_Environment
\end_layout
\end_inset
-,
+).
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+No_Label
\end_layout
\end_inset
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a style can be used
- as some kind of break, which does not contain actual text.
-\end_layout
+ means
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
+nothing
+\begin_inset Quotes erd
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+Box
\end_layout
\end_inset
- [float=0] The vertical space between the label and the text body.
- Only used for labels that are above the text body (
+ (resp.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+Filled_Box
\end_layout
\end_inset
-,
+) is a white (resp.
+\begin_inset space ~
+\end_inset
+
+black) square suitable for end of proof markers,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+Static
\end_layout
\end_inset
-).
+ is an explicit text string.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelCounter
+EndLabelString
\end_layout
\end_inset
\end_inset
-]
-\begin_inset Newline newline
+] The string used for a label with a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Static
+\end_layout
+
\end_inset
-The name of the counter for automatic numbering.
-
+
\begin_inset Newline newline
\end_inset
-This
-\emph on
-must
-\emph default
- be given if
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+EndLabelType
\end_layout
\end_inset
- is
+.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+Font
\end_layout
\end_inset
-.
- In that case, the counter will be stepped each time the style appears.
-
-\begin_inset Newline newline
-\end_inset
-
-This
+ The font used for both the text body
\emph on
-may
+and
\emph default
- also be given if
+ the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+LabelFont
\end_layout
\end_inset
- is
+ to the same value.
+ So you should define this one first if you also want to define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+LabelFont
\end_layout
\end_inset
-, though this case is a bit complicated.
- Suppose you declare
-\begin_inset Quotes eld
-\end_inset
-
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter myenum
+ForceLocal
\end_layout
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+int=0
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- Then the actual counters used are
+] Used for backporting new styles to stable \SpecialChar LyX
+ versions.
+ The first stable version that supports this tag is \SpecialChar LyX
+ 2.1.0.
+ The argument is a number which may either be 0, -1 or any value greater
+ than zero.
+ If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumi
+ForceLocal
\end_layout
\end_inset
-,
+ flag of a style is greater than zero, it will always be written to the
+ document header.
+ If a .lyx file is read, the style definitions from the document header are
+ added to the document class.
+ Therefore even older \SpecialChar LyX
+ versions can handle the style.
+ The argument of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumii
+ForceLocal
\end_layout
\end_inset
-,
+ is a version number: if the style is read, and the version number is less
+ than the version number of the already existing style in the document class,
+ the new style is ignored.
+ If the version number is greater, the new style replaces the existing style.
+ A value of -1 means an infinite version number, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e.
+\begin_inset space \space{}
+\end_inset
+
+the style is always used.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiii
+FreeSpacing
\end_layout
\end_inset
-, and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-myenumiv
+
+\emph on
+0
\end_layout
\end_inset
-, much as in LaTeX.
- These counters must all be declared separately.
-\begin_inset Newline newline
+,
+\begin_inset space \thinspace{}
\end_inset
-See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-\end_inset
+\begin_inset Flex Code
+status collapsed
- for details on counters.
+\begin_layout Plain Layout
+1
\end_layout
-\begin_layout Description
+\end_inset
+
+] Usually \SpecialChar LyX
+ does not allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain \SpecialChar LaTeX
+ code.
+ For this reason,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+FreeSpacing
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
+ can be enabled.
+ Note that \SpecialChar LyX
+ will create protected blanks for the additional blanks when
+ in another mode than \SpecialChar LaTeX
+-mode.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTML*
+\end_layout
+\end_inset
+ These tags are used with XHTML output.
+ See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Font-description"
+reference "subsec:Paragraph-Style-XHTML"
\end_inset
status collapsed
\begin_layout Plain Layout
-LabelIndent
+InnerTag
\end_layout
\end_inset
- Text that indicates how far a label should be indented.
+ [FIXME] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Labelsep
+InPreamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+
+\emph on
+0
\end_layout
\end_inset
-] The horizontal space between the label and the text body.
- Only used for labels that are not above the text body.
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
- [
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+1
\end_layout
\end_inset
-] The string used for a label with a
+, marks the style as to be included in the document preamble and not in
+ the document body.
+ This is useful for document classes that want such information as the title
+ and author to appear in the preamble.
+ Note that this works only for styles for which the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LatexType
\end_layout
\end_inset
- labeltype.
- When
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+Command
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Paragraph
+\end_layout
\end_inset
.
-\begin_inset Foot
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+InTitle
+\end_layout
+
+\end_inset
+
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-@
+
\emph on
-style-name
-\emph default
-@
+0
\end_layout
\end_inset
- will be replaced by the expanded
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+1
\end_layout
\end_inset
- of style
+] If
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
+1
\end_layout
\end_inset
-.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
+, 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_inset
-
+ global entries).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+ItemCommand
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+string="item"
+\end_layout
+
+\end_inset
+
+] The \SpecialChar LaTeX
+ command sequence declaring an item in a list.
+ The command is to be defined without the preceding backslash (the default
+ is
+\begin_inset Quotes eld
+\end_inset
+
+item
+\begin_inset Quotes erd
+\end_inset
+
+, resulting in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+item
\end_layout
\end_inset
-] This is used inside the appendix instead of
+ in the \SpecialChar LaTeX
+ output).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+ItemSep
\end_layout
\end_inset
-.
- Note that every
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+float=0
\end_layout
\end_inset
- statement resets
+] This provides extra space between paragraphs that have the same style.
+ If you put other styles into an environment, each is separated with the
+ environment's
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+ParSep
\end_layout
\end_inset
- too.
+.
+ But the whole items of the environment are additionally separated with
+ this
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ItemSep
+\end_layout
+
+\end_inset
+
+.
+ Note that this is a
+\emph on
+ multiplier.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelTag
+ItemTag
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LabelType
+KeepEmpty
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment, Centered_Top_Environment, Counter, Sensitive,
- Enumerate, Itemize, Bibliography
+0
\end_layout
\end_inset
-]
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\begin_deeper
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+1
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
- Use protected spaces (like
-\begin_inset space ~
-\end_inset
-
-that one) if you want more than one word as the label.
-
+] Usually \SpecialChar LyX
+ does not allow you to leave a paragraph empty, since it would
+ lead to empty \SpecialChar LaTeX
+ output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a style can be used
+ as some kind of break, which does not contain actual text.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LabelBottomsep
\end_layout
\end_inset
- means the label is simply whatever
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+float=0
\end_layout
\end_inset
- declares it to be.
- Note that this really is `static'.
-\end_layout
-
-\begin_layout Itemize
+] The vertical space between the label and the text body.
+ Only used for labels that are above the text body (
\begin_inset Flex Code
status collapsed
\end_inset
- and
+ and
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
- are special cases of
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LabelCounter
\end_layout
\end_inset
-.
- The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this style.
- This might be used with the
-\begin_inset Flex MenuItem
+ [
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Abstract
+string=""
\end_layout
\end_inset
- style, for example.
-\end_layout
-
-\begin_layout Itemize
+] The name of the counter for automatic numbering.
+ In order to have the counter appear with your label, you will need to reference
+ it in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
-\end_layout
-
-\end_inset
-
- is a special case for the caption-labels
-\begin_inset Quotes eld
-\end_inset
-
-Figure
-\begin_inset Quotes erd
-\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
+LabelString
+\end_layout
-Table
-\begin_inset Quotes erd
\end_inset
.
-
+ This will work with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+LabelType
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float: It is
- hardcoded to be `FloatType N', where N is the value of the counter associated
- with the float.
-\end_layout
-
-\begin_layout Itemize
-The
+s,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Counter
+Static
\end_layout
\end_inset
- label type defines automatically numbered labels.
- The
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Above
\end_layout
\end_inset
- will be expanded to resolve any counter references it contains: For example,
- it might be
-\begin_inset Quotes eld
-\end_inset
-
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Section
-\backslash
-thechapter.
-\backslash
-thesection
+Centered
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Counters"
-
+, at least.
+\begin_inset Newline newline
\end_inset
- for more information on counters.
-\end_layout
-
-\begin_layout Itemize
+This
+\emph on
+may
+\emph default
+ also be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Enumerate
+LabelType
\end_layout
\end_inset
- produces the usual sort of enumeration labels.
- At present, it is hardcoded to use Arabic numerals, lowercase letters,
- small Roman numerals, and uppercase letters for the four possible depths.
-\end_layout
-
-\begin_layout Itemize
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Itemize
+Enumerate
\end_layout
\end_inset
- produces various bullets at the different levels.
- It is also hardcoded.
-\end_layout
+, though this case is a bit complicated.
+ Suppose you declare
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+LabelCounter myenum
\end_layout
\end_inset
- is used internally by LyX and should be used only with
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Then the actual counters used are
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType BibEnvironment
+myenumi
\end_layout
\end_inset
-.
-\end_layout
-
-\end_deeper
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+myenumii
\end_layout
\end_inset
- Note that this will completely override any prior
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+myenumiii
\end_layout
\end_inset
- declaration for this style.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndLangPreamble
+myenumiv
\end_layout
\end_inset
-
-\begin_inset Quotes erd
+, much as in \SpecialChar LaTeX
+.
+ These counters must all be declared separately.
+\begin_inset Newline newline
\end_inset
-.
- See section
+See
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:I18n"
+reference "subsec:Counters"
\end_inset
- for details on its use.
+ for details on counters.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexName
+LabelFont
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
+ The font used for the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexParam
+LabelIndent
\end_layout
\end_inset
- An optional parameter for the corresponding
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+string=""
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within LyX
-\change_inserted -712698321 1355144804
- (use
+] Text that indicates how far a label should be indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355144804
-Argument
+LabelSep
\end_layout
\end_inset
- for customizable parameters)
-\change_unchanged
-.
-
-\change_inserted -712698321 1355144804
- This will be output as is after all LaTeX
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355144658
-Arguments
-\change_unchanged
-
+string=""
\end_layout
\end_inset
-.
-\change_unchanged
-
+] Text that indicates the amount of horizontal space between the label and
+ the text body.
+ Only used for labels that are not above the text body.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelString
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
-\end_layout
-
-\end_inset
-
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-List_Environment, Bib_Environment
+string=""
\end_layout
\end_inset
-] How the style should be translated into LaTeX.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
+] The string used for the label.
+ When
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelCounter
\end_layout
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
-\end_layout
+ is set, this string can be contain the special formatting commands described
+ in
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Counters"
\end_inset
-
+.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+LabelStringAppendix
\end_layout
\end_inset
- means nothing special.
-
-\end_layout
-
-\begin_layout Itemize
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+string=""
\end_layout
\end_inset
- means
+] This is used inside the appendix instead of
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
+LabelString
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Itemize
+ Note that every
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelString
\end_layout
\end_inset
- means
+ statement resets
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+LabelStringAppendix
\end_layout
\end_inset
-.
-
+ too.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+LabelTag
\end_layout
\end_inset
- is the same as
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelType
\end_layout
\end_inset
-, except that an
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\backslash
-item
+\emph on
+No_Label
+\emph default
+, Manual, Static, Above,
+\begin_inset Newline newline
+\end_inset
+
+Centered, Sensitive, Enumerate,
+\begin_inset Newline newline
+\end_inset
+
+Itemize, Bibliography
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+]
+\begin_inset Separator latexpar
+\end_inset
+
+
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+Manual
\end_layout
\end_inset
- is the same as
+ means the label is the very first word (up to the first real blank).
+ Use protected spaces if you want more than one word as the label.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Static
\end_layout
\end_inset
-, except that
+ means the label is simply what is declared as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+LabelString
\end_layout
\end_inset
- is passed as an argument to the environment.
-
+.
+ This will be displayed
+\begin_inset Quotes eld
+\end_inset
+
+inline
+\begin_inset Quotes erd
+\end_inset
+
+, at the beginning of the paragraph.
+ If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+LatexType
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex MenuItem
+ is
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-settings
+Environment
\end_layout
\end_inset
- dialog.
-
-\end_layout
+, then it will be displayed only in the first paragraph of any sequence
+ of paragraphs with the same
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
+\begin_layout Plain Layout
+Style
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
+.
\end_layout
-\begin_layout Standard
-or:
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Above
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
-
-\backslash
-end{latexname}.
-\end_layout
-\begin_layout Standard
-depending upon the LaTeX type.
-\end_layout
+\begin_inset space ~
+\end_inset
+
+and
+\begin_inset space ~
+\end_inset
-\end_deeper
-\begin_layout Description
-\change_inserted -712698321 1354263086
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353866852
-LeftDelim
+Centered
\end_layout
\end_inset
- [
+ are special cases of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353866852
-string
+Static
\end_layout
\end_inset
-] A string that is put at the beginning of the style content.
- A line break in the output can be indicated by
+.
+ The label will be printed above the paragraph either at the beginning of
+ the line or centered.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1354263086
-<br/>
+Sensitive
\end_layout
+\end_inset
+
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
+
+Figure
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+Table
+\begin_inset Quotes erd
\end_inset
.
-\change_unchanged
+\begin_inset Newline newline
+\end_inset
-\end_layout
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Sensitive
\end_layout
\end_inset
- [
+ means the (hardcoded) label string depends on the kind of float: It is
+ hardcoded to be `FloatType N', where N is the value of the counter associated
+ with the float.
+ For the case that a caption is inserted outside of a float the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+LabelString
\end_layout
\end_inset
-] If you put styles into environments, the leftmargins are not simply added,
- but added with a factor
-\begin_inset Formula $\frac{4}{depth+4}$
+ will appear as
+\begin_inset Quotes eld
+\end_inset
+
+Senseless!
+\begin_inset Quotes erd
\end_inset
.
- Note that this parameter is also used when the margin is defined as
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+Enumerate
\end_layout
\end_inset
- or
+ produces the usual sort of enumeration labels.
+ At present, it is hardcoded to use Arabic numerals, lowercase letters,
+ small Roman numerals, and uppercase letters for the four possible depths.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+Itemize
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
-
-\begin_inset Newline newline
-\end_inset
-
-The argument is passed as a string.
- For example
-\begin_inset Quotes eld
-\end_inset
-
+ produces various bullets at the different levels.
+ It is also hardcoded.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+Bibliography
\end_layout
\end_inset
+ should be used only with
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+LatexType BibEnvironment
+\end_layout
- means that the paragraph is indented with the width of
-\begin_inset Quotes eld
\end_inset
+.
+\end_layout
+\end_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MM
+LangPreamble
\end_layout
\end_inset
+ Note that this will completely override any prior
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
-\begin_inset Quotes erd
\end_inset
- in the normal font.
- You can get a negative width by prefixing the string with
+ declaration for this style.
+ Must end with
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
--
+EndLangPreamble
\end_layout
\end_inset
\end_inset
.
- This way was chosen so that the look is the same with each used screen
- font.
-
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
+
+\end_inset
+
+ for details on its use.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Margin
+LatexName
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Static
-\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+<name>
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
+] The name of the corresponding \SpecialChar LaTeX
+ stuff.
+ Either the environment or command name.
+\end_layout
-The kind of margin that the style has on the left side.
-
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Static
+LatexParam
\end_layout
\end_inset
- just means a fixed margin.
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Manual
+<parameter>
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex MenuItem
+] An optional parameter for the corresponding
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+LatexName
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-
+ stuff.
+ This parameter cannot be changed from within \SpecialChar LyX
+ (use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+Argument
\end_layout
\end_inset
- means that the margin depends on the size of the label.
- This is used for automatic enumerated headlines.
- It is obvious that the headline
-\begin_inset Quotes eld
-\end_inset
+ for customizable parameters).
+ This will be output as is after all \SpecialChar LaTeX
+
+\begin_inset Flex Code
+status collapsed
-5.4.3.2.1 Very long headline
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+Argument
+\end_layout
- must have a wider left margin (as wide as
-\begin_inset Quotes eld
\end_inset
-5.4.3.2.1
-\begin_inset Quotes erd
-\end_inset
+s.
+\end_layout
- plus the space) than
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LatexType
+\end_layout
-3.2 Very long headline
-\begin_inset Quotes erd
\end_inset
-, even if standard
-\begin_inset Quotes eld
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Paragraph
+\emph default
+, Command, Environment, Item_Environment,
+\begin_inset Newline newline
\end_inset
-word processors
-\begin_inset Quotes erd
+List_Environment, Bib_Environment
+\end_layout
+
\end_inset
- are not able to do this.
-
+] How the style should be translated into \SpecialChar LaTeX
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+LatexType
\end_layout
\end_inset
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
-
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
+\end_layout
+
+\end_inset
+
+
+\begin_inset Separator latexpar
+\end_inset
+
+
+\end_layout
+
+\begin_deeper
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+Paragraph
\end_layout
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
+ means nothing special.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Command
\end_layout
\end_inset
- [
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+\backslash
+
\emph on
-0
+LatexName
+\emph default
+{\SpecialChar ldots
+}
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Environment
\end_layout
\end_inset
-] Whether fragile commands in this style should be
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-protect
-\end_layout
-
-\end_inset
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar ldots
-'ed.
- (Note: This is
+\backslash
+end{
\emph on
-not
+LatexName
\emph default
- whether this command should itself be protected.)
+}
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-Newline
+.
+
\end_layout
-\end_inset
-
- [
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Item_Environment
\end_layout
\end_inset
-,
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Environment
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
+, except that an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-
-\backslash
-
+item
\end_layout
\end_inset
-) or not.
- The translation can be switched off to allow more comfortable LaTeX editing
- inside LyX.
+ is generated for each paragraph of this environment.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+List_Environment
\end_layout
\end_inset
- [
+ is the same as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Item_Environment
\end_layout
\end_inset
-,
+, except that
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+LabelWidthString
\end_layout
\end_inset
-] If set to true, and if
+ is passed as an argument to the environment.
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultStyle
+LabelWidthString
\end_layout
\end_inset
- (usually
-\begin_inset Flex Code
+ can be defined in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Standard
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+settings
\end_layout
\end_inset
-) 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.)
+ dialog.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ObsoletedBy
+Bib_Environment
\end_layout
\end_inset
- Name of a style that has replaced this style.
- This is used to rename a style, while keeping backward compatibility.
-\end_layout
-
-\begin_layout Description
-
-\change_deleted -712698321 1353679722
+ is like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+Environment
\end_layout
\end_inset
- [
+ but adds the necessary mandatory argument (the longest label) to the begin
+ statement of the bibliography environment:
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-int=0
+
+\backslash
+begin{thebibliography}{99}
\end_layout
\end_inset
-] The number of optional arguments that can be used with this style.
- This is useful for things like section headings, and only makes sense with
- LaTeX.
- Note that, on output, the optional arguments will all precede any required
- arguments (see below).
- So one can have constructs like:
-\end_layout
-
-\begin_deeper
-\begin_layout LyX-Code
+.
+ It is therefore only useful for bibliography environments.
+ The default longest label
+\begin_inset Quotes eld
+\end_inset
-\change_deleted -712698321 1353679722
+99
+\begin_inset Quotes erd
+\end_inset
-\backslash
-mycmd[opt1]{req1}{contents of paragraph}
+ can be changed by the user in the paragraph settings of a bibliography
+ item.
\end_layout
\begin_layout Standard
-
-\change_deleted -712698321 1353679722
-but one cannot have things like:
+Putting the last few things together, the \SpecialChar LaTeX
+ output will be either:
\end_layout
\begin_layout LyX-Code
-\change_deleted -712698321 1353679722
-
\backslash
-mycmd[opt1]{req1}[opt2]{contents of paragraph}
+LatexName[LatexParam]{\SpecialChar ldots
+}
\end_layout
\begin_layout Standard
+or:
+\end_layout
+
+\begin_layout LyX-Code
-\change_deleted -712698321 1353679722
-at least, not without ERT (with which you can have anything).
+\backslash
+begin{LatexName}[LatexParam] \SpecialChar ldots
-\change_unchanged
+\backslash
+end{LatexName}.
+\end_layout
+\begin_layout Standard
+depending upon the \SpecialChar LaTeX
+ type.
\end_layout
\end_deeper
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+LeftDelim
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
-
-\end_inset
-
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-1
+string
\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
+] A string that is put at the beginning of the style content.
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru 1
+<br/>
\end_layout
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ParIndent
+LeftMargin
\end_layout
\end_inset
\end_inset
-] The indent of the very first line of a paragraph.
- The
+] If you put styles into environments, the different
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+LeftMargin
\end_layout
\end_inset
- 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
-NextNoIndent
-\end_layout
-
+ are not simply added, but added with a factor
+\begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
\end_inset
.
- Also,
+ Note that this parameter is also used when
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Margin
\end_layout
\end_inset
- style paragraphs inside environments use the
+ is defined as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Parindent
+Manual
\end_layout
\end_inset
- of the environment, not their native one.
- For example,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Standard
+Dynamic
\end_layout
\end_inset
- paragraphs inside an enumeration are not indented.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Parsep
-\end_layout
+.
+ Then it is added to the manual or dynamic margin.
+\begin_inset Newline newline
+\end_inset
+For example
+\begin_inset Quotes eld
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+MM
\end_layout
\end_inset
-] The vertical space between two paragraphs of this style.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-Parskip
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+MM
\end_layout
\end_inset
-] LyX allows the user to choose either
-\begin_inset Quotes eld
-\end_inset
-indent
\begin_inset Quotes erd
\end_inset
- or
+ in the normal font.
+ You can get a negative width by prefixing the string with
\begin_inset Quotes eld
\end_inset
-skip
-\begin_inset Quotes erd
-\end_inset
-
- to typeset a document.
- When
-\begin_inset Quotes eld
-\end_inset
-indent
-\begin_inset Quotes erd
-\end_inset
+\begin_inset Flex Code
+status collapsed
- is chosen, this value is completely ignored.
- When
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+-
+\end_layout
-skip
-\begin_inset Quotes erd
\end_inset
- is chosen, the parindent of a LaTeXtype
-\begin_inset Quotes eld
-\end_inset
-Paragraph
\begin_inset Quotes erd
\end_inset
- style is ignored and all paragraphs are separated by this parskip argument.
- The vertical space is calculated with
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-value
-\begin_inset space ~
-\end_inset
-
-* DefaultHeight
+Margin
\end_layout
\end_inset
- where
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
- is the height of a row with the normal font.
- This way, the look stays the same with different screen fonts.
+]
+\begin_inset Newline newline
+\end_inset
+
+The kind of margin that the style has on the left side.
+\begin_inset Separator latexpar
+\end_inset
+
+
\end_layout
+\begin_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+Static
\end_layout
\end_inset
- [
+ just means a fixed margin.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Manual
\end_layout
\end_inset
-,
-\begin_inset Flex Code
+ means that the left margin depends on the string entered in the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-1
+Edit\SpecialChar menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\end_layout
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
+ dialog.
+ This is used to typeset nice lists without tabulators.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Preamble
+Dynamic
\end_layout
\end_inset
- Information to be included in the LaTeX preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
+ means that the margin depends on the size of the label.
+ This is used for automatic enumerated headlines.
+ It is obvious that the headline
\begin_inset Quotes eld
\end_inset
+5.4.3.2.1 Very long headline
+\begin_inset Quotes erd
+\end_inset
+
+ must have a wider left margin (as wide as
+\begin_inset Quotes eld
+\end_inset
-\begin_inset Flex Code
-status collapsed
+5.4.3.2.1
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-EndPreamble
-\end_layout
+ plus the space) than
+\begin_inset Quotes eld
+\end_inset
+3.2 Very long headline
+\begin_inset Quotes erd
\end_inset
+, even if standard
+\begin_inset Quotes eld
+\end_inset
+word processors
\begin_inset Quotes erd
\end_inset
-.
+ are not able to do this.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RefPrefix
+First_Dynamic
\end_layout
\end_inset
- [
+ is similar, but only the very first row of the paragraph is dynamic, while
+ the others are static; this is used, for example, for descriptions.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+Right_Address_Box
\end_layout
\end_inset
-] The prefix to use when creating labels referring to paragraphs of this
- type.
- This allows the use of formatted references.
+ means the margin is chosen in a way that the longest row of this paragraph
+ fits to the right margin.
+ This is used to typeset an address on the right edge of the page.
\end_layout
+\end_deeper
\begin_layout Description
-
-\change_deleted -712698321 1353681258
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RequiredArgs
+NeedProtect
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-int=0
+
+\emph on
+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 space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+1
\end_layout
\end_inset
- tag above for more information.
-\change_unchanged
+] Whether fragile commands in this style 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 this command should itself be protected.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Requires
+Newline
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+0
\end_layout
\end_inset
-] Whether the style requires the feature
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+1
\end_layout
\end_inset
-.
- See the description of
+] Whether newlines are translated into \SpecialChar LaTeX
+ newlines (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
-\end_layout
-\end_inset
+\backslash
- above (page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+\backslash
-\end_inset
+\end_layout
-) for information on `features'.
-
-\change_inserted -712698321 1353693134
+\end_inset
+) or not.
+ The translation can be switched off to allow more comfortable \SpecialChar LaTeX
+ editing
+ inside \SpecialChar LyX
+.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1353693371
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353693146
-ResetArgs
-\change_unchanged
-
+NextNoIndent
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1353693235
-
\emph on
0
\end_layout
\end_inset
,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353693235
1
\end_layout
\end_inset
-] Resets the LaTeX arguments of this style (as defined via the
+] If set to true, and if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353693371
-Argument
-\change_unchanged
-
+DefaultStyle
\end_layout
\end_inset
- tag).
- This is useful if you have copied a style via
+ (usually
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353693302
-CopyStyle
-\change_unchanged
-
+Standard
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
-\change_unchanged
-
+) 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
-
-\change_inserted -712698321 1354263074
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353866876
-RightDelim
+ObsoletedBy
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+<name>
+\end_layout
-\change_inserted -712698321 1353866873
-string
+\end_inset
+
+] Name of a style that has replaced this style.
+ This is used to rename a style, while keeping backward compatibility.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ParagraphGroup
\end_layout
\end_inset
-] A string that is put at the end of the layout content.
- A line break in the output can be indicated by
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+0
+\end_layout
-\change_inserted -712698321 1354263069
-<br/>
-\change_unchanged
+\end_inset
+
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+1
\end_layout
\end_inset
-.
+] Determines whether consecutive pragraphs of the same type are treated
+ as belonging together.
+ This has the effect that the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+GuiLabel
\end_layout
-\begin_layout Description
+\end_inset
+
+ is only printed once before such a group.
+ By default, this is true for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+LaTeXType
\end_layout
\end_inset
- [
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string=""
+Environment
\end_layout
\end_inset
-] Similar to
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Bib_Environment
\end_layout
\end_inset
-.
+ and false for all other types.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spacing
+ParbreakIsNewline
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-single
-\emph default
-, onehalf, double, other
+0
\end_layout
\end_inset
-
-\emph on
-value
-\emph default
-] This defines what the default spacing should be in the style.
- The arguments
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-single
+1
\end_layout
\end_inset
-,
+] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
+ output,
+ but only by a line break; together with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onehalf
+PassThru 1
\end_layout
\end_inset
- and
+, this allows to emulate a plain text editor (like the ERT inset).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-double
+ParIndent
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-other
+string=""
\end_layout
\end_inset
-, then you should also provide a numerical argument which will be the actual
- multiplier value.
- Note that, contrary to other parameters,
+] The indent of the very first line of a paragraph.
+ The
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spacing
+Parindent
\end_layout
\end_inset
- implies the generation of specific LaTeX code, using the package
-\family roman
-
+ 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
-setspace.sty
+NextNoIndent
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Description
+ Also,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Spellcheck
+Standard
\end_layout
\end_inset
- [
+ style paragraphs inside environments use the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+Parindent
\end_layout
\end_inset
-,
+ of the environment, not their native one.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+Standard
\end_layout
\end_inset
-] Spellcheck paragraphs of this style.
- Default is true.
+ paragraphs inside an enumeration are not indented.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TextFont
+ParSep
\end_layout
\end_inset
- The font used for the text body .
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
\end_inset
-.
+] The vertical space between two paragraphs of this style.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TocLevel
+Parskip
\end_layout
\end_inset
-
-\series medium
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-[int]
+float=0
\end_layout
\end_inset
+] \SpecialChar LyX
+ allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
-\series default
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
-\end_layout
+indent
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
+ or
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ to separate paragraphs.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+indent
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TopSep
+Parskip
\end_layout
\end_inset
- [
+ is ignored.
+ When
+\begin_inset Quotes eld
+\end_inset
+
+skip
+\begin_inset Quotes erd
+\end_inset
+
+ is chosen,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float=0
+ParIndent
\end_layout
\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this style is separated from the previous paragraph.
- If the previous paragraph has another style, the separations are not simply
- added, but the maximum is taken.
+ is ignored and all paragraphs are separated by the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parskip
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:I18n"
+\end_inset
+ argument.
+ The vertical space is calculated with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Parskip
+\begin_inset space ~
\end_inset
-Internationalization of Paragraph Styles
+* DefaultHeight
\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
+\end_inset
-\begin_layout Standard
-If a
+ where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+DefaultHeight
\end_layout
\end_inset
- defines text that is to appear in the typeset document, it may use
+ is the height of a row with the normal font.
+ This way, the look stays the same with different screen fonts.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+PassThru
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+
+\emph on
+0
\end_layout
\end_inset
- to support non-English and even multi-language documents correctly.
- The following excerpt (from the
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-theorems-ams.inc
+1
\end_layout
\end_inset
- file) shows how this works:
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
\end_layout
-\begin_layout LyX-Code
-Preamble
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_deeper
-\begin_layout LyX-Code
-
-\backslash
-theoremstyle{remark}
+\begin_layout Plain Layout
+PassThruChars
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-newtheorem{claim}[thm]{
-\backslash
-protect
-\backslash
-claimname}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-EndPreamble
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-LangPreamble
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-providecommand{
-\backslash
-claimname}{_(Claim)}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-EndLangPreamble
+]
+\family typewriter
+
+\family default
+Defines individual characters that should be output in raw form, meaning
+ without special translations that \SpecialChar LaTeX
+ would require.
\end_layout
-\begin_layout LyX-Code
-BabelPreamble
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-
-\backslash
-addto
-\backslash
-captions$$lang{
-\backslash
-renewcommand{
-\backslash
-claimname}{_(Claim)}}
+\begin_layout Plain Layout
+Preamble
\end_layout
-\begin_layout LyX-Code
-EndBabelPreamble
-\end_layout
+\end_inset
+
+ Information to be included in the \SpecialChar LaTeX
+ preamble when this style is used.
+ Used to define macros, load packages, etc., required by this particular
+ style.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
-\end_deeper
-\begin_layout Standard
-In principle, any legal LaTeX may appear in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+EndPreamble
\end_layout
\end_inset
- and
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+RefPrefix
\end_layout
\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_layout Plain Layout
-
-\backslash
-claimname
+string
\end_layout
\end_inset
- and its use in
+] 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
-
-\backslash
-newtheorem
+Requires
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Standard
-The
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+string
\end_layout
\end_inset
- 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
+] Whether the style requires the feature
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preamble
+string
\end_layout
\end_inset
- tag.
- What makes it special is the use of the
-\begin_inset Quotes eld
-\end_inset
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:List-of-functions"
-function
-\begin_inset Quotes erd
\end_inset
+ for the list of features).
+ If you require a package with specific options, you can additionally use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_()
+PackageOptions
\end_layout
\end_inset
-, which will be replaced, when LyX produces LaTeX output, with the translation
- of its argument into the document language.
+ as a general text class parameter (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:General-text-class"
+
+\end_inset
+
+).
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+ResetArgs
\end_layout
\end_inset
- 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
-babel
+
+\emph on
+0
\end_layout
\end_inset
- 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
-_()
+1
\end_layout
\end_inset
- will be replaced with its translation into the language in question; the
- expression
+] Resets the \SpecialChar LaTeX
+ arguments of this style (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$$lang
+Argument
\end_layout
\end_inset
- is replaced by the language name (as used by the babel package).
-\end_layout
+ tag).
+ This is useful if you have copied a style via
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-A German document that also included a French section would thus have the
- following in the preamble:
+\begin_layout Plain Layout
+CopyStyle
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-addto
-\backslash
-captionsfrench{
-\backslash
-renewcommand{
-\backslash
-claimname}{Affirmation}}
-\backslash
-addto
-\backslash
-captionsngerman{
-\backslash
-renewcommand{
-\backslash
-claimname}{Behauptung}}
-\backslash
-providecommand{
-\backslash
-claimname}{Behauptung}
+, but you do not want to inherit its (required and optional) arguments.
\end_layout
-\begin_layout Standard
-LaTeX and
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-babel
+RightDelim
\end_layout
\end_inset
- will then conspire to produce the correct text in the output.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout Standard
-One important point to note here is that the translations are provided by
- LyX itself, through the
-\change_inserted -195340706 1334775793
-file
+\end_inset
+
+] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1334775793
-layouttranslations
+<br/>
\end_layout
\end_inset
-
-\change_deleted -195340706 1334775793
-same mechanism it uses for internationalization of the user interface
-\change_unchanged
.
- This means, in effect, that
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+RightMargin
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+string=""
\end_layout
\end_inset
- 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
-\change_inserted -195340706 1334775793
- unless the
+] Similar to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -195340706 1334775793
-layouttranslations
+LeftMargin
\end_layout
\end_inset
- file is modified accordingly
-\change_unchanged
.
- That said, however, any layout created with the intention that it will
- be included with LyX should use these tags where appropriate.
+\end_layout
-\change_inserted -195340706 1334775793
- Please note that the paragraph style translations provided by LyX will
- never change with a minor update (e.g.
- from version 2.1.x to 2.1.y).
- It is however quite likely that a major update (e.g.
- from 2.0.x to 2.1.y) will introduce new translations or corrections.
-\change_unchanged
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Spacing
\end_layout
-\begin_layout Subsection
-Floats
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Floats"
-
\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\emph on
+single
\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
+\end_inset
+
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-figure
+onehalf
\end_layout
\end_inset
,
-\begin_inset Flex MenuItem
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-table
+double
\end_layout
\end_inset
-, \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
-
+other
+\begin_inset space ~
\end_inset
-, so you may have to do no more than add
+<value>
\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
+\end_inset
-\begin_layout Description
+] This defines what the default spacing should be in the style.
+ The arguments
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Extension
+single
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+onehalf
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The file name extension of an auxiliary file for the list of figures (or
- whatever).
- LaTeX writes the captions to this file.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-GuiName
+double
\end_layout
\end_inset
- [
+ correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ If you specify the argument
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+other
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+, then you must also provide a value argument which will be the actual multiplie
+r value.
+ Note that, contrary to other parameters,
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Spacing
+\end_layout
-\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
+ implies the generation of specific \SpecialChar LaTeX
+ code, using the \SpecialChar LaTeX
+ package
+\family roman
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+setspace
\end_layout
-\end_inset
-
- These are used for XHTML output.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-
\end_inset
.
status collapsed
\begin_layout Plain Layout
-IsPredefined
+Spellcheck
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex Code
-status open
+status collapsed
\begin_layout Plain Layout
0
\end_inset
+,
+\begin_inset space \thinspace{}
+\end_inset
+
-\emph default
-,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
1
\end_layout
\end_inset
-] Indicates whether the float is already defined in the document class or
- if we instead need to load
+] Allow spell-checking paragraphs of this style.
+ Default is true.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+TextFont
\end_layout
\end_inset
- and use what it provides to define it on-the-fly.
- The default is
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-0
-\end_layout
+ The font used for the text body .
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
\end_inset
-, which means: use
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+TocLevel
\end_layout
\end_inset
-.
- It should be set to
+
+\series medium
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\series medium
+int=3
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
+]
+\series default
+ The level of the style in the table of contents.
+ This is used for automatic numbering of section headings.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ListCommand
+ToggleIndent
\end_layout
\end_inset
[
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\emph on
+default
+\end_layout
-=
-\begin_inset Quotes erd
\end_inset
-\begin_inset Quotes erd
-\end_inset
-
-] The command used to generate a list of floats of this type; the leading
- `
-\backslash
-' should be omitted.
- This
-\emph on
-must
\emph default
- be given if
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+always
\end_layout
\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
+never
\end_layout
\end_inset
- is true, since in that case there is a standard way to define the command.
-\end_layout
+] This tag determines whether the first line indentation of this paragraph
+ can be toggled via the Paragraph settings dialog.
+ If
+\emph on
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ListName
-\end_layout
-
-\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+\emph off
+default
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-\begin_inset Quotes erd
+\emph default
+ is set, indentation can be toggled if the document settings use
+\begin_inset Quotes eld
\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
-
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-NumberWithin
-\end_layout
-
+indent
+\begin_inset Quotes erd
\end_inset
- [
+ paragraph style, with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+always
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] This (optional) argument determines whether floats of this class will
- be numbered within some sectional unit of the document.
- For example, if within is equal to
+, indentation can always be toggled, notwithstanding the document settings,
+ with
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+never
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
+, indentation can never be toggled.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Placement
+TopSep
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+float=0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+] The vertical space with which the very first of a chain of paragraphs
+ with this style is separated from the previous paragraph.
+ If the previous paragraph has another style, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:I18n"
-\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
+Internationalization of Paragraph Styles
\end_layout
-\end_inset
+\begin_layout Standard
+\SpecialChar LyX
+ has long supported internationalization of layout information, but, until
+ version 2.0, this applied only to the user interface and not to, say, PDF
+ output.
+ Thus, French authors were forced to resort to ugly hacks if they wanted
+ `
+\lang french
+Théorème
+\lang english
+ 1' instead of `Theorem 1'.
+ Thanks to Georg Baum, that is no longer the case.
+\end_layout
-,
+\begin_layout Standard
+If a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-b
+Style
\end_layout
\end_inset
-,
+ defines text that is to appear in the typeset document, it may use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-p
+LangPreamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-h
+BabelPreamble
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+ to support non-English and even multi-language documents correctly.
+ The following excerpt (from the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+theorems-ams.inc
\end_layout
\end_inset
- On top of that there is a new type,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-H
+ file) shows how this works:
\end_layout
+\begin_layout LyX-Code
+Preamble
+\begin_inset Separator latexpar
\end_inset
-, which does not really correspond to a float, since it means: put it
-\begin_inset Quotes eld
-\end_inset
-here
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- and nowhere else.
- Note however that the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-H
+\begin_deeper
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
\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_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
-\begin_inset Flex Code
-status collapsed
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
-\begin_layout Plain Layout
-tbp
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
\end_layout
-\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
-.
+\begin_layout LyX-Code
+EndBabelPreamble
\end_layout
-\begin_layout Description
+\end_deeper
+\begin_layout Standard
+In principle, any legal \SpecialChar LaTeX
+ may appear in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+LangPreamble
\end_layout
\end_inset
- [
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+BabelPreamble
\end_layout
\end_inset
-] The prefix to use when creating labels referring to floats of this type.
- This allows the use of formatted references.
- Note that you can remove any
+ 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 \SpecialChar LaTeX
+ command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+
+\backslash
+claimname
\end_layout
\end_inset
- set by a copied style by using the special value
-\begin_inset Quotes eld
-\end_inset
+ and its use in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+newtheorem
+\end_layout
-OFF
-\begin_inset Quotes erd
\end_inset
-, which must be all caps.
+.
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Style
+LangPreamble
\end_layout
\end_inset
- [
+ 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
-string
+Preamble
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ tag.
+ What makes it special is the use of the
+\begin_inset Quotes eld
\end_inset
-
+function
\begin_inset Quotes erd
\end_inset
-] The style used when defining the float using
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+_()
\end_layout
\end_inset
-.
+, which will be replaced, when \SpecialChar LyX
+ produces \SpecialChar LaTeX
+ output, with the translation of
+ its argument into the document language.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Type
+BabelPreamble
\end_layout
\end_inset
- [
+ 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
-string
+babel
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The
-\begin_inset Quotes eld
-\end_inset
-
-type
-\begin_inset Quotes erd
-\end_inset
-
- of the new class of floats, like program or algorithm.
- After the appropriate
+ 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
-
-\backslash
-newfloat
+_()
\end_layout
\end_inset
-, commands such as
+ will be replaced with its translation into the language in question; the
+ expression
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+$$lang
\end_layout
\end_inset
- or
-\begin_inset Flex Code
-status collapsed
+ is replaced by the language name (as used by the babel package).
+\end_layout
-\begin_layout Plain 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
-end{algorithm*}
-\end_layout
+addto
+\backslash
+captionsfrench{
+\backslash
+renewcommand{
+\backslash
+claimname}{Affirmation}}
+\begin_inset Newline newline
+\end_inset
+
+\backslash
+addto
+\backslash
+captionsngerman{
+\backslash
+renewcommand{
+\backslash
+claimname}{Behauptung}}
+\begin_inset Newline newline
\end_inset
- will be available.
+
+\backslash
+providecommand{
+\backslash
+claimname}{Behauptung}
\end_layout
-\begin_layout Description
+\begin_layout Standard
+\SpecialChar LaTeX
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UsesFloatPkg
+babel
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status open
-
-\begin_layout Plain Layout
-0
+ will then conspire to produce the correct text in the output.
\end_layout
-\end_inset
-
-,
+\begin_layout Standard
+One important point to note here is that the translations are provided by
+ \SpecialChar LyX
+ itself, through the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+layouttranslations
\end_layout
\end_inset
-] Tells us whether this float is defined using the facilities provided by
-
+.
+ This means, in effect, that
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-float.sty
+LangPreamble
\end_layout
\end_inset
-, either by the class file or a package, or on-the-fly by LyX itself.
-\end_layout
-
-\begin_layout Standard
-Note that defining a float with type
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+BabelPreamble
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ are really only of use in layout files that are provided with \SpecialChar LyX
+, since text
+ entered in user-created layout files will not be seen by \SpecialChar LyX
+'s internationalizatio
+n routines unless the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+layouttranslations
\end_layout
\end_inset
-.
-\end_layout
+ file is modified accordingly.
+ That said, however, any layout created with the intention that it will
+ be included with \SpecialChar LyX
+ should use these tags where appropriate.
+ Please note that the paragraph style translations provided by \SpecialChar LyX
+ will never
+ change with a minor update (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
-Flex insets and InsetLayout
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Flex-insets-and"
+g.
+\begin_inset space \space{}
+\end_inset
+from version 2.1.x to 2.1.y).
+ It is however quite likely that a major update (e.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
+from 2.0.x to 2.1.y) will introduce new translations or corrections.
\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 Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Floats"
+
+\end_inset
+
-\begin_layout Standard
-Flex insets come in three different kinds:
\end_layout
-\begin_layout Itemize
-character style (
-\begin_inset Flex Code
+\begin_layout Standard
+It is necessary to define the floats (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-CharStyle
+figure
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-
-\backslash
-noun
+table
\end_layout
\end_inset
- and
+, \SpecialChar ldots
+) in the text class itself.
+ Standard floats are included in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-code
+stdfloats.inc
\end_layout
\end_inset
-.
+, so you may have to do no more than add
\end_layout
-\begin_layout Itemize
-user custom (
+\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 \SpecialChar LyX
+), the information below will hopefully
+ help you:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Custom
+AllowedPlacement
\end_layout
\end_inset
-): These can be used to define custom collapsible insets, similar to TeX
- code, footnote, and the like.
- An obvious example is an endnote inset, which is defined in the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-endnote
+string
\end_layout
\end_inset
- module.
-\end_layout
+=!htbpH] Allowed placement options for this float type.
+ The value is a string of placement characters.
+ Possible characters include:
+\emph on
+h
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-XML elements (
-\begin_inset Flex Code
-status collapsed
+here if possible
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Element
-\end_layout
+),
+\emph on
+t
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+top of page
+\begin_inset Quotes erd
\end_inset
-): For use with DocBook classes.
-\end_layout
+),
+\emph on
+b
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Flex insets are defined using the
-\begin_inset Flex Code
-status collapsed
+bottom of page
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
+),
+\emph on
+p
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+page of floats
+\begin_inset Quotes erd
\end_inset
- tag, which shall be explained in a moment.
+),
+\emph on
+H
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+
+here definitely
+\begin_inset Quotes erd
+\end_inset
+
+) and
+\emph on
+!
+\emph default
+ (
+\begin_inset Quotes eld
+\end_inset
+
+ignore LaTeX rules
+\begin_inset Quotes erd
+\end_inset
+
+).
+ The order of the characters in the string does not matter.
+ If no placement options are allowed, use the string
+\emph on
+none
+\emph default
+.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+AllowsSideways
\end_layout
\end_inset
- tag also serves another function: It can be used to customize the general
- layout of many different types of insets.
- Currently,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+
+\emph off
+0
\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_inset space \thinspace{}
+\end_inset
+
+
+\emph on
-\begin_layout Standard
-The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+
+\emph on
+1
\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
+\emph default
+] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
+-package
+\family typewriter
+rotfloat
+\family default
+ (sidewaysfloat).
+ Set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+0
\end_layout
\end_inset
- indicates the inset whose layout is being defined, and here there are
-\change_inserted 5863208 1334489266
-three
-\change_deleted 5863208 1334489267
-two
-\change_unchanged
- cases.
+ if the float does not support this feature.
\end_layout
-\begin_layout Enumerate
-The layout for a pre-existing inset is being modified.
- In this case, can be
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+AllowsWide
\end_layout
\end_inset
- any one of the following:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+
+\emph off
+0
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
-Branch
-\end_layout
-\end_inset
+\emph on
-,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box
+
+\emph on
+1
\end_layout
\end_inset
-,
+
+\emph default
+] Defines whether the float has a starred variant that spans columns in
+ a two column paragraph.
+ Set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Box:shaded
+0
\end_layout
\end_inset
-,
+ if the float does not support this feature.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ERT
+Extension
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Figure
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Foot
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] The file name extension of an auxiliary file for the list of figures (or
+ whatever).
+ \SpecialChar LaTeX
+ writes the captions to this file.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Index
+GuiName
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Info
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Info:menu
-\end_layout
+\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
-Info:shortcut
+HTML*
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Info:shortcuts
-\end_layout
+ These tags control the 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
-Listings
+IsPredefined
\end_layout
\end_inset
-,
+ [
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Marginal
+0
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Note:Comment
-\end_layout
+\emph default
+,
+\begin_inset space \thinspace{}
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Note
+1
\end_layout
\end_inset
-,
+] Indicates whether the float is already defined in the document class or
+ if instead the \SpecialChar LaTeX
+ package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Note:Greyedout
+float
\end_layout
\end_inset
-,
+ needs to be loaded to define it on-the-fly.
+ The default is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1353866704
-Opt
-\change_unchanged
-Arg
-\change_inserted -712698321 1353866707
-ument
-\change_unchanged
-
+0
\end_layout
\end_inset
-,
+, which means:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Table
+float
\end_layout
\end_inset
-, or
+ is used.
+ It should be set to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-URL
+1
\end_layout
\end_inset
-.
+ if the float is already defined by the \SpecialChar LaTeX
+ document class.
\end_layout
-\begin_layout Enumerate
-The layout for a Flex inset is being defined.
- In this case,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<Type>
+ListCommand
\end_layout
\end_inset
- must be of the form
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Flex:<name>
+string
\end_layout
\end_inset
+=
+\begin_inset Quotes erd
+\end_inset
+
\begin_inset Quotes erd
\end_inset
-, where
+] The command used to generate a list of floats of this type; the leading
+ `
+\backslash
+' must be omitted.
+ This
+\emph on
+must
+\emph default
+ be given if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-name
+UsesFloatPkg
\end_layout
\end_inset
- may be be any valid identifier not used by a pre-existing Flex inset.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- Note that the definition of a flex inset
-\emph on
-must
-\emph default
-also include a
+ 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
-LyXType
+UsesFloatPkg
\end_layout
\end_inset
- entry, declaring which type of inset it defines.
-\change_inserted 5863208 1334489312
-
+ is true, since in that case there is a standard way to define the command.
\end_layout
-\begin_layout Enumerate
-
-\change_inserted 5863208 1334492248
-The layout for user specific branch is being defined.
- In this case,
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 5863208 1334489384
-<Type>
+ListName
\end_layout
\end_inset
- must be of the form
-\begin_inset Quotes eld
-\end_inset
-
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 5863208 1334489392
-Branch:<name>
+string
\end_layout
\end_inset
-
+=
\begin_inset Quotes erd
\end_inset
-, where
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted 5863208 1334489384
-name
-\end_layout
+\begin_inset Quotes erd
\end_inset
- may be be any valid identifier of branch defined in user's document.
- The identifier may include spaces, but in that case the whole thing must
- be wrapped in quotes.
- The main purpose of this feature is to allow LaTeX wrapping around specific
- branches as user needs.
-\change_unchanged
-
+] A title for a list of floats of this kind (list of figures, tables, or
+ whatever).
+ It is used for the screen label within \SpecialChar LyX
+, it is used by \SpecialChar LaTeX
+ for the title and
+ it is used as the title in the XHTML output.
+ It will be translated to the document language.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+NumberWithin
\end_layout
\end_inset
- definition can contain the following entries:
-\end_layout
-
-\begin_layout Description
-
-\change_inserted -712698321 1353681390
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681344
-Argument
+string
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+=
+\begin_inset Quotes erd
+\end_inset
-\change_inserted -712698321 1353681344
-int
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Defines argument number <int> of a command\SpecialChar \slash{}
-environment associated with
- the current layout.
- The definition must end with
+] This (optional) argument determines whether floats of this class will
+ be numbered within some sectional unit of the document.
+ For example, if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353681344
-EndArgument
+NumberWithin
\end_layout
\end_inset
-.
- See section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Paragraph-Styles"
-
+ is set to
+\begin_inset Quotes eld
\end_inset
- for details.
-\end_layout
-
-\begin_layout Description
-\change_inserted -195340706 1333913893
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-BabelPreamble
+chapter
\end_layout
-\end_inset
-
- Preamble for changing languages.
- See section
-\begin_inset space ~
\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:I18n"
-
+\begin_inset Quotes erd
\end_inset
-.
+, the floats will be numbered within chapters.
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-BgColor
+Placement
\end_layout
\end_inset
- The color for the inset's background.
- The valid colors are defined in
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src/ColorCode.h
+string
\end_layout
\end_inset
-.
-\end_layout
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
+
+\begin_inset Quotes erd
+\end_inset
+
+] The default placement for the given class of floats.
+ The string should be as in standard \SpecialChar LaTeX
+:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ContentAsLabel
+t
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+b
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+p
\end_layout
\end_inset
-] Whether to use the content of the inset as the label, when the inset is
- closed.
- Default is false.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+h
\end_layout
\end_inset
-
-\begin_inset Flex Code
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-[string]
+Note that the order of these letters in the string is irrelevant, like in
+ \SpecialChar LaTeX
+.
\end_layout
\end_inset
- Copies all the features of an existing style into the current one.
-
-\end_layout
-
-\begin_layout Description
+ On top of that there is a new type,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CustomPars
+H
\end_layout
\end_inset
- [
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
+\end_inset
+
+here
+\begin_inset Quotes erd
+\end_inset
+
+ and nowhere else.
+ Note however that the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+H
+\end_layout
-\emph on
-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 Code
status collapsed
\begin_layout Plain Layout
-1
+tbp
\end_layout
\end_inset
-] Indicates whether the user may employ the Paragraph Settings dialog to
- customize the paragraph.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Decoration
+RefPrefix
\end_layout
\end_inset
- can be
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+string
\end_layout
\end_inset
-,
+] The prefix to use when creating labels referring to floats of this type.
+ This allows the use of formatted references.
+ Note that you can remove any
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+RefPrefix
\end_layout
\end_inset
-, or
+ set by a copied style by using the special value
+\begin_inset Quotes eld
+\end_inset
+
+OFF
+\begin_inset Quotes erd
+\end_inset
+
+, which must be all caps.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+Style
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Classic
+string
\end_layout
\end_inset
-, ERT insets generally
-\begin_inset Flex Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Minimalistic
-\end_layout
+\begin_inset Quotes erd
\end_inset
-, and character styles
+] The style used when defining the float using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+
+\backslash
+newfloat
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Display
+Type
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-0
+string
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
+=
+\begin_inset Quotes erd
+\end_inset
-\emph on
-1
-\end_layout
+\begin_inset Quotes erd
\end_inset
-] Only useful if
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LatexType
-\end_layout
+] The
+\begin_inset Quotes eld
+\end_inset
+type
+\begin_inset Quotes erd
\end_inset
- is
+ of the new class of floats, like program or algorithm.
+ After the appropriate
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+
+\backslash
+newfloat
\end_layout
\end_inset
-.
- Indicates whether the environment will stand on its own in LaTeX output
- or will appear inline with the surrounding text.
- If set to false, it is supposed that the LaTeX environment ignores white
- space (including one newline character) after the
+, commands such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}
+begin{program}
\end_layout
\end_inset
- and
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+end{algorithm*}
\end_layout
\end_inset
- tags.
- Default is true.
+ will be available.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-End
+UsesFloatPkg
\end_layout
\end_inset
- Required at the end of the InsetLayout declarations.
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+0
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
+,
+\begin_inset space \thinspace{}
\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+
+\emph on
+1
\end_layout
\end_inset
- to the same value, so define this first and define
+] Specifies whether this float is defined using the \SpecialChar LaTeX
+ package
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+float
\end_layout
\end_inset
- later if you want them to be different.
-\change_inserted 155139281 1354130923
-
+, either by the class file, another package or on-the-fly by \SpecialChar LyX
+ itself.
\end_layout
-\begin_layout Description
-
-\change_inserted 155139281 1354130923
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted 155139281 1354130923
-ForceLocalFontSwitch
+\emph on
+type
\end_layout
\end_inset
- [
+ automatically defines the corresponding counter with name
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted 155139281 1354130923
-
\emph on
-0
+type
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Flex-insets-and"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Flex insets come in three different kinds:
+\end_layout
+
+\begin_layout Itemize
+character style (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 155139281 1354130923
-1
+CharStyle
\end_layout
\end_inset
-] When using babel, always use a local font switch (
+): These define semantic markup corresponding to such \SpecialChar LaTeX
+ commands as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted 155139281 1354130923
-
\backslash
-foreignlanguage
+noun
\end_layout
\end_inset
-), never a global one (such as
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted 155139281 1354130923
-
\backslash
-selectlanguage
+code
\end_layout
\end_inset
-).
-\change_unchanged
-
+.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+user custom (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+Custom
\end_layout
\end_inset
- Force the
-\begin_inset Quotes eld
-\end_inset
-
-latex
-\begin_inset Quotes erd
-\end_inset
+): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
+ code,
+ footnote, and the like.
+ An obvious example is an endnote inset, which is defined in the
+\begin_inset Flex Code
+status collapsed
- language, leading to Left-to-Right (latin) output, e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+endnote
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-in TeX code or URL.
- A kludge.
+ module.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+XML elements (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+Element
\end_layout
\end_inset
- [
+): For use with DocBook classes.
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+InsetLayout
\end_layout
\end_inset
-,
+ tag, which shall be explained in a moment.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+InsetLayout
\end_layout
\end_inset
-] Indicates whether the
+ 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
-PlainLayout
+InsetLayout
\end_layout
\end_inset
- should be used or, instead, the user can change the paragraph style used
- in the inset.
- Default is false.
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, \SpecialChar TeX
+ code (ERT) insets, branches, listings, indexes, boxes,
+ tables, algorithms, URLs, and captions, as well as to define Flex insets.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+InsetLayout
\end_layout
\end_inset
- [
+ definition must begin with a line of the form:
+\end_layout
+
+\begin_layout LyX-Code
+InsetLayout <type>
+\end_layout
+
+\begin_layout Standard
+Here
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+<Type>
\end_layout
\end_inset
-,
+ indicates the inset whose layout is being defined, and here there are four
+ cases.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a pre-existing inset is being modified.
+ In this case, can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+<Type>
\end_layout
\end_inset
-] Usually LyX doesn't allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example, when typing
- program code or plain LaTeX code.
- For this reason,
+ any one of the following:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+Algorithm
\end_layout
\end_inset
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
- Default is false.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTML*
+Branch
\end_layout
\end_inset
- These tags control XHTML output.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Tags-for-XHTML"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-InToc
+Box
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Box:shaded
\end_layout
\end_inset
-,
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Caption:Standard
\end_layout
\end_inset
-] Whether to include the contents of this inset in the strings generated
- for the `Outline' pane.
- One would not, for example, want the content of a footnote in a section
- header to be included in the TOC displayed in the outline, but one would
- normally want the content of a character style displayed.
- Default is false: not to include.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+ERT
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Figure
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+Foot
\end_layout
\end_inset
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a style can be used
- as some kind of break, which does not contain actual text.
- Default is false.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Index
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
-\end_inset
-
-.
- Note that this definition can never appear before
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
+Info
\end_layout
\end_inset
-, lest it be ineffective.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Info:menu
\end_layout
\end_inset
- What will be displayed on the button or elsewhere as the inset label.
- Some inset types (
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TeX code
+Info:shortcut
\end_layout
\end_inset
- and
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Branch
+Info:shortcuts
\end_layout
\end_inset
-) modify this label on the fly.
-\end_layout
-
-\begin_layout Description
-
-\change_inserted -195340706 1333913893
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LangPreamble
+Listings
\end_layout
\end_inset
- Language dependent preamble.
- See section
-\begin_inset space ~
-\end_inset
-
+,
+\begin_inset Flex Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:I18n"
+\begin_layout Plain Layout
+Marginal
+\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Note:Comment
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+Note:Note
\end_layout
\end_inset
- The optional parameter for the corresponding
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Note:Greyedout
\end_layout
\end_inset
- stuff, including possible bracket pairs like
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-[]
+Table
\end_layout
\end_inset
-.
-
-\change_inserted -712698321 1355144715
-This will be output as is after all LaTeX
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355144713
-Arguments
+URL
\end_layout
\end_inset
.
-
-\change_unchanged
-This parameter cannot be changed from within LyX
-\change_inserted -712698321 1355144775
- (use
+\end_layout
+
+\begin_layout Enumerate
+The layout for a Flex inset is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1355144747
-Argument
+<Type>
\end_layout
\end_inset
- for customizable parameters)
-\change_unchanged
-.
-\end_layout
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Flex:<name>
\end_layout
\end_inset
- [
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+name
+\end_layout
-\change_deleted -712698321 1353867544
+\end_inset
+ may be be any valid identifier not used by a pre-existing Flex inset.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ Note that the definition of a flex inset
\emph on
-Paragraph
+must
\emph default
-,
-\change_unchanged
-Command, Environment,
-\change_inserted -712698321 1353867573
-None
-\change_deleted -712698321 1353867557
-Item_Environment,
-\change_unchanged
+also include a
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+LyXType
\end_layout
\end_inset
-
+ entry, declaring which type of inset it defines.
+\end_layout
+
+\begin_layout Enumerate
+The layout for user specific branch is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1353867564
-List_Environment
-\change_unchanged
-,
-\change_deleted -712698321 1353867569
-Bib_Environment
-\change_unchanged
-
+<Type>
\end_layout
\end_inset
-] How the style should be translated into LaTeX.
-\begin_inset Foot
-status collapsed
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Plain Layout
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Branch:<name>
\end_layout
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_deleted -712698321 1353867582
-Paragraph
-\change_inserted -712698321 1353867583
-None
-\change_unchanged
-
+name
\end_layout
\end_inset
- means nothing special.
-
+ may be be any valid identifier of branch defined in user's document.
+ The identifier may include spaces, but in that case the whole thing must
+ be wrapped in quotes.
+ The main purpose of this feature is to allow \SpecialChar LaTeX
+ wrapping around specific
+ branches as user needs.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+The layout of a user (or class) specific caption is being defined.
+ In this case,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Command
+<Type>
\end_layout
\end_inset
- means
+ must be of the form
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\emph on
-LatexName
-\emph default
-{\SpecialChar \ldots{}
-}
+Caption:<name>
\end_layout
\end_inset
-.
-\end_layout
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+name
\end_layout
\end_inset
- means
+ specifies the name of the caption as it appears in the menu.
+ Have a look at the standard caption (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+Caption:Standard
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Itemize
-
-\change_deleted -712698321 1353867600
+), the specific captions of the KOMA-Script classes (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Caption:Above
\end_layout
\end_inset
- is the same as
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Environment
+Caption:Below
\end_layout
\end_inset
-, except that an
+) or the module
+\family sans
+Multilingual
+\begin_inset space ~
+\end_inset
+
+Captions
+\family default
+(
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+Caption:Bicaption
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+) for applications.
\end_layout
-\begin_layout Itemize
-
-\change_deleted -712698321 1353867600
+\begin_layout Standard
+The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+InsetLayout
\end_layout
\end_inset
- is the same as
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Item_Environment
+ definition can contain the following entries:
\end_layout
-\end_inset
-
-, except that
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+Argument
\end_layout
\end_inset
- is passed as an argument to the environment.
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+int
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex MenuItem
+] Defines argument number of a command\SpecialChar breakableslash
+environment associated with the current
+ layout.
+ The definition must end with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-Edit
-\bar default
-\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\begin_inset space ~
-\end_inset
-
-settings
+EndArgument
\end_layout
\end_inset
- dialog.
-
-\change_unchanged
+.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-\end_layout
+\end_inset
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
+ for details.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
+\begin_layout Plain Layout
+BabelPreamble
\end_layout
-\begin_layout Standard
-or:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
+ Preamble for changing language commands; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
-
-\backslash
-end{latexname}.
-\end_layout
+\end_inset
-\begin_layout Standard
-depending upon the LaTeX type.
+.
\end_layout
-\end_deeper
\begin_layout Description
-
-\change_inserted -712698321 1354263128
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353866742
-LeftDelim
-\change_unchanged
-
+BgColor
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353866752
-string
+<name>
\end_layout
\end_inset
-] A string that is put at the beginning of the layout content.
- A line break in the output can be indicated by
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\change_inserted -712698321 1354263128
-<br/>
-\end_layout
+] The color for the inset's background.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "chap:Names-of-colors"
\end_inset
-.
-\change_unchanged
-
+ for a list of the available color names.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LyxType
+ContentAsLabel
\end_layout
\end_inset
- Can be
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+
+\emph on
+0
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-custom
-\end_layout
-
+,
+\begin_inset space \thinspace{}
\end_inset
-,
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-element
+1
\end_layout
\end_inset
-, or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-end
+] Whether to use the content of the inset as the label, when the inset is
+ closed.
+ Default is false.
\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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXType
+CopyStyle
\end_layout
\end_inset
- to
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-charstyle
+<type>
\end_layout
\end_inset
- will set
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MultiPar
-\end_layout
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
\end_inset
- to false.
-
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-MultiPar
-\end_layout
+.
+ Note that you need to specify the complete type, e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space ~
\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
+CopyStyle Flex:<name>
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-MultiPar
+CustomPars
\end_layout
\end_inset
\end_inset
,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\end_inset
-] Whether multiple paragraphs are permitted in this inset.
- This will also set
+] 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
-CustomPars
+Decoration
\end_layout
\end_inset
- to the same value and
+ can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-ForcePlain
+Classic
\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
+Minimalistic
\end_layout
\end_inset
-.
- Default is true.
-\end_layout
-
-\begin_layout Description
+, or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Conglomerate
\end_layout
\end_inset
- [
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+Classic
\end_layout
\end_inset
-,
+, ERT insets generally
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+Minimalistic
\end_layout
\end_inset
-] Whether fragile commands in this inset should be
+, and character styles
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+Conglomerate
\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
status collapsed
\begin_layout Plain Layout
-ParbreakIsNewline
+Display
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
0
\end_layout
\end_inset
-,
+,
+\emph on
+
+\begin_inset space \thinspace{}
+\end_inset
+
+
+\emph default
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+
+\emph on
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
+] Only useful if
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru 1
+LatexType
\end_layout
\end_inset
-, this allows to emulate a plain text editor (like the ERT inset).
- Default is false.
-\end_layout
-
-\begin_layout Description
+ is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-PassThru
+Environment
\end_layout
\end_inset
- [
+.
+ Indicates whether the environment will stand on its own in the output or
+ will appear inline with the surrounding text.
+ If set to false, it is supposed that the \SpecialChar 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
-0
+LatexName
+\emph default
+}
\end_layout
\end_inset
-,
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
+ tags.
+ Default is true.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Preamble
+End
\end_layout
\end_inset
- Information to be included in the LaTeX preamble when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
-\begin_inset Quotes eld
+ Required at the end of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
\end_inset
+ declarations.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-EndPreamble
+Font
\end_layout
\end_inset
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
-\begin_inset Quotes erd
\end_inset
.
-\end_layout
-
-\begin_layout Description
+ Note that defining this font automatically defines the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-RefPrefix
+LabelFont
\end_layout
\end_inset
- [
+ to the same value, so define this first and define
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+LabelFont
\end_layout
\end_inset
-] The prefix to use when creating labels referring to insets of this type.
- This allows the use of formatted references.
+ later if you want them to be different.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Requires
+FixedWidthPreambleEncoding
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-] Whether the style requires the feature
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+1
\end_layout
\end_inset
-.
- See the description of
+] Force a fixed width encoding for the translated contents of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Provides
+BabelPreamble
\end_layout
\end_inset
- above (page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
+ and
+\begin_inset Flex Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
-) for information on `features'.
-\change_inserted -712698321 1354439699
+\end_inset
+ code generated by this layout.
+ This is needed for special \SpecialChar LaTeX
+-packages like
+\family typewriter
+listings
+\family default
+ that do not work with variable width encodings such as
+\family sans
+utf8
+\family default
+.
+ This setting is ignored if fully Unicode aware \SpecialChar LaTeX
+ backends such as Xe\SpecialChar TeX
+ or
+ Lua\SpecialChar TeX
+ are used.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1354439705
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1354439699
-ResetArgs
+ForceLocalFontSwitch
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1354439699
-
\emph on
0
\end_layout
\end_inset
,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1354439699
1
\end_layout
\end_inset
-] Resets the LaTeX arguments of this layout (as defined via the
+] When using babel, always use a local font switch (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1354439699
-Argument
+\backslash
+foreignlanguage
\end_layout
\end_inset
- tag).
- This is useful if you have copied a style via
+), never a global one (such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-\change_inserted -712698321 1354439699
-CopyStyle
+\backslash
+selectlanguage
\end_layout
\end_inset
-, but you do not want to inherit its (required and optional) arguments.
-
-\change_deleted -712698321 1354439698
-
-\change_unchanged
-
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-ResetsFont
+ForceLTR
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph on
0
\end_layout
\end_inset
,
+\begin_inset space \thinspace{}
+\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.
-\change_inserted -712698321 1353866806
+] 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 \SpecialChar TeX
+ code or URL.
+ A kludge.
\end_layout
\begin_layout Description
-
-\change_inserted -712698321 1354263134
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1353866810
-RightDelim
+ForceOwnlines
\end_layout
\end_inset
\begin_layout Plain Layout
-\change_inserted -712698321 1353866806
-string
+\emph on
+0
\end_layout
\end_inset
-] A string that is put at the end of the layout content.
- A line break in the output can be indicated by
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted -712698321 1354263134
-<br/>
+1
\end_layout
\end_inset
-.
-\change_unchanged
-
+] Force a a line break in the \SpecialChar LaTeX
+ output before the inset starts and after
+ the inset ends.
+ This assures the inset itself is output on its own lines, for parsing purposes.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Spellcheck
+ForcePlain
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
+\emph on
0
\end_layout
\end_inset
,
+\begin_inset space \thinspace{}
+\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
+] Indicates whether the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Counters
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Counters"
+\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 Standard
-Since version 1.3.0 of LyX, it is both possible and necessary to define the
- counters (
-\begin_inset Flex MenuItem
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-chapter
+FreeSpacing
\end_layout
\end_inset
-,
-\begin_inset Flex 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 space \thinspace{}
+\end_inset
+
+
\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
-\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
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
-' is replaced by the name of the counter.
- And it must end with
-\begin_inset Quotes eld
\end_inset
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-End
+HTML*
\end_layout
\end_inset
+ These tags control the XHTML output.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Tags-for-XHTML"
-\begin_inset Quotes erd
\end_inset
.
- The following parameters can also be used:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+InToc
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+,
+\begin_inset space \thinspace{}
\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
+1
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
+] 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_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+KeepEmpty
\end_layout
\end_inset
- will be replaced by the expansion of the
+ [
+\emph on
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelString
+0
\end_layout
\end_inset
- (or
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelStringAppendix
-\end_layout
+\emph default
+,
+\begin_inset space \thinspace{}
\end_inset
-) of the counter
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-counter
+1
\end_layout
\end_inset
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
.
-
\end_layout
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LabelFont
+\end_layout
-\backslash
+\end_inset
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
-\end_layout
+ The font used for the label.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
\end_inset
-, where
+.
+ Note that this definition can never appear before
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+Font
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Actually, the situation is a bit more complicated: any
-\family default
-\series default
-\shape default
-\emph default
-\bar default
-
-\size default
-\emph on
-\noun default
-\color inherit
-numbertype
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
- other than those described below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+LabelString
\end_layout
\end_inset
-
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-arabic
+string
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-alph
+\SpecialChar TeX
+ code
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-;
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Alph
+Branch
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
+) modify this label on the fly.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-roman
+LangPreamble
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
+ Language dependent preamble; see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:I18n"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Roman
+LatexName
\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
+<name>
\end_layout
\end_inset
- for hebrew numerals.
+] The name of the corresponding \SpecialChar LaTeX
+ stuff.
+ Either the environment or command name.
\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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-master
+LatexParam
\end_layout
\end_inset
- (defined via
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Within
+<parameter>
\end_layout
\end_inset
-), the string
+] The optional parameter for the corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+LatexName
+\end_layout
-\backslash
-themaster.
-\backslash
-arabic{counter}
+\end_inset
+
+ stuff, including possible bracket pairs like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+[]
\end_layout
\end_inset
- is used; otherwise the string
+.
+ This parameter cannot be changed from within \SpecialChar LyX
+ (use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+Argument
+\end_layout
-\backslash
-arabic{counter}
+\end_inset
+
+ for customizable parameters).
+ It will be output as is after all \SpecialChar LaTeX
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Argument
\end_layout
\end_inset
- is used.
+s.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+LatexType
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+Command, Environment, None
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] Same as
-\begin_inset Flex Code
+] How the style should be translated into \SpecialChar LaTeX
+.
+\begin_inset Foot
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
+LatexType
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+ is perhaps a bit misleading, since these rules apply to SGML classes too.
+ Visit the SGML class files for specific examples.
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-\begin_inset Quotes erd
+\begin_inset Separator latexpar
\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
+\end_layout
-.
- The string should contain
-\begin_inset Quotes eld
-\end_inset
+\begin_deeper
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+None
+\end_layout
-##
-\begin_inset Quotes erd
\end_inset
-.
- This will be replaced by the counter number itself.
- So, for sections, it would be: Section ##.
+ means nothing special
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Within
+Command
\end_layout
\end_inset
- [
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\backslash
+
+\emph on
+LatexName
+\emph default
+{\SpecialChar ldots
+}
+\end_layout
-=
-\begin_inset Quotes erd
\end_inset
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-] 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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-subsection
+Environment
\end_layout
\end_inset
- is numbered inside
+ means
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-section
-\end_layout
-\end_inset
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar ldots
-.
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\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:
+Putting the last few things together, the \SpecialChar LaTeX
+ output will be either:
\end_layout
\begin_layout LyX-Code
-Font
-\family roman
-\emph on
-or
-\family default
-\emph default
- LabelFont
+
+\backslash
+LatexName[LatexParam]{\SpecialChar ldots
+}
\end_layout
-\begin_layout LyX-Code
- ...
+\begin_layout Standard
+or:
\end_layout
\begin_layout LyX-Code
-EndFont
+
+\backslash
+begin{LatexName}[LatexParam] \SpecialChar ldots
+
+\backslash
+end{LatexName}
\end_layout
\begin_layout Standard
-The following commands are available:
+depending upon the \SpecialChar LaTeX
+ type.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Color
+LeftDelim
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\emph on
-none
+string
\end_layout
\end_inset
-,
+] A string that is put at the beginning of the layout content.
+ A line break in the output can be indicated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-black
+<br/>
\end_layout
\end_inset
-,
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-white
+LyxType
\end_layout
\end_inset
-,
+ Can be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-red
+charstyle
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-green
+custom
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-blue
+element
\end_layout
\end_inset
-,
+ or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-cyan
+end
\end_layout
\end_inset
-,
+ (indicating a dummy definition ending definitions of charstyles, etc).
+ This entry is required in and is only meaningful for Flex insets.
+ Among other things, it determines on which menu this inset will appear.
+ Setting
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-magenta
+LyXType
\end_layout
\end_inset
-,
+ to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-yellow
+charstyle
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Description
+ will automatically set
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+MultiPar
\end_layout
\end_inset
- [
+ to false.
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Roman
+MultiPar
\end_layout
\end_inset
-,
+ can be set to true for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Sans
+charstyle
\end_layout
\end_inset
-,
+ insets by setting it
+\emph on
+after
+\emph default
+ you set the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+LyXType
\end_layout
\end_inset
-]
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Misc
+MultiPar
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-] Valid arguments are:
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+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
-noun
+CustomPars
\end_layout
\end_inset
-,
+ to the same value and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-strikeout
+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
-underbar
+MultiPar
\end_layout
\end_inset
-,
+.
+ Default is true.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uuline
+NeedProtect
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-uwave
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+1
\end_layout
\end_inset
-,
+] Whether fragile commands in this inset should be
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_noun
-\end_layout
-\end_inset
+\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
-no_strikeout
+NoInsetLayout
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_bar
+<layout>
\end_layout
\end_inset
-,
+] Deletes an existing
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uuline
+InsetLayout
\end_layout
\end_inset
- and
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_uwave
+ObsoletedBy
\end_layout
\end_inset
-.
- Each of these turns on or off the corresponding attribute.
- For example,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-emph
+<layout>
\end_layout
\end_inset
- turns on emphasis, and
+] Name of an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+InsetLayout
\end_layout
\end_inset
- turns it off.
-
-\begin_inset Newline newline
+ that has replaced this
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+InsetLayout
+\end_layout
+
\end_inset
-If the latter seems puzzling, remember that the font settings for the present
- context are generally inherited from the surrounding context.
- So
+.
+ This is used to rename an
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-no_emph
+InsetLayout
\end_layout
\end_inset
- would turn off the emphasis that was anyway in effect, say, in a theorem
- environment.
+, while keeping backward compatibility.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Series
+ParbreakIsNewline
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-Medium
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Bold
+1
\end_layout
\end_inset
-]
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+ Default is false.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Shape
+PassThru
\end_layout
\end_inset
\begin_layout Plain Layout
\emph on
-Up
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Italic
+1
\end_layout
\end_inset
-,
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-SmallCaps
-\end_layout
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
\end_inset
-,
+.
+ Default is false.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Slanted
+Preamble
\end_layout
\end_inset
-]
+ As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Size
+RefPrefix
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-tiny
+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
-small
+Requires
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-normal
+string
\end_layout
\end_inset
-,
+] As with paragraph styles, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Paragraph-Styles"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-large
+ResetArgs
\end_layout
\end_inset
-,
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-larger
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-largest
+1
\end_layout
\end_inset
-,
+] Resets the \SpecialChar LaTeX
+ arguments of this layout (as defined via the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-huge
+Argument
\end_layout
\end_inset
-,
+ tag).
+ This is useful if you have copied a style via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-giant
-\end_layout
-
-\end_inset
-
-]
+CopyStyle
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Citation-format-description"
-
\end_inset
-Citation format description
+, but you do not want to inherit its (required and optional) arguments.
\end_layout
-\begin_layout Standard
-The
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+ResetsFont
\end_layout
\end_inset
- blocks are used to describe how bibliographic information should be displayed,
- both within LyX itself (in the citation dialog and in tooltips, for example)
- and in XHTML output.
- Such a block might look like this:
-\end_layout
+ [
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-CiteFormat
+\begin_layout Plain Layout
+0
\end_layout
-\begin_layout LyX-Code
- article ...
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- book ...
-\end_layout
+,
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout LyX-Code
-End
-\end_layout
-\begin_layout Standard
-The individual lines define how the bibliographic information associated
- with an article or book, respectively, is to be displayed, and such a definitio
-n can be given for any `entry type' that might be present in a BibTeX file.
- LyX defines a default format in the source code that will be used if no
- specific definition has been given.
- LyX predefines several formats in the file
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+
+\emph on
+1
\end_layout
\end_inset
-, which is included in most of LyX's document classes.
+] Whether this inset should use the font of its surrounding environment
+ or uses its own.
+ Default is false: use the font of the surrounding environment.
\end_layout
-\begin_layout Standard
-The definitions use a simple language that allows BibTeX keys to be replaced
- with their values.
- Keys should be enclosed in
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%
+RightDelim
\end_layout
\end_inset
- signs, e.g.:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%author%
+string
\end_layout
\end_inset
-.
- So a simple definition might look like this:
-\end_layout
+] A string that is put at the end of the layout content.
+ A line break in the output can be indicated by
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-misc %author%,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+<br/>
+\end_layout
-%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_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%volume%[[vol.
-\begin_inset space ~
-\end_inset
-
-%volume%]]}
+Spellcheck
\end_layout
\end_inset
-.
- This says: If the
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-volume
+0
\end_layout
\end_inset
- key exists, then print
-\begin_inset Quotes eld
-\end_inset
-
-vol.
-\begin_inset space ~
+,
+\begin_inset space \thinspace{}
\end_inset
-\begin_inset Quotes erd
-\end_inset
-
- followed by the volume key.
- It is also possible to have an else clause in the conditional, such as:
-
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{%author%[[%author%]][[%editor%, ed.]]}
+
+\emph on
+1
\end_layout
\end_inset
-.
- Here, the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-author
+] Allow spell-checking the contents of this inset.
+ Default is true.
\end_layout
-\end_inset
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Counters"
- key is printed if it exists; otherwise, the editor key is printed, followed
- by
-\begin_inset Quotes eld
\end_inset
-,
-\begin_inset space ~
-\end_inset
-ed.
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- Note that the key is again enclosed in
-\begin_inset Flex Code
+\begin_layout Standard
+It is necessary to define the counters (
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-%
+chapter
\end_layout
\end_inset
- signs; the entire conditional is enclosed in braces; and the if and else
- clauses are enclosed in double brackets,
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex Code
+,
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-[[
+figure
\end_layout
\end_inset
-
-\begin_inset Quotes eld
-\end_inset
-
- and
-\begin_inset Quotes eld
-\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_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
-.
- There must be no space between any of these.
+\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
-There is one other piece of syntax available in definitions, which looks
- like this:
+where of course `
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{!<i>!}
+CounterName
\end_layout
\end_inset
-.
- This defines a piece of formatting information that is to be used when
- creating
-\begin_inset Quotes eld
-\end_inset
-
-rich text
-\begin_inset Quotes erd
-\end_inset
-
-.
- Obviously, we do not want to output HTML tags when writing plain text,
- so they should be wrapped in
-\begin_inset Quotes eld
-\end_inset
-
-{!
-\begin_inset Quotes erd
-\end_inset
-
- and
+' is replaced by the name of the counter.
+ And it must end with
\begin_inset Quotes eld
\end_inset
-!}
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-\begin_layout Standard
-Two special sorts of definitions are also possible in a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
+End
\end_layout
\end_inset
- block.
- An example of the first would be:
-\end_layout
-
-\begin_layout LyX-Code
-!quotetitle
-\begin_inset Quotes eld
-\end_inset
-%title%
\begin_inset Quotes erd
\end_inset
-
+.
+ The following parameters can also be used:
\end_layout
-\begin_layout Standard
-This is an abbreviation, or macro, and it can be used by treating it as
- if it were a key:
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+InitialValue
\end_layout
\end_inset
-.
- LyX will treat
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%!quotetitle%
+int=1
\end_layout
\end_inset
- exactly as it would treat its definition.
- So, let us issue the obvious
-\emph on
-warning
-\emph default
-.
- Do not do this:
-\end_layout
-
-\begin_layout LyX-Code
-!funfun %funfun%
+] Sets the initial value for the counter, to which it will be reset whenever
+ that happens.
+ Normally, one will want the default, 1.
\end_layout
-\begin_layout Standard
-or anything like it.
- LyX shouldn't go into an infinite loop, but it may go into a long one before
- it gives up.
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-The second sort of special definition might look like this:
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout LyX-Code
-_pptext pp.
-\end_layout
+\end_inset
-\begin_layout Standard
-This defines a translatable piece of text, which allows relevant parts of
- the bibliography to be translated.
- It can be included in a definition by treating it as a key:
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%_pptext%
+string
\end_layout
\end_inset
-.
- Several of these are predefined in
+=
+\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
-stdciteformats.inc
+LabelStringAppendix
\end_layout
\end_inset
-.
- Note that these are not macros, in the sense just defined.
- They will not be expanded.
-\end_layout
+ to the same value.
+ The following special constructs can be used in the string:
+\begin_inset Separator latexpar
+\end_inset
-\begin_layout Standard
-So here then is an example that use all these features:
-\end_layout
-\begin_layout LyX-Code
-!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
\end_layout
-\begin_layout Standard
-This defines a macro that prints the author, followed by a comma, if the
-
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-author
+
+\backslash
+thecounter
\end_layout
\end_inset
- key is defined, or else prints the name of the editor, followed by the
-
+ will be replaced by the expansion of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-_edtext
+LabelString
\end_layout
\end_inset
- or its translation (it is by default
-\begin_inset Quotes eld
-\end_inset
-
-ed.
-\begin_inset Quotes erd
-\end_inset
-
-), if the
+ (or
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-editor
+LabelStringAppendix
\end_layout
\end_inset
- key is defined.
- Note that this is in fact defined in
+) of the counter
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdciteformats.inc
+counter
\end_layout
\end_inset
-, so you can use it in your own definitions, or re-definitions, if you load
- that file first.
+.
+
\end_layout
-\begin_layout Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Tags-for-XHTML"
-
+\begin_layout Itemize
+counter values can be expressed using \SpecialChar LaTeX
+-like macros
+\begin_inset Newline newline
\end_inset
-Tags for XHTML output
-\end_layout
-\begin_layout Standard
-As with LaTeX or DocBook, the format of LyX's XHTML output is also controlled
- by layout information.
- In general, LyX provides sensible defaults and, as mentioned earlier, it
- will even construct default CSS style rules from the other layout tags.
- For example, LyX will attempt to use the information provided in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
-\end_layout
-
-\end_inset
- declaration for the Chapter style to write CSS that will appropriately
- format chapter headings.
-\end_layout
+\backslash
-\begin_layout Standard
-In many cases, then, you may not have to do anything at all to get acceptable
- XHTML output for your own environments, custom insets, and so forth.
- But in some cases you will, and so LyX provides a number of layout tags
- that can be used to customize the XHTML and CSS that are generated.
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
-\begin_layout Standard
-Note that there are two tags,
+\end_inset
+
+, where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+
+\emph on
+numbertype
\end_layout
\end_inset
- and
+ can be:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+Actually, the situation is a bit more complicated: any
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\size default
+\emph on
+\noun default
+\color inherit
+numbertype
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ other than those described below will produce arabic numerals.
+ It would not be surprising to see this change in the future.
+\end_layout
+
+\end_inset
+
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-AddToHTMLPreamble
+arabic
\end_layout
\end_inset
- that may appear outside style and inset declarations.
- See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:General-text-class"
+: 1, 2, 3,\SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+alph
+\end_layout
\end_inset
- for details on these.
+ for lower-case letters: a, b, c, \SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Alph
\end_layout
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Paragraph-Style-XHTML"
+\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
-Paragraph styles
+ for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
+;
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Roman
\end_layout
-\begin_layout Standard
-The sort of XHTML LyX outputs for a paragraph depends upon whether we are
- dealing with a normal paragraph, a command, or an environment, where this
- is itself determined by the contents of the corresponding
+\end_inset
+
+ for upper-case roman numerals: I, II, III\SpecialChar ldots
+;
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaTeXType
+hebrew
\end_layout
\end_inset
- tag.
-
+ for hebrew numerals.
\end_layout
+\end_deeper
\begin_layout Standard
-For a command or normal paragraph, the output XHTML has the following form:
+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
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ (defined via
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+Within
\end_layout
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
+), the string
+\begin_inset Newline newline
\end_inset
->Label</labeltag>
-\end_layout
-\begin_layout LyX-Code
-Contents of the paragraph.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
\end_layout
-\begin_layout LyX-Code
-</tag>
+\end_inset
+
+ is used; otherwise the string
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{counter}
\end_layout
-\begin_layout Standard
-The label tags are of course omitted if the paragraph does not have a label.
+\end_inset
+
+ is used.
\end_layout
-\begin_layout Standard
-For an environment that is not some sort of list, the XHTML takes this form:
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelStringAppendix
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
\end_inset
-value
+=
\begin_inset Quotes erd
\end_inset
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-value
\begin_inset Quotes erd
\end_inset
->Environment Label</labeltag>First paragraph.</itemtag>
-\end_layout
+] Same as
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-<itemtag>Second paragraph.</itemtag>
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout LyX-Code
-</tag>
-\end_layout
+\end_inset
-\begin_layout Standard
-Note that the label is output only for the first paragraph, as it should
- be for a theorem, for example.
-
+, but for use in the Appendix.
\end_layout
-\begin_layout Standard
-For a list, we have one of these forms:
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+PrettyFormat
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
\end_inset
-value
+=
\begin_inset Quotes erd
\end_inset
-><labeltag attr=
-\begin_inset Quotes erd
-\end_inset
-value
\begin_inset Quotes erd
\end_inset
->List Label</labeltag>First item.</itemtag>
-\end_layout
-
-\begin_layout LyX-Code
-<itemtag attr=
-\begin_inset Quotes erd
+] 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
-value
+Section 2.4
\begin_inset Quotes erd
\end_inset
-><labeltag attr=
-\begin_inset Quotes erd
+.
+ The string should contain
+\begin_inset Quotes eld
\end_inset
-value
+##
\begin_inset Quotes erd
\end_inset
->List Label</labeltag>Second item.</itemtag>
-\end_layout
-
-\begin_layout LyX-Code
-</tag>
+.
+ This will be replaced by the counter number itself.
+ So, for sections, it would be: Section ##.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+Within
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ [
+\begin_inset Flex Code
+status collapsed
->
+\begin_layout Plain Layout
+string
\end_layout
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
+=
\begin_inset Quotes erd
\end_inset
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
-\end_inset
-value
\begin_inset Quotes erd
\end_inset
->First item.</itemtag>
+] 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
-\begin_layout LyX-Code
-<labeltag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ is numbered inside
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+section
+\end_layout
->List Label</labeltag><itemtag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
+.
+\end_layout
+
+\begin_layout Subsection
+Font description
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Font-description"
+
\end_inset
->Second item.</itemtag>
+
+\end_layout
+
+\begin_layout Standard
+A font description looks like this:
\end_layout
\begin_layout LyX-Code
-</tag>
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
+\emph on
+ or
+\emph default
+ DefaultFont
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+EndFont
\end_layout
\begin_layout Standard
-Note the different orders of
+The following commands are available:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-labeltag
+Color
\end_layout
\end_inset
- and
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-itemtag
+
+\emph on
+none
\end_layout
\end_inset
-.
- Which order we get depends upon the setting of
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+black
\end_layout
\end_inset
-: If
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+white
\end_layout
\end_inset
- is false (the default), you get the first of these, with the label within
- the item; if true, you get the second, with the label outside the item.
-\end_layout
-
-\begin_layout Standard
-The specific tags and attributes output for each paragraph type can be controlle
-d by means of the layout tags we are about to describe.
- As mentioned earlier, however, LyX uses sensible defaults for many of these,
- so you often may not need to do very much to get good XHTML output.
- Think of the available tags as there so you can tweak things to your liking.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+red
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+green
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`mydiv'
+blue
\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+cyan
+\end_layout
-.
- By default, LyX will output
-\begin_inset Quotes eld
\end_inset
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname'
+magenta
\end_layout
\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+yellow
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, where
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-layoutname
+brown
\end_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
+darkgray
\end_layout
\end_inset
- for that purpose.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+gray
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+lightgray
\end_layout
\end_inset
-] Whether to output the default CSS information LyX generates for this layout,
- even if additional information is explicitly provided via
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+lime
\end_layout
\end_inset
-.
- Setting this to
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+orange
\end_layout
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+olive
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLItem
+pink
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+purple
\end_layout
\end_inset
-] The tag to be used for individual paragraphs of environments, replacing
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-itemtag
+teal
\end_layout
\end_inset
- in the examples above.
- Defaults to
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+violet
\end_layout
\end_inset
-.
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLItemAttr
+Family
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-\end_inset
+\emph on
+Roman
+\end_layout
-] Attributes for the item tag.
- Defaults to
-\begin_inset Quotes eld
\end_inset
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname_item'
+Sans
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\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
+Typewriter
\end_layout
\end_inset
- for that purpose.
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLLabel
+Misc
\end_layout
\end_inset
\end_inset
-] The tag to be used for paragraph and item labels, replacing
+] Valid arguments are:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-labeltag
+emph
\end_layout
\end_inset
- in the examples above.
- Defaults to
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
+noun
\end_layout
\end_inset
-, unless
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LabelType
+strikeout
\end_layout
\end_inset
- is either
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+underbar
\end_layout
\end_inset
- or
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+uuline
\end_layout
\end_inset
-, in which case it defaults to
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+uwave
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelAttr
+no_emph
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+no_noun
\end_layout
\end_inset
-] Attributes for the label tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
-
-
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`layoutname_label'
+no_strikeout
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\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
+no_bar
\end_layout
\end_inset
- for that purpose.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLLabelFirst
+no_uuline
\end_layout
\end_inset
- [
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
-\emph default
-,1
+no_uwave
\end_layout
\end_inset
-] Meaningful only for list-like environments, this tag controls whether
- the label tag is output before or inside the item tag.
- This is used, for example, in the description environment, where we want
- `
+.
+ Each of these turns on or off the corresponding attribute.
+ For example,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<dt>\SpecialChar \ldots{}
-</dt><dd>\SpecialChar \ldots{}
-</dd>
+emph
\end_layout
\end_inset
-.
- Default is
+ turns on emphasis, and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0
+no_emph
\end_layout
\end_inset
-: The label tag is output inside the item tag.
-\end_layout
+ turns it off.
+
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+If the latter seems puzzling, remember that the font settings for the present
+ context are generally inherited from the surrounding context.
+ So
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+no_emph
\end_layout
\end_inset
- Information to be output in the
+ would turn off the emphasis that was anyway in effect, say, in a theorem
+ environment.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<head>
+Series
\end_layout
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+
+\emph on
+Medium
\end_layout
\end_inset
- block defining an
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-onclick
+Bold
\end_layout
\end_inset
- handler.
+]
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+Shape
\end_layout
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
+ [
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+
+\emph on
+Up
\end_layout
\end_inset
- block, so only the CSS itself need be included.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTag
+Italic
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+SmallCaps
\end_layout
\end_inset
-] The tag to be used for the main label, replacing
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+Slanted
\end_layout
\end_inset
- in the examples above.
- Defaults to
+]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+Size
\end_layout
\end_inset
-.
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tiny
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLTitle
+small
\end_layout
\end_inset
- [
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
-0
-\emph default
-,1
+normal
\end_layout
\end_inset
-] Marks this style as the one to be used to generate the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<title>
+large
\end_layout
\end_inset
- tag for the XHTML file.
- By default, it is false.
- The
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-stdtitle.inc
+larger
\end_layout
\end_inset
- file sets it to true for the
+,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-title
+largest
\end_layout
\end_inset
- environment.
-
-\end_layout
-
-\begin_layout Subsection
-InsetLayout XHTML
-\end_layout
-
-\begin_layout Standard
-The XHTML output of insets can also be controlled by information in layout
- files.
-\begin_inset Foot
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-At present, this is true only for
-\begin_inset Quotes eld
-\end_inset
+huge
+\end_layout
-text
-\begin_inset Quotes erd
\end_inset
- insets (insets you can type into) and is not true for
-\begin_inset Quotes eld
-\end_inset
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+giant
+\end_layout
-command
-\begin_inset Quotes erd
\end_inset
- insets (insets that are associated with dialog boxes).
+]
\end_layout
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Citation-format-description"
+
\end_inset
- Here, too, LyX tries to provide sensible defaults, and it constructs default
- CSS style rules.
- But everything can be customized.
+Citation format description
\end_layout
\begin_layout Standard
-The XHTML LyX outputs for an inset has the following form:
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+CiteFormat
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
\end_inset
-value
-\begin_inset Quotes erd
-\end_inset
+ blocks are used to describe how bibliographic information should be displayed,
+ both within \SpecialChar LyX
+ itself (in the citation dialog and in tooltips, for example)
+ and in XHTML output.
+ Such a block might look like this:
+\end_layout
->
+\begin_layout LyX-Code
+CiteFormat
\end_layout
\begin_layout LyX-Code
-<labeltag>Label</labeltag>
+ article ...
\end_layout
\begin_layout LyX-Code
-<innertag attr=
-\begin_inset Quotes erd
-\end_inset
+ book ...
+\end_layout
-value
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+End
+\end_layout
->Contents of the inset.</innertag>
+\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 Bib\SpecialChar TeX
+ file.
+ \SpecialChar LyX
+ defines a default format in the source code that will be used if no specific
+ definition has been given.
+ \SpecialChar LyX
+ predefines several formats in the file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
\end_layout
-\begin_layout LyX-Code
-</tag>
+\end_inset
+
+, which is included in most of \SpecialChar LyX
+'s document classes.
\end_layout
\begin_layout Standard
-If the inset permits multiple paragraphs---that is, if
+The definitions use a simple language that allows Bib\SpecialChar TeX
+ keys to be replaced
+ with their values.
+ Keys should be enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+%
\end_layout
\end_inset
- is true---then the contents of the inset will itself be output as paragraphs
- formatted according to the styles used for those paragraphs (standard,
- quote, and the like).
- The label tag is of course omitted if the paragraph does not have a label
- and, at present, is always
+ signs, e.g.:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
+%author%
\end_layout
\end_inset
.
- The inner tag is optional and, by default, does not appear.
+ So a simple definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+misc %author%,
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-The specific tags and attributes output for each inset can be controlled
- by means of the following layout tags.
+This would print the author, followed by a comma, followed by the title,
+ in quotes, followed by a period.
\end_layout
-\begin_layout Description
+\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
-HTMLAttr
+{%volume%[[vol.
+\begin_inset space ~
+\end_inset
+
+%volume%]]}
\end_layout
\end_inset
- [
+.
+ This says: If the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+volume
\end_layout
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
+ 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 Newline newline
+\end_inset
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`myinset' onclick=`\SpecialChar \ldots{}
-'
+{%author%[[%author%]][[%editor%, ed.]]}
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Newline newline
+\end_inset
+
+Here, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
\end_layout
\end_inset
+ key is printed if it exists; otherwise, the editor key is printed, followed
+ by
+\begin_inset Quotes eld
+\end_inset
+
+,
+\begin_inset space ~
+\end_inset
+ed.
\begin_inset Quotes erd
\end_inset
-.
- By default, LyX will output
+ Note that the key is again enclosed in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%
+\end_layout
+
+\end_inset
+
+ signs; the entire conditional is enclosed in braces; and the if and else
+ clauses are enclosed in double brackets,
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Plain Layout
-class=`insetname'
+[[
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+]]
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, where
+.
+ There must be no space between any of these.
+\end_layout
+
+\begin_layout Standard
+There is one other piece of syntax available in definitions, which looks
+ like this:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-insetname
+{!<i>!}
\end_layout
\end_inset
- is the LyX name of the inset, made lowercase and with non-alphanumeric
- characters converted to underscores, for example: footnote.
+.
+ This defines a piece of formatting information that is to be used when
+ creating
+\begin_inset Quotes eld
+\end_inset
+
+rich text
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Obviously, we do not want to output HTML tags when writing plain text,
+ so they should be wrapped in
+\begin_inset Quotes eld
+\end_inset
+
+{!
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+!}
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Two special sorts of definitions are also possible in a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLForceCSS
+CiteFormat
\end_layout
\end_inset
- [
+ block.
+ An example of the first would be:
+\end_layout
+
+\begin_layout LyX-Code
+!quotetitle
+\begin_inset Quotes eld
+\end_inset
+
+%title%
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+This is an abbreviation, or macro, and it can be used by treating it as
+ if it were a key:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+
+.
+ \SpecialChar LyX
+ will treat
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+%!quotetitle%
+\end_layout
+
+\end_inset
+ exactly as it would treat its definition.
+ So, let us issue the obvious
\emph on
-0
+warning
\emph default
-,1
+.
+ Do not do this:
+\end_layout
+
+\begin_layout LyX-Code
+!funfun %funfun%
+\end_layout
+
+\begin_layout Standard
+or anything like it.
+ \SpecialChar LyX
+ shouldn't go into an infinite loop, but it may go into a long one before
+ it gives up.
+\end_layout
+
+\begin_layout Standard
+The second sort of special definition might look like this:
+\end_layout
+
+\begin_layout LyX-Code
+_pptext pp.
+\end_layout
+
+\begin_layout Standard
+This defines a translatable piece of text, which allows relevant parts of
+ the bibliography to be translated.
+ It can be included in a definition by treating it as a key:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%_pptext%
\end_layout
\end_inset
-] Whether to output the default CSS information LyX generates for this layout,
- even if additional information is explicitly provided via
+.
+ Several of these are predefined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+.
+ Note that these are not macros, in the sense just defined.
+ They will not be expanded.
+\end_layout
+
+\begin_layout Standard
+So here then is an example that use all these features:
+\begin_inset VSpace defskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
+
+\family typewriter
+!authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace defskip
+\end_inset
+
+This defines a macro that prints the author, followed by a comma, if the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
+ key is defined, or else prints the name of the editor, followed by the
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+_edtext
+\end_layout
+
+\end_inset
+
+ or its translation (it is by default
+\begin_inset Quotes eld
+\end_inset
+
+ed.
+\begin_inset Quotes erd
+\end_inset
+
+), if the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+editor
+\end_layout
+
+\end_inset
+
+ key is defined.
+ Note that this is in fact defined in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdciteformats.inc
+\end_layout
+
+\end_inset
+
+, so you can use it in your own definitions, or re-definitions, if you load
+ that file first.
+\end_layout
+
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Tags-for-XHTML"
+
+\end_inset
+
+Tags for XHTML output
+\end_layout
+
+\begin_layout Standard
+As with \SpecialChar LaTeX
+ or DocBook, the format of \SpecialChar LyX
+'s XHTML output is also controlled by
+ layout information.
+ In general, \SpecialChar LyX
+ provides sensible defaults and, as mentioned earlier, it will
+ even construct default CSS style rules from the other layout tags.
+ For example, \SpecialChar LyX
+ will attempt to use the information provided in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ declaration for the Chapter style to write CSS that will appropriately
+ format chapter headings.
+\end_layout
+
+\begin_layout Standard
+In many cases, then, you may not have to do anything at all to get acceptable
+ XHTML output for your own environments, custom insets, and so forth.
+ But in some cases you will, and so \SpecialChar LyX
+ provides a number of layout tags that
+ can be used to customize the XHTML and CSS that are generated.
+\end_layout
+
+\begin_layout Standard
+Note that there are two tags,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AddToHTMLPreamble
+\end_layout
+
+\end_inset
+
+ that may appear outside style and inset declarations.
+ See
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:General-text-class"
+
+\end_inset
+
+ for details on these.
+\end_layout
+
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Paragraph-Style-XHTML"
+
+\end_inset
+
+Paragraph styles
+\end_layout
+
+\begin_layout Standard
+The sort of XHTML \SpecialChar LyX
+ outputs for a paragraph depends upon whether we are dealing
+ with a normal paragraph, a command, or an environment, where this is itself
+ determined by the contents of the corresponding
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+\SpecialChar LaTeX
+Type
+\end_layout
+
+\end_inset
+
+ tag.
+
+\end_layout
+
+\begin_layout Standard
+For a command or normal paragraph, the output XHTML has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the paragraph.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The label tags are of course omitted if the paragraph does not have a label.
+\end_layout
+
+\begin_layout Standard
+For an environment that is not some sort of list, the XHTML takes this form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Environment Label</labeltag>First paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag>Second paragraph.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note that the label is output only for the first paragraph, as it should
+ be for a theorem, for example.
+
+\end_layout
+
+\begin_layout Standard
+For a list, we have one of these forms:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+><labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout LyX-Code
+
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>First item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>List Label</labeltag><itemtag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Second item.</itemtag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+Note the different orders of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+.
+ Which order we get depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ is false (the default), you get the first of these, with the label within
+ the item; if true, you get the second, with the label outside the item.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each paragraph type can be controlle
+d by means of the layout tags we are about to describe.
+ As mentioned earlier, however, \SpecialChar LyX
+ uses sensible defaults for many of these,
+ so you often may not need to do very much to get good XHTML output.
+ Think of the available tags as there so you can tweak things to your liking.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`mydiv'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+layoutname
+\end_layout
+
+\end_inset
+
+ is the \SpecialChar 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 Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLForceCSS
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Whether to output the default CSS information \SpecialChar LyX
+ generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+.
+ Setting this to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLItem
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for individual paragraphs of environments, replacing
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+itemtag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ 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 Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLItemAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the item tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname_item'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\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 Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for paragraph and item labels, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+labeltag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ Defaults to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_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 Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the label tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`layoutname_label'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\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 Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabelFirst
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Meaningful only for list-like environments, this tag controls whether
+ the label tag is output before or inside the item tag.
+ This is used, for example, in the description environment, where we want
+ `
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<dt>\SpecialChar ldots
+</dt><dd>\SpecialChar ldots
+</dd>
+\end_layout
+
+\end_inset
+
+.
+ Default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+: The label tag is output inside the item tag.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<script>
+\end_layout
+
+\end_inset
+
+ block defining an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
+\end_layout
+
+\end_inset
+
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+ Must end with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+EndHTMLStyle
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ 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 Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTitle
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Marks this style as the one to be used to generate the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<title>
+\end_layout
+
+\end_inset
+
+ tag for the XHTML file.
+ By default, it is false.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+stdtitle.inc
+\end_layout
+
+\end_inset
+
+ file sets it to true for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+title
+\end_layout
+
+\end_inset
+
+ environment.
+
+\end_layout
+
+\begin_layout Subsection
+InsetLayout XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output of insets can also be controlled by information in layout
+ files.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+At present, this is true only for
+\begin_inset Quotes eld
+\end_inset
+
+text
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets you can type into) and is not true for
+\begin_inset Quotes eld
+\end_inset
+
+command
+\begin_inset Quotes erd
+\end_inset
+
+ insets (insets that are associated with dialog boxes).
+\end_layout
+
+\end_inset
+
+ Here, too, \SpecialChar LyX
+ tries to provide sensible defaults, and it constructs default
+ CSS style rules.
+ But everything can be customized.
+\end_layout
+
+\begin_layout Standard
+The XHTML \SpecialChar LyX
+ outputs for an inset has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+<labeltag>Label</labeltag>
+\end_layout
+
+\begin_layout LyX-Code
+<innertag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>Contents of the inset.</innertag>
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+If the inset permits multiple paragraphs—that is, if
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true—then the contents of the inset will itself be output as paragraphs
+ formatted according to the styles used for those paragraphs (standard,
+ quote, and the like).
+ The label tag is of course omitted if the paragraph does not have a label
+ and, at present, is always
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+ The inner tag is optional and, by default, does not appear.
+\end_layout
+
+\begin_layout Standard
+The specific tags and attributes output for each inset can be controlled
+ by means of the following layout tags.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myinset' onclick=`\SpecialChar ldots
+'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+insetname
+\end_layout
+
+\end_inset
+
+ is the \SpecialChar LyX
+ name of the inset, made lowercase and with non-alphanumeric characters
+ converted to underscores, for example: footnote.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLForceCSS
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\emph default
+,1
+\end_layout
+
+\end_inset
+
+] Whether to output the default CSS information \SpecialChar LyX
+ generates for this layout,
+ even if additional information is explicitly provided via
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+.
+ Setting this to
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+ allows you to alter or augment the generated CSS, rather than to override
+ it completely.
+ Default is 0.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLInnerAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Attributes for the inner tag.
+ Defaults to
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`insetname_inner'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLInnerTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The inner tag, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+innertag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ By default, there is none.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLIsBlock
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+0,
+\emph on
+1
+\end_layout
+
+\end_inset
+
+] Whether this inset represents a standalone block of text (such as a footnote)
+ or instead represents material that is included in the surrounding text
+ (such as a branch).
+ Defaults to 1.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLLabel
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] A label for this inset, possibly including a reference to a counter.
+ For example, for footnote, it might be:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{footnote}
+\end_layout
+
+\end_inset
+
+.
+ This is optional, and there is no default.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLPreamble
+\end_layout
+
+\end_inset
+
+ Information to be output in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<head>
+\end_layout
+
+\end_inset
+
+ section when this style is used.
+ This might, for example, be used to include a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<script>
+\end_layout
+
+\end_inset
+
+ block defining an
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+onclick
+\end_layout
+
+\end_inset
+
+ handler.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this style is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for the main label, replacing
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+ in the examples above.
+ The default depends upon the setting of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+: If
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+MultiPar
+\end_layout
+
+\end_inset
+
+ is true, the default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+; if it is false, the default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Float XHTML
+\end_layout
+
+\begin_layout Standard
+The XHTML output for floats too can be controlled by layout information.
+ The output has the following form:
+\end_layout
+
+\begin_layout LyX-Code
+<tag attr=
+\begin_inset Quotes erd
+\end_inset
+
+value
+\begin_inset Quotes erd
+\end_inset
+
+>
+\end_layout
+
+\begin_layout LyX-Code
+Contents of the float.
+\end_layout
+
+\begin_layout LyX-Code
+</tag>
+\end_layout
+
+\begin_layout Standard
+The caption, if there is one, is a separate inset and will be output as
+ such.
+ Its appearance can be controlled via the InsetLayout for caption insets.
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLAttr
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Specifies attribute information to be output with the main tag.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`myfloat' onclick=`\SpecialChar ldots
+'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ By default, \SpecialChar LyX
+ will output
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class=`float float-floattype'
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+floattype
+\end_layout
+
+\end_inset
+
+ is \SpecialChar LyX
+'s name for this type of float, as determined by the float declaration
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Floats"
+
+\end_inset
+
+), though made lowercase and with non-alphanumeric characters converted
+ to underscores, for example: float-table.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLStyle
+\end_layout
+
+\end_inset
+
+ CSS style information to be included when this float is used.
+ Note that this will automatically be wrapped in a layout-generated
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<style>
+\end_layout
+
+\end_inset
+
+ block, so only the CSS itself need be included.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+HTMLTag
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] The tag to be used for this float, replacing
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tag
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the example above.
+ The default is
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
+
+\end_inset
+
+ 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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Citation-format-description"
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Subsection
+\SpecialChar LyX
+-generated CSS
+\end_layout
+
+\begin_layout Standard
+We have several times mentioned that \SpecialChar LyX
+ will generate default CSS style rules
+ for both insets and paragraph styles, based upon the other layout information
+ that is provided.
+ In this section, we shall say a word about which layout information \SpecialChar LyX
+ uses
+ and how.
+\end_layout
+
+\begin_layout Standard
+At present, \SpecialChar LyX
+ auto-generates CSS only for font information, making use of
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Series
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Shape
+\end_layout
+
+\end_inset
+
+, and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Size
+\end_layout
+
+\end_inset
+
+ specified in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\end_layout
+
+\end_inset
+
+ declaration (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Font-description"
+
+\end_inset
+
+).
+ The translation is mostly straightforward and obvious.
+ For example,
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Family Sans
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ becomes
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+font-family: sans-serif;
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The correspondence of \SpecialChar LyX
+ sizes and CSS sizes is a little less obvious but
+ nonetheless intuitive.
+ See the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+getSizeCSS()
+\end_layout
+
+\end_inset
+
+ function in
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+src/FontInfo.cpp
+\end_layout
+
+\end_inset
+
+ for the details.
+\end_layout
+
+\begin_layout Chapter
+Including External Material
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:Including-External-Material"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+use_makebox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+thickness "0.4pt"
+separation "3pt"
+shadowsize "4pt"
+framecolor "black"
+backgroundcolor "none"
+status open
+
+\begin_layout Plain Layout
+WARNING: This portion of the documentation has not been updated for some
+ time.
+ We certainly hope that it is still accurate, but there are no guarantees.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The use of material from sources external to \SpecialChar LyX
+ is covered in detail in the
+
+\emph on
+Embedded Objects
+\emph default
+ manual.
+ This part of the manual covers what needs to happen behind the scenes for
+ new sorts of material to be included.
+\end_layout
+
+\begin_layout Section
+How does it work?
+\end_layout
+
+\begin_layout Standard
+The external material feature is based on the concept of a
+\emph on
+template
+\emph default
+.
+ A template is a specification of how \SpecialChar LyX
+ should interface with a certain kind
+ of material.
+ As bundled, \SpecialChar 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 Noun
+status collapsed
+
+\begin_layout Plain Layout
+Insert\SpecialChar menuseparator
+File\SpecialChar menuseparator
+External Material
+\end_layout
+
+\end_inset
+
+.
+ Furthermore, it is possible to roll your own template to support a specific
+ kind of material.
+ Later we'll describe in more detail what is involved, and hopefully you
+ will submit all the templates you create so we can include them in a later
+ \SpecialChar LyX
+ version.
+\end_layout
+
+\begin_layout Standard
+Another basic idea of the external material feature is to distinguish between
+ the original file that serves as a base for final material and the produced
+ file that is included in your exported or printed document.
+ For example, consider the case of a figure produced with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Xfig
+\end_layout
+
+\end_inset
+
+.
+ The Xfig application itself works on an original file with the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.fig
+\end_layout
+
+\end_inset
+
+ extension.
+ Within Xfig, you create and change your figure, and when you are done,
+ you save the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+fig
+\end_layout
+
+\end_inset
+
+-file.
+ When you want to include the figure in your document, you invoke
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+transfig
+\end_layout
+
+\end_inset
+
+ in order to create a PostScript file that can readily be included in your
+ \SpecialChar LaTeX
+ file.
+ In this case, the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.fig
+\end_layout
+
+\end_inset
+
+ file is the original file, and the PostScript file is the produced file.
+\end_layout
+
+\begin_layout Standard
+This distinction is important in order to allow updating of the material
+ while you are in the process of writing the document.
+ Furthermore, it provides us with the flexibility that is needed to support
+ multiple export formats.
+ For instance, in the case of a plain text file, it is not exactly an award-winn
+ing idea to include the figure as raw PostScript.
+ Instead, you would either prefer to just include a reference to the figure
+ or try to invoke some graphics to ASCII converter to make the final result
+ look similar to the real graphics.
+ The external material management allows you to do this, because it is parametri
+zed on the different export formats that \SpecialChar LyX
+ supports.
+\end_layout
+
+\begin_layout Standard
+Besides supporting the production of different products according to the
+ exported format, it supports tight integration with editing and viewing
+ applications.
+ In the case of an Xfig figure, you are able to invoke Xfig on the original
+ file with a single click from within the external material dialog in \SpecialChar LyX
+,
+ and also preview the produced PostScript file with Ghostview with another
+ click.
+ No more fiddling around with the command line and/or file browsers to locate
+ and manipulate the original or produced files.
+ In this way, you are finally able to take full advantage of the many different
+ applications that are relevant to use when you write your documents, and
+ ultimately be more productive.
+\end_layout
+
+\begin_layout Section
+The external template configuration file
+\end_layout
+
+\begin_layout Standard
+It is relatively easy to add custom external template definitions to \SpecialChar LyX
+.
+ However, be aware that doing this in an careless manner most probably
+\emph on
+will
+\emph default
+ introduce an easily exploitable security hole.
+ So before you do this, please read the discussion about security in
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Security-discussion"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Having said that, we encourage you to submit any interesting templates that
+ you create.
+
+\end_layout
+
+\begin_layout Standard
+The external templates are defined in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyXDir/lib/external_templates
+\end_layout
+
+\end_inset
+
+ file.
+ You can place your own version in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir/external_templates
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+A typical template looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Template XFig
+\end_layout
+
+\begin_layout LyX-Code
+GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+\end_layout
+
+\begin_layout LyX-Code
+HelpText
+\end_layout
+
+\begin_layout LyX-Code
+An XFig figure.
+\end_layout
+
+\begin_layout LyX-Code
+HelpTextEnd
+\end_layout
+
+\begin_layout LyX-Code
+InputFormat fig
+\end_layout
+
+\begin_layout LyX-Code
+FileFilter "*.fig"
+\end_layout
+
+\begin_layout LyX-Code
+AutomaticProduction true
+\end_layout
+
+\begin_layout LyX-Code
+Transform Rotate
+\end_layout
+
+\begin_layout LyX-Code
+Transform Resize
+\end_layout
+
+\begin_layout LyX-Code
+Format \SpecialChar LaTeX
+
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pstex_t}
+\end_layout
+
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat pstex
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pstex_t"
+\end_layout
+
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile dvi "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Format PDF\SpecialChar LaTeX
+
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
+\end_layout
+
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat pdftex
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pdftex_t"
+\end_layout
+
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.pdf"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Format Ascii
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$Contents(
+\backslash
+"$$AbsPath$$Basename.asc
+\backslash
+")"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat asciixfig
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.asc"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Format DocBook
+\end_layout
+
+\begin_layout LyX-Code
+Product "<graphic fileref=
+\backslash
+"$$AbsOrRelPathMaster$$Basename.eps
+\backslash
+">
+\end_layout
+
+\begin_layout LyX-Code
+ </graphic>"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat eps
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile docbook "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Product "[XFig: $$FName]"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+TemplateEnd
+\end_layout
+
+\begin_layout Standard
+As you can see, the template is enclosed in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+Template
\end_layout
\end_inset
-.
- Setting this to
+ \SpecialChar ldots
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-1
+TemplateEnd
\end_layout
\end_inset
- allows you to alter or augment the generated CSS, rather than to override
- it completely.
- Default is 0.
-\end_layout
-
-\begin_layout Description
+.
+ It contains a header specifying some general settings and, for each supported
+ primary document file format, a section
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLInnerAttr
+Format
\end_layout
\end_inset
- [
+ \SpecialChar ldots
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
+FormatEnd
\end_layout
\end_inset
-] Attributes for the inner tag.
- Defaults to
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
+\begin_layout Subsection
+The template header
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`insetname_inner'
-\end_layout
-
+AutomaticProduction
+\begin_inset space ~
\end_inset
+true|false
+\end_layout
-\begin_inset Quotes erd
\end_inset
+ Whether the file represented by the template must be generated by \SpecialChar LyX
.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLInnerTag
+FileFilter
+\begin_inset space ~
+\end_inset
+
+<pattern>
\end_layout
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
-\end_layout
+ A glob pattern that is used in the file dialog to filter out the desired
+ files.
+ If there is more than one possible file extension (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
-] The inner tag, replacing
+tgif has
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-innertag
+.obj
\end_layout
\end_inset
- in the examples above.
- By default, there is none.
-\end_layout
-
-\begin_layout Description
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLIsBlock
+.tgo
\end_layout
\end_inset
- [
+), use something like
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-0,
-\emph on
-1
+"*.{obj,tgo}"
\end_layout
\end_inset
-] Whether this inset represents a standalone block of text (such as a footnote)
- or instead represents material that is included in the surrounding text
- (such as a branch).
- Defaults to 1.
+.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLLabel
-\end_layout
-
+GuiName
+\begin_inset space ~
\end_inset
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
+<guiname>
\end_layout
\end_inset
-] A label for this inset, possibly including a reference to a counter.
- For example, for footnote, it might be:
+ The text that is displayed on the button.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+HelpText
+\begin_inset space ~
+\end_inset
-\backslash
-arabic{footnote}
+<text>
+\begin_inset space ~
+\end_inset
+
+HelpTextEnd
\end_layout
\end_inset
-.
- This is optional, and there is no default.
+ The help text that is used in the External dialog.
+ Provide enough information to explain to the user just what the template
+ can provide him with.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLPreamble
+InputFormat
+\begin_inset space ~
+\end_inset
+
+<format>
\end_layout
\end_inset
- Information to be output in the
-\begin_inset Flex Code
-status collapsed
+ The file format of the original file.
+ This must be the name of a format that is known to \SpecialChar LyX
+ (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Formats"
-\begin_layout Plain Layout
-<head>
-\end_layout
+\end_inset
+).
+ Use
+\begin_inset Quotes eld
\end_inset
- section when this style is used.
- This might, for example, be used to include a
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<script>
+*
\end_layout
\end_inset
- block defining an
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-onclick
-\end_layout
+\begin_inset Quotes erd
\end_inset
- handler.
+ if the template can handle original files of more than one format.
+ \SpecialChar LyX
+ will attempt to interrogate the file itself in order to deduce its format
+ in this case.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLStyle
-\end_layout
-
+Template
+\begin_inset space ~
\end_inset
- CSS style information to be included when this style is used.
- Note that this will automatically be wrapped in a layout-generated
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-<style>
+<id>
\end_layout
\end_inset
- block, so only the CSS itself need be included.
+ A unique name for the template.
+ It must not contain substitution macros (see below).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTag
-\end_layout
-
-\end_inset
-
- [
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-string
-\end_layout
-
+Transform
+\begin_inset space ~
\end_inset
-] The tag to be used for the main label, replacing
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-tag
+Rotate|Resize|Clip|Extra
\end_layout
\end_inset
- in the examples above.
- The default depends upon the setting of
+ This command specifies which transformations are supported by this template.
+ It may occur zero or more times.
+ This command enables the corresponding tabs in the external dialog.
+ Each
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+Transform
\end_layout
\end_inset
-: If
+ command must have either a corresponding
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-MultiPar
+TransformCommand
\end_layout
\end_inset
- is true, the default is
+ or a
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+TransformOption
\end_layout
\end_inset
-; if it is false, the default is
+ command in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-span
+Format
\end_layout
\end_inset
-.
+ section.
+ Otherwise the transformation will not be supported by that format.
\end_layout
\begin_layout Subsection
-Float XHTML
-\end_layout
-
-\begin_layout Standard
-The XHTML output for floats too can be controlled by layout information.
- The output has the following form:
+The Format section
\end_layout
-\begin_layout LyX-Code
-<tag attr=
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-value
-\begin_inset Quotes erd
+\begin_layout Plain Layout
+Format
+\begin_inset space ~
\end_inset
->
-\end_layout
-
-\begin_layout LyX-Code
-Contents of the float.
-\end_layout
-
-\begin_layout LyX-Code
-</tag>
+LaTeX|PDFLaTeX|PlainText|DocBook
\end_layout
-\begin_layout Standard
-The caption, if there is one, is a separate inset and will be output as
- such.
- Its appearance can be controlled via the InsetLayout for caption insets.
-
-\end_layout
+\end_inset
-\begin_layout Description
+ 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 Code
status collapsed
\begin_layout Plain Layout
-HTMLAttr
+Format
\end_layout
\end_inset
- [
+ 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 Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-
+Option
+\begin_inset space ~
\end_inset
-] Specifies attribute information to be output with the main tag.
- For example,
-\begin_inset Quotes eld
+<name>
+\begin_inset space ~
\end_inset
+<value>
+\end_layout
+
+\end_inset
+ This command defines an additional macro
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`myfloat' onclick=`\SpecialChar \ldots{}
-'
+$$<name>
\end_layout
\end_inset
+ for substitution in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Product
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
- By default, LyX will output
-\begin_inset Quotes eld
-\end_inset
-
-
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-class=`float float-floattype'
+<value>
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-, where
+ itself may contain substitution macros.
+ The advantage over using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-floattype
+<value>
\end_layout
\end_inset
- is LyX's name for this type of float, as determined by the float declaration
- (see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Floats"
-
-\end_inset
-
-), though made lowercase and with non-alphanumeric characters converted
- to underscores, for example: float-table.
-\end_layout
-
-\begin_layout Description
+ directly in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-HTMLStyle
+Product
\end_layout
\end_inset
- CSS style information to be included when this float is used.
- Note that this will automatically be wrapped in a layout-generated
+ is that the substituted value of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-<style>
+$$<name>
\end_layout
\end_inset
- block, so only the CSS itself need be included.
+ is sanitized so that it is a valid optional argument in the document format.
+ This command may occur zero or more times.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HTMLTag
+Product
+\begin_inset space ~
+\end_inset
+
+<text>
\end_layout
\end_inset
- [
+ The text that is inserted in the exported document.
+ This is actually the most important command and can be quite complex.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-string
-\end_layout
-
+Preamble
+\begin_inset space ~
\end_inset
-] The tag to be used for this float, replacing
-\begin_inset Quotes eld
-\end_inset
+<name>
+\end_layout
+\end_inset
+ This command specifies a preamble snippet that will be included in the
+ \SpecialChar LaTeX
+ preamble.
+ It has to be defined using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-tag
+PreambleDef
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- in the example above.
- The default is
+ \SpecialChar ldots
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-div
+PreambleDefEnd
\end_layout
\end_inset
- and will rarely need changing.
-\end_layout
-
-\begin_layout Subsection
-Bibliography formatting
+.
+ This command may occur zero or more times.
\end_layout
-\begin_layout Standard
-The bibliography can be formatted using
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-CiteFormat
-\end_layout
-
+ReferencedFile
+\begin_inset space ~
\end_inset
- blocks.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Citation-format-description"
-
+<format>
+\begin_inset space ~
\end_inset
- for the details.
+<filename>
\end_layout
-\begin_layout Subsection
-LyX-generated CSS
-\end_layout
+\end_inset
-\begin_layout Standard
-We have several times mentioned that LyX will generate default CSS style
- rules for both insets and paragraph styles, based upon the other layout
- information that is provided.
- In this section, we shall say a word about which layout information LyX
- uses and how.
+ This command denotes files that are created by the conversion process and
+ are needed for a particular export format.
+ If the filename is relative, it is interpreted relative to the master document.
+ This command may be given zero or more times.
\end_layout
-\begin_layout Standard
-At present, LyX auto-generates CSS only for font information, making use
- of the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family
+Requirement
+\begin_inset space ~
+\end_inset
+
+<package>
\end_layout
\end_inset
-,
+ The name of a required \SpecialChar LaTeX
+ package.
+ The package is included via
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Series
+
+\backslash
+usepackage{}
\end_layout
\end_inset
-,
+ in the \SpecialChar LaTeX
+ preamble.
+ This command may occur zero or more times.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Shape
-\end_layout
-
+TransformCommand
+\begin_inset space ~
\end_inset
-, and
-\begin_inset Flex Code
-status collapsed
+Rotate
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-Size
+RotationLatexCommand
\end_layout
\end_inset
- specified in the
+ This command specifies that the built in \SpecialChar LaTeX
+ command should be used for rotation.
+ This command may occur once or not at all.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Font
-\end_layout
-
+TransformCommand
+\begin_inset space ~
\end_inset
- declaration.
- (See
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:Font-description"
-
+Resize
+\begin_inset space ~
\end_inset
-.) The translation is mostly straightforward and obvious.
- For example,
-\begin_inset Quotes eld
+ResizeLatexCommand
+\end_layout
+
\end_inset
+ This command specifies that the built in \SpecialChar LaTeX
+ command should be used for resizing.
+ This command may occur once or not at all.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Family Sans
-\end_layout
-
+TransformOption
+\begin_inset space ~
\end_inset
-
-\begin_inset Quotes erd
+Rotate
+\begin_inset space ~
\end_inset
- becomes
-\begin_inset Quotes eld
+RotationLatexOption
+\end_layout
+
\end_inset
+ This command specifies that rotation is done via an optional argument.
+ This command may occur once or not at all.
+\end_layout
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-font-family: sans-serif;
-\end_layout
+TransformOption
+\begin_inset space ~
+\end_inset
+Resize
+\begin_inset space ~
\end_inset
+ResizeLatexOption
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- The correspondence of LyX sizes and CSS sizes is a little less obvious
- but nonetheless intuitive.
- See the
+ This command specifies that resizing is done via an optional argument.
+ This command may occur once or not at all.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-getSizeCSS()
+TransformOption
+\begin_inset space ~
+\end_inset
+
+Clip
+\begin_inset space ~
+\end_inset
+
+ClipLatexOption
\end_layout
\end_inset
- function in
-\begin_inset Flex URL
+ This command specifies that clipping is done via an optional argument.
+ This command may occur once or not at all.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+TransformOption
+\begin_inset space ~
+\end_inset
-src/FontInfo.cpp
-\end_layout
-
+Extra
+\begin_inset space ~
\end_inset
- for the details.
+ExtraLatexOption
\end_layout
-\begin_layout Chapter
-Including External Material
+\end_inset
+
+ This command specifies that an extra optional argument is used.
+ This command may occur once or not at all.
\end_layout
-\begin_layout Standard
-\begin_inset Box Shadowbox
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "t"
-use_parbox 0
-use_makebox 0
-width "100col%"
-special "none"
-height "1in"
-height_special "totalheight"
-status open
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-WARNING: This portion of the documentation has not been updated for some
- time.
- We certainly hope that it is still accurate, but there are no guarantees.
-\end_layout
-
+UpdateFormat
+\begin_inset space ~
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-The use of material from sources external to LyX is covered in detail in
- the
-\emph on
-Embedded Objects
-\emph default
- manual.
- This part of the manual covers what needs to happen behind the scenes for
- new sorts of material to be included.
+<format>
\end_layout
-\begin_layout Section
-How does it work?
-\end_layout
+\end_inset
-\begin_layout Standard
-The external material feature is based on the concept of a
-\emph on
-template
-\emph default
-.
- A template is a specification of how LyX should interface with a certain
- kind of material.
- As bundled, LyX comes with predefined templates for Xfig figures, various
- raster format images, chess diagrams, and LilyPond music notation.
- You can check the actual list by using the menu
-\begin_inset Flex MenuItem
+ The file format of the converted file.
+ This must be the name of a format that is known to \SpecialChar LyX
+ (see the
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
-External Material
+Tools\SpecialChar menuseparator
+Preferences\SpecialChar menuseparator
+File Handling\SpecialChar menuseparator
+File Format
\end_layout
\end_inset
-.
- Furthermore, it is possible to roll your own template to support a specific
- kind of material.
- Later we'll describe in more detail what is involved, and hopefully you
- will submit all the templates you create so we can include them in a later
- LyX version.
-\end_layout
-
-\begin_layout Standard
-Another basic idea of the external material feature is to distinguish between
- the original file that serves as a base for final material and the produced
- file that is included in your exported or printed document.
- For example, consider the case of a figure produced with
+ dialog).
+ This command must occur exactly once.
+ If the resulting file format is PDF, you need to specify the format
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Xfig
+pdf6
\end_layout
\end_inset
.
- The Xfig application itself works on an original file with the
+ This is the PDF format used for including graphics.
+ The other defined PDF formats are for document export.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.fig
+UpdateResult
+\begin_inset space ~
+\end_inset
+
+<filename>
\end_layout
\end_inset
- extension.
- Within Xfig, you create and change your figure, and when you are done,
- you save the
+ The file name of the converted file.
+ The file name must be absolute.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Subsection
+Preamble definitions
+\end_layout
+
+\begin_layout Standard
+The external template configuration file may contain additional preamble
+ definitions enclosed by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-fig
+PreambleDef
\end_layout
\end_inset
--file.
- When you want to include the figure in your document, you invoke
+ \SpecialChar ldots
+
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-transfig
+PreambleDefEnd
\end_layout
\end_inset
- in order to create a PostScript file that can readily be included in your
- LaTeX file.
- In this case, the
+.
+ They can be used by the templates in the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.fig
+Format
\end_layout
\end_inset
- file is the original file, and the PostScript file is the produced file.
+ section.
\end_layout
-\begin_layout Standard
-This distinction is important in order to allow updating of the material
- while you are in the process of writing the document.
- Furthermore, it provides us with the flexibility that is needed to support
- multiple export formats.
- For instance, in the case of a plain text file, it is not exactly an award-winn
-ing idea to include the figure as raw PostScript.
- Instead, you would either prefer to just include a reference to the figure
- or try to invoke some graphics to ASCII converter to make the final result
- look similar to the real graphics.
- The external material management allows you to do this, because it is parametri
-zed on the different export formats that LyX supports.
+\begin_layout Section
+The substitution mechanism
\end_layout
\begin_layout Standard
-Besides supporting the production of different products according to the
- exported format, it supports tight integration with editing and viewing
- applications.
- In the case of an Xfig figure, you are able to invoke Xfig on the original
- file with a single click from within the external material dialog in LyX,
- and also preview the produced PostScript file with Ghostview with another
- click.
- No more fiddling around with the command line and/or file browsers to locate
- and manipulate the original or produced files.
- In this way, you are finally able to take full advantage of the many different
- applications that are relevant to use when you write your documents, and
- ultimately be more productive.
+When the external material facility invokes an external program, it is done
+ on the basis of a command defined in the template configuration file.
+ These commands can contain various macros that are expanded before execution.
+ Execution always take place in the directory of the containing document.
\end_layout
-\begin_layout Section
-The external template configuration file
+\begin_layout Standard
+Also, whenever external material is to be displayed, the name will be produced
+ by the substitution mechanism, and most other commands in the template
+ definition support substitution as well.
\end_layout
\begin_layout Standard
-It is relatively easy to add custom external template definitions to LyX.
- However, be aware that doing this in an careless manner most probably
-\emph on
-will
-\emph default
- introduce an easily exploitable security hole.
- So before you do this, please read the discussion about security in section
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Security-discussion"
+The available macros are the following:
+\end_layout
-\end_inset
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-.
+\begin_layout Plain Layout
+$$AbsOrRelPathMaster
\end_layout
-\begin_layout Standard
-Having said that, we encourage you to submit any interesting templates that
- you create.
-
+\end_inset
+
+ The file path, absolute or relative to the master \SpecialChar LyX
+ document.
\end_layout
-\begin_layout Standard
-The external templates are defined in the
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LyXDir/lib/external_templates
+$$AbsOrRelPathParent
\end_layout
\end_inset
- file.
- You can place your own version in
+ The file path, absolute or relative to the \SpecialChar LyX
+ document.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir/external_templates
+$$AbsPath
\end_layout
\end_inset
-.
+ The absolute file path.
\end_layout
-\begin_layout Standard
-A typical template looks like this:
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Template XFig
+\begin_layout Plain Layout
+$$Basename
\end_layout
-\begin_layout LyX-Code
-GuiName "XFig: $$AbsOrRelPathParent$$Basename"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-HelpText
+ The filename without path and without the extension.
\end_layout
-\begin_layout LyX-Code
-An XFig figure.
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-HelpTextEnd
-\end_layout
+\begin_layout Plain Layout
+$$Contents(
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-InputFormat fig
-\end_layout
+filename.ext
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-FileFilter "*.fig"
+)
\end_layout
-\begin_layout LyX-Code
-AutomaticProduction true
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Transform Rotate
-\end_layout
+ This macro will expand to the contents of the file with the name
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Transform Resize
+\begin_layout Plain Layout
+filename.ext
\end_layout
-\begin_layout LyX-Code
-Format LaTeX
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
+.
\end_layout
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
+\begin_layout Plain Layout
+$$Extension
\end_layout
-\begin_layout LyX-Code
-
-\backslash
+\end_inset
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pstex_t}
+ The file extension (including the dot).
\end_layout
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-UpdateFormat pstex
+\begin_layout Plain Layout
+$$pngOrjpg
\end_layout
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pstex_t"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Requirement "graphicx"
-\end_layout
+ This will be the string
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
-\end_layout
+jpg
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.eps"
-\end_layout
+ if the file is in JPEG format, otherwise it will be the string
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-ReferencedFile dvi "$$AbsPath$$Basename.eps"
-\end_layout
+png
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-FormatEnd
+.
+ This is useful to avoid uneeded conversions for output formats that support
+ both PNG and JPEG fomats.
+ The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
+ output
+ format.
\end_layout
-\begin_layout LyX-Code
-Format PDFLaTeX
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
+\begin_layout Plain Layout
+$$FName
\end_layout
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
+ The filename of the file specified in the external material dialog.
+ This is either an absolute name, or it is relative to the \SpecialChar LyX
+ document.
\end_layout
-\begin_layout LyX-Code
-
-\backslash
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
+\begin_layout Plain Layout
+$$FPath
\end_layout
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-UpdateFormat pdftex
-\end_layout
+ The path part of
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pdftex_t"
+\begin_layout Plain Layout
+$$FName
\end_layout
-\begin_layout LyX-Code
-Requirement "graphicx"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+ (absolute name or relative to the \SpecialChar LyX
+ document).
\end_layout
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.pdf"
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-FormatEnd
+\begin_layout Plain Layout
+$$RelPathMaster
\end_layout
-\begin_layout LyX-Code
-Format Ascii
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Product "$$Contents(
-\backslash
-"$$AbsPath$$Basename.asc
-\backslash
-")"
+ The file path, relative to the master \SpecialChar LyX
+ document.
\end_layout
-\begin_layout LyX-Code
-UpdateFormat asciixfig
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.asc"
+\begin_layout Plain Layout
+$$RelPathParent
\end_layout
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Format DocBook
+ The file path, relative to the \SpecialChar LyX
+ document.
\end_layout
-\begin_layout LyX-Code
-Product "<graphic fileref=
-\backslash
-"$$AbsOrRelPathMaster$$Basename.eps
-\backslash
-">
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
- </graphic>"
+\begin_layout Plain Layout
+$$Sysdir
\end_layout
-\begin_layout LyX-Code
-UpdateFormat eps
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.eps"
+ This macro will expand to the absolute path of the system directory.
+ This is typically used to point to the various helper scripts that are
+ bundled with \SpecialChar LyX
+.
\end_layout
-\begin_layout LyX-Code
-ReferencedFile docbook "$$AbsPath$$Basename.eps"
-\end_layout
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
-ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\begin_layout Plain Layout
+$$Tempname
\end_layout
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Product "[XFig: $$FName]"
+ A name and full path to a temporary file which will be automatically deleted
+ whenever the containing document is closed, or the external material insertion
+ deleted.
\end_layout
-\begin_layout LyX-Code
-FormatEnd
+\begin_layout Standard
+All path macros contain a trailing directory separator, so you can construct
+ e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+the absolute filename with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$AbsPath$$Basename$$Extension
\end_layout
-\begin_layout LyX-Code
-TemplateEnd
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-As you can see, the template is enclosed in
+The macros above are substituted in all commands unless otherwise noted.
+ The command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Template
+Product
\end_layout
\end_inset
- \SpecialChar \ldots{}
-
+ supports additionally the following substitutions if they are enabled by
+ the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TemplateEnd
+Transform
\end_layout
\end_inset
-.
- It contains a header specifying some general settings and, for each supported
- primary document file format, a section
+ and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Format
+TransformCommand
\end_layout
\end_inset
- \SpecialChar \ldots{}
-
+ commands:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-FormatEnd
+$$ResizeFront
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Subsection
-The template header
+ The front part of the resize command.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-AutomaticProduction
-\begin_inset space ~
+$$ResizeBack
+\end_layout
+
\end_inset
-true|false
+ The back part of the resize command.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$RotateFront
\end_layout
\end_inset
- Whether the file represented by the template must be generated by LyX.
- This command must occur exactly once.
+ The front part of the rotation command.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-FileFilter
-\begin_inset space ~
+$$RotateBack
+\end_layout
+
\end_inset
-<pattern>
+ The back part of the rotation command.
\end_layout
-\end_inset
+\begin_layout Standard
+The value string of the
+\begin_inset Flex Code
+status collapsed
- A glob pattern that is used in the file dialog to filter out the desired
- files.
- If there is more than one possible file extension (e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
+Option
+\end_layout
-g.
-\begin_inset space \space{}
\end_inset
-tgif has
+ command supports additionally the following substitutions if they are enabled
+ by the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.obj
+Transform
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-.tgo
+TransformOption
\end_layout
\end_inset
-), use something like
+ commands:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"*.{obj,tgo}"
+$$Clip
\end_layout
\end_inset
-.
- This command must occur exactly once.
+ The clip option.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-GuiName
-\begin_inset space ~
-\end_inset
-
-<guiname>
+$$Extra
\end_layout
\end_inset
- The text that is displayed on the button.
- This command must occur exactly once.
+ The extra option.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-HelpText
-\begin_inset space ~
-\end_inset
-
-<text>
-\begin_inset space ~
-\end_inset
-
-HelpTextEnd
+$$Resize
\end_layout
\end_inset
- The help text that is used in the External dialog.
- Provide enough information to explain to the user just what the template
- can provide him with.
- This command must occur exactly once.
+ The resize option.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-InputFormat
-\begin_inset space ~
-\end_inset
-
-<format>
+$$Rotate
\end_layout
\end_inset
- The file format of the original file.
- This must be the name of a format that is known to LyX (see section
-\begin_inset space ~
-\end_inset
-
+ The rotation option.
+\end_layout
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Formats"
+\begin_layout Standard
+You may ask why there are so many path macros.
+ There are mainly two reasons:
+\end_layout
-\end_inset
+\begin_layout Enumerate
+Relative and absolute file names should remain relative or absolute, respectivel
+y.
+ Users may have reasons to prefer either form.
+ Relative names are useful for portable documents that should work on different
+ machines, for example.
+ Absolute names may be required by some programs.
+\end_layout
-).
- Use
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
+\SpecialChar LaTeX
+ treats relative file names differently than \SpecialChar LyX
+ and other programs in nested
+ included files.
+ For \SpecialChar LyX
+, a relative file name is always relative to the document that contains
+ the file name.
+ For \SpecialChar LaTeX
+, it is always relative to the master document.
+ These two definitions are identical if you have only one document, but
+ differ if you have a master document that includes part documents.
+ That means that relative filenames must be transformed when presented to
+ \SpecialChar LaTeX
+.
+ Fortunately \SpecialChar LyX
+ does this automatically for you if you choose the right macros.
+\end_layout
+\begin_layout Standard
+So which path macro should be used in new template definitions? The rule
+ is not difficult:
+\end_layout
+\begin_layout Itemize
+Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-*
+$$AbsPath
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- if the template can handle original files of more than one format.
- LyX will attempt to interrogate the file itself in order to deduce its
- format in this case.
- This command must occur exactly once.
+ if an absolute path is required.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+Use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Template
-\begin_inset space ~
-\end_inset
-
-<id>
+$$AbsOrRelPathMaster
\end_layout
\end_inset
- A unique name for the template.
- It must not contain substitution macros (see below).
+ if the substituted string is some kind of \SpecialChar LaTeX
+ input.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+Else use
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Transform
-\begin_inset space ~
-\end_inset
-
-Rotate|Resize|Clip|Extra
+$$AbsOrRelPathParent
\end_layout
\end_inset
- This command specifies which transformations are supported by this template.
- It may occur zero or more times.
- This command enables the corresponding tabs in the external dialog.
- Each
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Transform
+ in order to preserve the user's choice.
\end_layout
+\begin_layout Standard
+There are special cases where this rule does not work and e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
\end_inset
- command must have either a corresponding
+relative names are needed, but normally it will work just fine.
+ One example for such a case is the command
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TransformCommand
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
\end_layout
\end_inset
- or a
+ in the XFig template above: We can't use the absolute name because the
+ copier for
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-TransformOption
+.pstex_t
\end_layout
\end_inset
- command in the
-\begin_inset Flex Code
-status collapsed
-
-\begin_layout Plain Layout
-Format
+ files needs the relative name in order to rewrite the file content.
\end_layout
+\begin_layout Section
+Security discussion
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Security-discussion"
+
\end_inset
- section.
- Otherwise the transformation will not be supported by that format.
+
\end_layout
-\begin_layout Subsection
-The Format section
+\begin_layout Standard
+The external material feature interfaces with a lot of external programs
+ and does so automatically, so we have to consider the security implications
+ of this.
+ In particular, since you have the option of including your own filenames
+ and/or parameter strings and those are expanded into a command, it seems
+ that it would be possible to create a malicious document which executes
+ arbitrary commands when a user views or prints the document.
+ This is something we definitely want to avoid.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+However, since the external program commands are specified in the template
+ configuration file only, there are no security issues if \SpecialChar LyX
+ is properly configure
+d with safe templates only.
+ This is so because the external programs are invoked with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Format
-\begin_inset space ~
-\end_inset
-
-LaTeX|PDFLaTeX|PlainText|DocBook
+execvp
\end_layout
\end_inset
- The primary document file format that this format definition is for.
- Not every template has a sensible representation in all document file formats.
- Please define nevertheless a
+-system call rather than the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Format
+system
\end_layout
\end_inset
- 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.
+ system-call, so it's not possible to execute arbitrary commands from the
+ filename or parameter section via the shell.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+This also implies that you are restricted in what command strings you can
+ use in the external material templates.
+ In particular, pipes and redirection are not readily available.
+ This has to be so if \SpecialChar LyX
+ should remain safe.
+ If you want to use some of the shell features, you should write a safe
+ script to do this in a controlled manner, and then invoke the script from
+ the command string.
+
+\end_layout
+
+\begin_layout Standard
+It is possible to design a template that interacts directly with the shell,
+ but since this would allow a malicious user to execute arbitrary commands
+ by writing clever filenames and/or parameters, we generally recommend that
+ you only use safe scripts that work with the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Option
-\begin_inset space ~
-\end_inset
+execvp
+\end_layout
-<name>
-\begin_inset space ~
\end_inset
-<value>
+ system call in a controlled manner.
+ Of course, for use in a controlled environment, it can be tempting to just
+ fall back to use ordinary shell scripts.
+ If you do so, be aware that you
+\emph on
+will
+\emph default
+ provide an easily exploitable security hole in your system.
+ Of course it stands to reason that such unsafe templates will never be
+ included in the standard \SpecialChar LyX
+ distribution, although we do encourage people
+ to submit new templates in the open source tradition.
+ But \SpecialChar LyX
+ as shipped from the official distribution channels will never have
+ unsafe templates.
+\end_layout
+
+\begin_layout Standard
+Including external material provides a lot of power, and you have to be
+ careful not to introduce security hazards with this power.
+ A subtle error in a single line in an innocent looking script can open
+ the door to huge security problems.
+ So if you do not fully understand the issues, we recommend that you consult
+ a knowledgeable security professional or the \SpecialChar LyX
+ development team if you have
+ any questions about whether a given template is safe or not.
+ And do this before you use it in an uncontrolled environment.
\end_layout
+\begin_layout Chapter
+\start_of_appendix
+List of supported \SpecialChar LyX
+ functions to be used in layouts
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:List-of-functions"
+
\end_inset
- This command defines an additional macro
-\begin_inset Flex Code
-status collapsed
+
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="11" columns="8">
+<features tabularvalignment="middle">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<column alignment="left" valignment="top">
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$<name>
+accents
\end_layout
\end_inset
-
- for substitution in
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
+booktabs
\end_layout
\end_inset
-
-.
-
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-<value>
+feyn
\end_layout
\end_inset
-
- itself may contain substitution macros.
- The advantage over using
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-<value>
+listings
\end_layout
\end_inset
-
- directly in
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
+natbib
\end_layout
\end_inset
-
- is that the substituted value of
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$<name>
+rotfloat
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- is sanitized so that it is a valid optional argument in the document format.
- This command may occur zero or more times.
+\begin_layout Plain Layout
+tfrupee
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
-\begin_inset space ~
+wasysym
+\end_layout
+
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<text>
+\begin_layout Plain Layout
+amsbsy
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The text that is inserted in the exported document.
- This is actually the most important command and can be quite complex.
- This command must occur exactly once.
+\begin_layout Plain Layout
+calc
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Preamble
-\begin_inset space ~
+fixltx2e
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<name>
+\begin_layout Plain Layout
+longtable
\end_layout
\end_inset
-
- This command specifies a preamble snippet that will be included in the
- LaTeX preamble.
- It has to be defined using
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDef
+nomencl
\end_layout
\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDefEnd
+rsphrase
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-.
- This command may occur zero or more times.
+\begin_layout Plain Layout
+tipa
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-ReferencedFile
-\begin_inset space ~
-\end_inset
+wrapfig
+\end_layout
-<format>
-\begin_inset space ~
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<filename>
+\begin_layout Plain Layout
+amscd
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command denotes files that are created by the conversion process and
- are needed for a particular export format.
- If the filename is relative, it is interpreted relative to the master document.
- This command may be given zero or more times.
+\begin_layout Plain Layout
+CJK
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Requirement
-\begin_inset space ~
+float
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<package>
+\begin_layout Plain Layout
+lyxskak
\end_layout
\end_inset
-
- The name of a required LaTeX package.
- The package is included via
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-
-\backslash
-usepackage{}
+pdfcolmk
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- in the LaTeX preamble.
- This command may occur zero or more times.
+\begin_layout Plain Layout
+setspace
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformCommand
-\begin_inset space ~
-\end_inset
+tipx
+\end_layout
-Rotate
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-RotationLatexCommand
+\begin_layout Plain Layout
+xargs
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that the built in LaTeX command should be used for
- rotation.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+amsmath
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformCommand
-\begin_inset space ~
-\end_inset
+color
+\end_layout
-Resize
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-ResizeLatexCommand
+\begin_layout Plain Layout
+framed
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that the built in LaTeX command should be used for
- resizing.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+makeidx
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+pdfpages
+\end_layout
-Rotate
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-RotationLatexOption
+\begin_layout Plain Layout
+shapepar
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that rotation is done via an optional argument.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+tone
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+xcolor
+\end_layout
-Resize
-\begin_inset space ~
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-ResizeLatexOption
+\begin_layout Plain Layout
+amssymb
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that resizing is done via an optional argument.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+covington
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+graphicx
+\end_layout
-Clip
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-ClipLatexOption
+\begin_layout Plain Layout
+marvosym
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that clipping is done via an optional argument.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+pifont
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+slashed
+\end_layout
-Extra
-\begin_inset space ~
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-ExtraLatexOption
+\begin_layout Plain Layout
+txfonts
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- This command specifies that an extra optional argument is used.
- This command may occur once or not at all.
+\begin_layout Plain Layout
+xy
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-UpdateFormat
-\begin_inset space ~
+amstext
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-<format>
+\begin_layout Plain Layout
+csquotes
\end_layout
\end_inset
-
- The file format of the converted file.
- This must be the name of a format that is known to LyX (see the
-\begin_inset Flex MenuItem
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
+hhline
+\end_layout
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File Format
+\begin_layout Plain Layout
+mathdesign
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- dialog).
- This command must occur exactly once.
+\begin_layout Plain Layout
+pmboxdraw
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-UpdateResult
-\begin_inset space ~
+soul
+\end_layout
+
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-<filename>
+\begin_layout Plain Layout
+ulem
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The file name of the converted file.
- The file name must be absolute.
- This command must occur exactly once.
+\begin_layout Plain Layout
+yhmath
\end_layout
-\begin_layout Subsection
-Preamble definitions
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+amsthm
\end_layout
-\begin_layout Standard
-The external template configuration file may contain additional preamble
- definitions enclosed by
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDef
+dvipost
\end_layout
\end_inset
-
- \SpecialChar \ldots{}
-
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-PreambleDefEnd
+hyperref
\end_layout
\end_inset
-
-.
- They can be used by the templates in the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Format
+mathdots
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- section.
+\begin_layout Plain Layout
+polyglossia
\end_layout
-\begin_layout Section
-The substitution mechanism
-\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout Standard
-When the external material facility invokes an external program, it is done
- on the basis of a command defined in the template configuration file.
- These commands can contain various macros that are expanded before execution.
- Execution always take place in the directory of the containing document.
+\begin_layout Plain Layout
+splitidx
\end_layout
-\begin_layout Standard
-Also, whenever external material is to be displayed, the name will be produced
- by the substitution mechanism, and most other commands in the template
- definition support substitution as well.
-\end_layout
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-\begin_layout Standard
-The available macros are the following:
+\begin_layout Plain Layout
+undertilde
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsOrRelPathMaster
+
\end_layout
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file path, absolute or relative to the master LyX document.
+\begin_layout Plain Layout
+array
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsOrRelPathParent
+endnotes
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file path, absolute or relative to the LyX document.
+\begin_layout Plain Layout
+ifsym
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsPath
+mathrsfs
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The absolute file path.
+\begin_layout Plain Layout
+prettyref
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Basename
+subfig
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The filename without path and without the extension.
+\begin_layout Plain Layout
+units
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Contents(
-\begin_inset Quotes eld
-\end_inset
-filename.ext
-\begin_inset Quotes erd
+\end_layout
+
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-)
+\begin_layout Plain Layout
+ascii
\end_layout
\end_inset
-
- This macro will expand to the contents of the file with the name
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-filename.ext
+enumitem
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
-.
+\begin_layout Plain Layout
+ifthen
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Extension
+mhchem
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The file extension (including the dot).
+\begin_layout Plain Layout
+pxfonts
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$FName
+subscript
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The filename of the file specified in the external material dialog.
- This is either an absolute name, or it is relative to the LyX document.
+\begin_layout Plain Layout
+url
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$FPath
+
\end_layout
\end_inset
-
- The path part of
-\begin_inset Flex Code
-status collapsed
+</cell>
+</row>
+<row>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$FName
+bbding
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- (absolute name or relative to the LyX document).
+\begin_layout Plain Layout
+esint
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$RelPathMaster
+jurabib
\end_layout
\end_inset
+</cell>
+<cell alignment="left" valignment="top" usebox="none">
+\begin_inset Text
- The file path, relative to the master LyX document.
+\begin_layout Plain Layout
+multicol
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$RelPathParent
+refstyle
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- The file path, relative to the LyX document.
+\begin_layout Plain Layout
+textcomp
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Sysdir
+varioref
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
- This macro will expand to the absolute path of the system directory.
- This is typically used to point to the various helper scripts that are
- bundled with LyX.
\end_layout
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$Tempname
+bm
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
- A name and full path to a temporary file which will be automatically deleted
- whenever the containing document is closed, or the external material insertion
- deleted.
+\begin_layout Plain Layout
+fancybox
\end_layout
-\begin_layout Standard
-All path macros contain a trailing directory separator, so you can construct
- e.
-\begin_inset space \thinspace{}
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Plain Layout
+latexsym
+\end_layout
-the absolute filename with
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-$$AbsPath$$Basename$$Extension
+multirow
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
-.
+\begin_layout Plain Layout
+rotating
\end_layout
-\begin_layout Standard
-The macros above are substituted in all commands unless otherwise noted.
- The command
-\begin_inset Flex Code
-status collapsed
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Product
+textgreek
\end_layout
\end_inset
-
- supports additionally the following substitutions if they are enabled by
- the
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Transform
+verbatim
\end_layout
\end_inset
-
- and
-\begin_inset Flex Code
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-TransformCommand
+
\end_layout
\end_inset
+</cell>
+</row>
+</lyxtabular>
- commands:
-\end_layout
+\end_inset
-\begin_layout Description
-\begin_inset Flex Code
-status collapsed
-\begin_layout Plain Layout
-$$ResizeFront
\end_layout
+\begin_layout Chapter
+Names of available colors to be used in layouts
+\begin_inset CommandInset label
+LatexCommand label
+name "chap:Names-of-colors"
+
\end_inset
- The front part of the resize command.
+
+\end_layout
+
+\begin_layout Standard
+The colors listed here are the standard colors and the those that you can
+ adjust in the \SpecialChar LyX
+ preferences.
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+none
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\strikeout off
+\uuline off
+\uwave off
+\noun off
+\color none
+ No particular color – clear or default
+\end_layout
-\begin_layout Plain Layout
-$$ResizeBack
+\begin_layout Description
+black
\end_layout
-\end_inset
+\begin_layout Description
+white
+\end_layout
- The back part of the resize command.
+\begin_layout Description
+red
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+green
+\end_layout
-\begin_layout Plain Layout
-$$RotateFront
+\begin_layout Description
+blue
\end_layout
-\end_inset
+\begin_layout Description
+cyan
+\end_layout
- The front part of the rotation command.
+\begin_layout Description
+magenta
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+yellow
+\end_layout
-\begin_layout Plain Layout
-$$RotateBack
+\begin_layout Description
+added_space Added space marker color
\end_layout
-\end_inset
+\begin_layout Description
+addedtext Added text color
+\end_layout
- The back part of the rotation command.
+\begin_layout Description
+appendix Appendix marker color
\end_layout
-\begin_layout Standard
-The value string of the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+background Background color
+\end_layout
-\begin_layout Plain Layout
-Option
+\begin_layout Description
+bottomarea Bottom area color
\end_layout
-\end_inset
+\begin_layout Description
+branchlabel Label color for branches
+\end_layout
- command supports additionally the following substitutions if they are enabled
- by the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+buttonbg Color used for button background
+\end_layout
-\begin_layout Plain Layout
-Transform
+\begin_layout Description
+buttonhoverbg Color used for button background under focus
+\end_layout
+
+\begin_layout Description
+buttonframe Color for inset button frames
\end_layout
-\end_inset
+\begin_layout Description
+changebar Changebar color
+\end_layout
- and
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+changedtextauthor1 Changed text color author 1
+\end_layout
-\begin_layout Plain Layout
-TransformOption
+\begin_layout Description
+changedtextauthor2 Changed text color author 2
\end_layout
-\end_inset
+\begin_layout Description
+changedtextauthor3 Changed text color author 3
+\end_layout
- commands:
+\begin_layout Description
+changedtextauthor4 Changed text color author 4
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+changedtextauthor5 Changed text color author 5
+\end_layout
-\begin_layout Plain Layout
-$$Clip
+\begin_layout Description
+collapsable_inset_frame Collapsable insets framecolor
\end_layout
-\end_inset
+\begin_layout Description
+collapsable_inset_text Collapsable insets text color
+\end_layout
- The clip option.
+\begin_layout Description
+command Text color for command insets
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+commandbg Background color for command insets
+\end_layout
-\begin_layout Plain Layout
-$$Extra
+\begin_layout Description
+commandframe Frame color for command insets
\end_layout
-\end_inset
+\begin_layout Description
+comment color for comments
+\end_layout
- The extra option.
+\begin_layout Description
+commentbg Background color of comments
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+cursor Cursor color
+\end_layout
-\begin_layout Plain Layout
-$$Resize
+\begin_layout Description
+deletedtext Deleted text color
\end_layout
-\end_inset
+\begin_layout Description
+deletedtextmodifier Deleted text modifying color
+\end_layout
- The resize option.
+\begin_layout Description
+depthbar Color for the depth bars in the margin
\end_layout
\begin_layout Description
-\begin_inset Flex Code
-status collapsed
+eolmarker End of line marker color
+\end_layout
-\begin_layout Plain Layout
-$$Rotate
+\begin_layout Description
+error Color of the \SpecialChar LaTeX
+ error box
\end_layout
-\end_inset
+\begin_layout Description
+footlabel Label color for footnotes
+\end_layout
- The rotation option.
+\begin_layout Description
+graphicsbg Graphics inset background color
\end_layout
-\begin_layout Standard
-You may ask why there are so many path macros.
- There are mainly two reasons:
+\begin_layout Description
+greyedout Label color for greyedout insets
\end_layout
-\begin_layout Enumerate
-Relative and absolute file names should remain relative or absolute, respectivel
-y.
- Users may have reasons to prefer either form.
- Relative names are useful for portable documents that should work on different
- machines, for example.
- Absolute names may be required by some programs.
+\begin_layout Description
+greyedoutbg Background color of greyedout inset
\end_layout
-\begin_layout Enumerate
-LaTeX treats relative file names differently than LyX and other programs
- in nested included files.
- For LyX, a relative file name is always relative to the document that contains
- the file name.
- For LaTeX, it is always relative to the master document.
- These two definitions are identical if you have only one document, but
- differ if you have a master document that includes part documents.
- That means that relative filenames must be transformed when presented to
- LaTeX.
- Fortunately LyX does this automatically for you if you choose the right
- macros.
+\begin_layout Description
+greyedouttext Color for greyedout inset text
\end_layout
-\begin_layout Standard
-So which path macro should be used in new template definitions? The rule
- is not difficult:
+\begin_layout Description
+indexlabel Label color for index insets
\end_layout
-\begin_layout Itemize
-Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+ignore The color is ignored
+\end_layout
-\begin_layout Plain Layout
-$$AbsPath
+\begin_layout Description
+inherit The color is inherited
\end_layout
-\end_inset
+\begin_layout Description
+inlinecompletion Inline completion color
+\end_layout
- if an absolute path is required.
+\begin_layout Description
+insetbg Inset marker background color
\end_layout
-\begin_layout Itemize
-Use
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+insetframe Inset marker frame color
+\end_layout
-\begin_layout Plain Layout
-$$AbsOrRelPathMaster
+\begin_layout Description
+language Color for marking foreign language words
\end_layout
-\end_inset
+\begin_layout Description
+latex Text color in \SpecialChar LaTeX
+ mode
+\end_layout
- if the substituted string is some kind of LaTeX input.
+\begin_layout Description
+listingsbg Background color of listings inset
\end_layout
-\begin_layout Itemize
-Else use
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+marginlabel Label color for margin notes
+\end_layout
-\begin_layout Plain Layout
-$$AbsOrRelPathParent
+\begin_layout Description
+math Math inset text color
\end_layout
-\end_inset
+\begin_layout Description
+mathbg Math inset background color
+\end_layout
- in order to preserve the user's choice.
+\begin_layout Description
+mathcorners Math inset frame color not under focus
\end_layout
-\begin_layout Standard
-There are special cases where this rule does not work and e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Description
+mathframe Math inset frame color under focus
+\end_layout
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Description
+mathline Math line color
+\end_layout
-relative names are needed, but normally it will work just fine.
- One example for such a case is the command
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+mathmacrobg Macro math inset background color
+\end_layout
-\begin_layout Plain Layout
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+\begin_layout Description
+mathmacroblend Macro math blended color
\end_layout
-\end_inset
+\begin_layout Description
+mathmacroframe Macro math frame color
+\end_layout
- in the XFig template above: We can't use the absolute name because the
- copier for
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+mathmacrohoverbg Macro math inset background color hovered
+\end_layout
-\begin_layout Plain Layout
-.pstex_t
+\begin_layout Description
+mathmacrolabel Macro math label color
\end_layout
-\end_inset
+\begin_layout Description
+mathmacronewarg Macro template color for new parameters
+\end_layout
- files needs the relative name in order to rewrite the file content.
+\begin_layout Description
+mathmacrooldarg Macro template color for old parameters
\end_layout
-\begin_layout Section
-Security discussion
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Security-discussion"
+\begin_layout Description
+newpage New page color
+\end_layout
-\end_inset
+\begin_layout Description
+nonunique_inlinecompletion Inline completion color for the non-unique part
+\end_layout
+\begin_layout Description
+notebg Background color of notes
+\end_layout
+\begin_layout Description
+notelabel Label color for notes
\end_layout
-\begin_layout Standard
-The external material feature interfaces with a lot of external programs
- and does so automatically, so we have to consider the security implications
- of this.
- In particular, since you have the option of including your own filenames
- and/or parameter strings and those are expanded into a command, it seems
- that it would be possible to create a malicious document which executes
- arbitrary commands when a user views or prints the document.
- This is something we definitely want to avoid.
+\begin_layout Description
+pagebreak Page break/line break color
\end_layout
-\begin_layout Standard
-However, since the external program commands are specified in the template
- configuration file only, there are no security issues if LyX is properly
- configured with safe templates only.
- This is so because the external programs are invoked with the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
+\end_layout
-\begin_layout Plain Layout
-execvp
+\begin_layout Description
+phantomtext Text color for phantom insets
\end_layout
-\end_inset
+\begin_layout Description
+preview The color used for previews
+\end_layout
--system call rather than the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+previewframe Preview frame color
+\end_layout
-\begin_layout Plain Layout
-system
+\begin_layout Description
+regexpframe Color for regexp frame
\end_layout
-\end_inset
+\begin_layout Description
+selection Background color of selected text
+\end_layout
- system-call, so it's not possible to execute arbitrary commands from the
- filename or parameter section via the shell.
+\begin_layout Description
+selectiontext Foreground color of selected text
\end_layout
-\begin_layout Standard
-This also implies that you are restricted in what command strings you can
- use in the external material templates.
- In particular, pipes and redirection are not readily available.
- This has to be so if LyX should remain safe.
- If you want to use some of the shell features, you should write a safe
- script to do this in a controlled manner, and then invoke the script from
- the command string.
-
+\begin_layout Description
+shadedbg Background color of shaded box
\end_layout
-\begin_layout Standard
-It is possible to design a template that interacts directly with the shell,
- but since this would allow a malicious user to execute arbitrary commands
- by writing clever filenames and/or parameters, we generally recommend that
- you only use safe scripts that work with the
-\begin_inset Flex Code
-status collapsed
+\begin_layout Description
+special Special chars text color
+\end_layout
-\begin_layout Plain Layout
-execvp
+\begin_layout Description
+tabularline Table line color
\end_layout
-\end_inset
+\begin_layout Description
+tabularonoffline Table line color
+\end_layout
- system call in a controlled manner.
- Of course, for use in a controlled environment, it can be tempting to just
- fall back to use ordinary shell scripts.
- If you do so, be aware that you
-\emph on
-will
-\emph default
- provide an easily exploitable security hole in your system.
- Of course it stands to reason that such unsafe templates will never be
- included in the standard LyX distribution, although we do encourage people
- to submit new templates in the open source tradition.
- But LyX as shipped from the official distribution channels will never have
- unsafe templates.
+\begin_layout Description
+urllabel Label color for URL insets
\end_layout
-\begin_layout Standard
-Including external material provides a lot of power, and you have to be
- careful not to introduce security hazards with this power.
- A subtle error in a single line in an innocent looking script can open
- the door to huge security problems.
- So if you do not fully understand the issues, we recommend that you consult
- a knowledgeable security professional or the LyX development team if you
- have any questions about whether a given template is safe or not.
- And do this before you use it in an uncontrolled environment.
+\begin_layout Description
+urltext Color for URL inset text
\end_layout
\end_body
projects / lyx.git / blobdiff