-#LyX 1.6.0rc3 created this file. For more info see http://www.lyx.org/
-\lyxformat 340
+#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 353
\begin_document
\begin_header
\textclass scrbook
% redefine the \LyX macro for PDF bookmarks
\def\LyX{\texorpdfstring{%
L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
- {LyX }}
+ {LyX}}
% used for multi-column text
\usepackage{multicol}
\usepackage{inputenc}
\end_preamble
\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
+\use_default_options false
\begin_modules
logicalmkup
\end_modules
\font_sans default
\font_typewriter default
\font_default_family default
+\use_xetex false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
+\default_output_format default
\paperfontsize 12
\spacing single
\use_hyperref true
\pdf_pdfborder false
\pdf_colorlinks true
\pdf_backref false
-\pdf_pagebackref false
\pdf_pdfusetitle false
\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true,pdfstartview=XYZ, plainpages=false, pdfpagelabels"
\papersize default
\use_esint 0
\cite_engine basic
\use_bibtopic false
+\use_indices false
\paperorientation portrait
+\backgroundcolor #ffffff
\branch OutDated
\selected 0
\color #f5fae7
\output_changes false
\author ""
\author ""
+\author ""
+\author ""
+\author ""
\end_header
\begin_body
\end_inset
.
+ Include
+\begin_inset Quotes eld
+\end_inset
+
+[Customization]
+\begin_inset Quotes erd
+\end_inset
+
+ in the subject header, and please cc the current maintainer of this file,
+ Richard Heck <rgheck@comcast.net>.
\end_layout
\end_inset
-
+
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
+
+Version 2.0.x
\end_layout
\begin_layout Standard
\end_inset
+\end_layout
+
+\begin_layout Standard
+\begin_inset Note Note
+status open
+
+\begin_layout Plain Layout
+Please use change tracking when modifying this document.
+ This makes it easier for our translators to recognize things that have
+ been changed, and it helps the maintainer keep up-to-date with what's been
+ done.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Chapter
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.
- 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
+ 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
for some of the more obscure ones.
\end_layout
\begin_layout Standard
\begin_inset Branch OutDated
-status collapsed
+status open
\begin_layout Standard
Information from previous versions of this document that now seems to be
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
+Help\SpecialChar \menuseparator
About
\begin_inset space ~
\end_inset
-Ly
-\bar under
-X
+LyX
\end_layout
\end_inset
\end_inset
and its sub-directories contain a number of files and that can be used
- to customise LyX's behaviour.
+ to customize LyX's behavior.
You can change many of these files from within LyX itself through the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-L
-\bar under
-a
-\bar default
-TeX
+Help\SpecialChar \menuseparator
+LaTeX
\begin_inset space ~
\end_inset
\end_inset
deserves special attention, as noted above.
- If there exists an internationalized version of the help-document with
-
+ The internationalized help docs are in subdirectories
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$LANG_
+doc/xx
\end_layout
\end_inset
- prepended to the name, that will be used first.
- See Chapter
+ where
+\begin_inset Quotes eld
+\end_inset
+
+xx
+\begin_inset Quotes erd
+\end_inset
+
+ is the ISO language code.
+ See chapter
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "chap:i18n"
+reference "cha:Internationalizing-LyX"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "chap:textclass"
+reference "cha:Installing-New-Document"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:templates"
+reference "sec:Creating-Templates"
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
+Help\SpecialChar \menuseparator
About
\begin_inset space ~
\end_inset
\end_inset
this contains tables describing how different character encodings can be
- mapped to unicode
+ mapped to Unicode
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
+Help\SpecialChar \menuseparator
About
\begin_inset space ~
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp
+Help
\end_layout
\end_inset
\end_inset
- subirectory, however, since it contains a file written by the configuration
+ subdirectory, however, since it contains a file written by the configuration
script (also accessible through
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
\end_layout
\begin_layout Section
-Using the dialog for the first time
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-UserDir/preferences
-\end_layout
-
-\end_inset
-
- file will contain only changes that you have made to the default behavior,
- some of which is hard-coded into LyX and some of which is contained in
- the system file
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LyXDir/lyxrc.defaults
-\end_layout
-
-\end_inset
-
-.
- Note that in both files lines beginning with a
-\begin_inset Quotes eld
-\end_inset
-
-#
-\begin_inset Quotes erd
-\end_inset
-
- are just comments and are not interpreted.
- However, only system administrators should edit
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LyXDir/lyxrc.defaults
-\end_layout
-
-\end_inset
-
-.
- Users should use the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences
-\end_layout
+Formats
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Formats"
\end_inset
- dialog to create and modify their own
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-UserDir/preferences
-\end_layout
-
-\end_inset
- file.
\end_layout
\begin_layout Standard
-We hope that the
+The first step is to define your file formats if they are not already defined.
+ To do so, open the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- dialog will be largely self-explanatory.
- Most things in the dialog have associated `tool tips': hover your mouse
- pointer over something for more information.
- Before we highlight a few of the more important commands below, however,
- a word of warning: Applying some of your changes (e.g., screen fonts) will
- have an instant effect.
- Others (e.g.
- changing the bind file) will not.
- If nothing appears to have changed, just
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Save
-\end_layout
-
-\end_inset
-
- the changes and restart LyX.
-\end_layout
-
-\begin_layout Section
-File Handling
-\end_layout
-
-\begin_layout Standard
-LyX has a powerful mechanism to convert to and from any file format using
- external programs.
-
-\end_layout
-
-\begin_layout Subsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:Formats"
-
-\end_inset
-
-Formats
-\end_layout
-
-\begin_layout Standard
-The first step is to define your file formats if they are not already defined.
- To do so, open the
+ dialog.
+ Under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
File Handling\SpecialChar \menuseparator
-File Formats
+File formats
\end_layout
\end_inset
- dialog.
- Press the
+ press the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- is used to identify the format interally.
+ is used to identify the format internally.
You will also need to enter a file extension.
These are all required.
The optional
\end_inset
option tells LyX that a format is suitable for document export.
- If this is is set and if a suitable conversion route exists (see
+ If this is is set and if a suitable conversion route exists (see sec.
+\begin_inset space \thinspace{}
+\end_inset
+
+
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Converters"
+reference "sec:Converters"
\end_inset
.
\end_layout
-\begin_layout Subsection
+\begin_layout Section
Copiers
\end_layout
status collapsed
\begin_layout Plain Layout
-For example, the file may refer to other files---images, for example---using
+For example, the file may refer to other files—images, for example—using
relative file names, and these may become invalid when the file is copied
to the temporary directory.
\end_layout
\end_inset
g.
-\begin_inset space ~
+\begin_inset space \space{}
\end_inset
\end_layout
\begin_layout Standard
-The latter is to be given in a form suitable for inclusion in a LaTeX's
-
+The latter should be the filename as it would be used in a LaTeX's
\series bold
\backslash
include
\series default
- command and is relevant only when exporting files suitable for such inclusion.
+ command.
+ It is relevant only when exporting files suitable for such inclusion.
\end_layout
\begin_layout Standard
\end_inset
-Save that in your local LyX directory---say,
+Save that in your local LyX directory—say,
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
----and make it executable, if you need to do so on your platform.
+—and make it executable, if you need to do so on your platform.
Then, in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
Tools\SpecialChar \menuseparator
-Preferences:Copiers
+Preferences
+\end_layout
+
+\end_inset
+
+ dialog, select under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File Handling\SpecialChar \menuseparator
+File formats
\end_layout
\end_inset
- dialog, select the
+ the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- format---or one of the other pdf formats---and enter
+ format—or one of the other pdf formats—and enter
\begin_inset Flex CharStyle:Code
status collapsed
\end_layout
-\begin_layout Subsection
+\begin_layout Section
+Converters
\begin_inset CommandInset label
LatexCommand label
-name "sub:Converters"
+name "sec:Converters"
\end_inset
-Converters
+
\end_layout
\begin_layout Standard
-You can define your own Converters to, uhh, convert files between different
- formats.
+You can define your own Converters to convert files between different formats.
This is done in the
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- and
-\begin_inset space \thinspace{}
-\end_inset
-
-
+ and
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- The base filename of the input file (i.e., without the extension)
+ The base filename of the input file (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g., without the extension)
\end_layout
\begin_layout Labeling
The path to the input file
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$r
+\end_layout
+
+\end_inset
+
+ The path to the original input file (this is different from $$p when chain
+ of converters is called).
+\end_layout
+
\begin_layout Standard
In the
\begin_inset Flex CharStyle:MenuItem
\begin_layout Standard
You do not have to define converters between all the formats between which
you want to convert.
- For example, you will note that there is no `LyX to PostScript®' converter,
- but LyX will export PostScript®.
+ For example, you will note that there is no `LyX to PostScript' converter,
+ but LyX will export PostScript.
It does so by first creating a LaTeX file (no converter needs to be defined
for this) which is then converted to DVI using the `LaTeX to DVI' converter,
- and finally converting the resulting DVI file to PostScript®.
+ and finally converting the resulting DVI file to PostScript.
LyX finds such `chains' of converters automatically, and it will always
choose the shortest possible chain.
You can, though, still define multiple conversion methods between file
\end_inset
-; via (DVI and) PostScript®, using
+; via (DVI and) PostScript, using
\begin_inset Flex CharStyle:MenuItem
status collapsed
formats', as described in section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Formats"
+reference "sec:Formats"
\end_inset
Internationalizing LyX
\begin_inset CommandInset label
LatexCommand label
-name "chap:i18n"
+name "cha:Internationalizing-LyX"
\end_inset
-file for that language.
When this is available, you'll have to generate a
\begin_inset Flex CharStyle:Code
-status open
+status collapsed
\begin_layout Plain Layout
mo
\end_inset
- (e.g.
-
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\end_layout
\begin_layout Subsubsection
-Ambigous messages
+Ambiguous messages
\end_layout
\begin_layout Standard
\end_inset
- does not handle such ambigous translations.
+ does not handle such ambiguous translations.
Therefore you have to add some context information to the message: Instead
of
\begin_inset Flex CharStyle:Code
\end_inset
- Now the two occurences of
+ Now the two occurrences of
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp
+Help
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LyXDir/doc/xx_DocName.lyx
+LyXDir/doc/xx/DocName.lyx
\end_layout
\end_inset
Check out the documentation translation web page at
\begin_inset CommandInset href
LatexCommand href
-name "http://www.devel.lyx.org"
-target "http://www.devel.lyx.org"
+name "http://www.lyx.org/Translation"
+target "http://www.lyx.org/Translation"
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
+Help\SpecialChar \menuseparator
\bar under
I
status collapsed
\begin_layout Plain Layout
-UserDir/doc/
+UserDir/doc/xx/
\end_layout
\end_inset
In doing the revisions on this document in March 2008, I did not look over
this stuff, as I do not understand it.
It would be good if someone else could do so.
+ (RH)
\end_layout
\end_inset
\emph default
\family roman
-followed by the other, unallowed key, as output.
+followed by the other, not allowed key, as output.
\family default
Note that a
\shape up
\emph on
result
-\family default
-\shape default
\emph default
-
-\family roman
-\shape up
is produced.
If such a declaration does not exist in
\family default
\family roman
\emph on
-accent char
+accent char
\emph default
, you get
\family default
\family roman
\emph on
accent_key char
-\family default
\emph default
-
-\family roman
where
\family default
\family roman
\emph on
accent_key
-\family default
\emph default
-
-\family roman
is the first arg
\family default
ument of the
\end_inset
- to set up the special
+ to set up the special
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Edit\SpecialChar \menuseparator
+Preferences
\end_layout
\end_inset
\end_layout
\begin_layout Chapter
-Installing New Document Classes, Layouts, and Templates
+Installing New Document Classes, Layouts, and Templates
\begin_inset CommandInset label
LatexCommand label
-name "chap:textclass"
+name "cha:Installing-New-Document"
\end_inset
can be used somewhat interchangeably, but it is better to refer to the
file as the layout, and the thing living in LyX's memory as the text class.
A template file is simply a LyX document that contains a set of predefined
- entries for a given document class---entries that are generally required
+ entries for a given document class—entries that are generally required
for that class.
Templates are especially useful for things like journal manuscripts that
are to be submitted electronically.
\end_inset
- variables; e.g.
+ variables; e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
\begin_inset Newline newline
\end_inset
\end_inset
) and then restart LyX.
- You should then see your new package---for example
+ You should then see your new package—for example
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
----under
+—under
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
.
- If the argument has a datatype like
+ If the argument has a data type like
\begin_inset Quotes eld
\end_inset
\begin_layout Subsection
Layout modules
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Layout-modules"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
\emph default
.
Modules are to LaTeX packages much as layouts are to LaTeX classes, and
- some modules---such as the Endnotes module---provide support for just such
+ some modules—such as the endnotes module—provide support for just such
a package.
- In a sense, layout modules are similar to included files---files like
+ In a sense, layout modules are similar to included files—files like
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
----in that modules are not specific to a given document layout but may be
+—in that modules are not specific to a given document layout but may be
used with many different layouts.
The difference is that using a layout module does not require editing the
layout file.
\end_layout
\begin_layout Standard
-The argument in square brackets is optional: It declares any LaTeX packages
- on which the module depends.
- The mandatory argument, in curly brackets, is the name of the module, as
+The mandatory argument, in curly brackets, is the name of the module, as
it should appear in
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
.
-
+ The argument in square brackets is optional: It declares any LaTeX packages
+ on which the module depends.
+ Please note that only packages about which LyX knows should be listed in
+ the square brackets.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The list of such packages is documented only in the source code.
+\end_layout
+
+\end_inset
+
+ LyX will not check for arbitrary packages.
\end_layout
\begin_layout Standard
\begin_layout LyX-Code
#You will need to add
\backslash
-theendnotes in ERT where you
+theendnotes in TeX code where you
\end_layout
\begin_layout LyX-Code
\begin_layout Standard
If your new document class is provided as a style file that is used in conjuncti
-on with an existing, supported document class---for the sake of the example,
+on with an existing, supported document class—for the sake of the example,
we'll assume that the style file is called
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
-, which is a standard class---start by copying the existing class's layout
+, which is a standard class—start by copying the existing class's layout
file into your local directory:
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
dialog.
It is likely that some of the sectioning commands and such in your new
- class will work differently from how they worked in the base class---
+ class will work differently from how they worked in the base class—
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- in this example---so you can fiddle around with the settings for the different
+ in this example—so you can fiddle around with the settings for the different
sections if you wish.
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
\begin_layout Standard
The class need only be specified if the name of the LaTeX class file and
- the name of the layout file are different; if the name of the classfile
+ the name of the layout file are different; if the name of the class file
is not specified, then LyX will simply assume that it is the same as the
name of the layout file.
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-econfigure
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
\end_inset
\end_inset
.
- There is no default binding for this function---though, of course, you
- can bind it to a key yourself.
+ There is no default binding for this function—though, of course, you can
+ bind it to a key yourself.
If you want to use this function, then, you should simply enter it in the
mini-buffer.
] This tag was introduced with LyX 1.4.0 (layout files of LyX 1.3.x and earlier
don't have an explicit file format).
- The file format that is documented here is format 8.
+ The file format that is documented here is format 14.
\end_layout
\begin_layout Subsection
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:classoptions"
+reference "sub:ClassOptions"
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:counter"
+reference "sub:Counters"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:fonts"
+reference "sub:Font-description"
\end_inset
\begin_inset Flex CharStyle:Code
status collapsed
+\begin_layout Plain Layout
+DefaultModule
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string]
+\end_layout
+
+\end_inset
+
+ Specifies a module to be included by default with this document class,
+ which should be specified by filename without the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
+\end_inset
+
+ extension.
+ The user can still remove the module, but it will be active at the outset.
+ (This applies only when new files are created, or when this class is chosen
+ for an existing document.)
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
\begin_layout Plain Layout
DefaultStyle
\end_layout
\begin_inset Flex CharStyle:Code
status collapsed
+\begin_layout Plain Layout
+ExcludesModule
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+string
+\end_layout
+
+\end_inset
+
+] Indicates that the module in question—which should be specified by filename
+ without the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.module
+\end_layout
+
+\end_inset
+
+ extension—cannot be used with this document class.
+ This might be used in a journal-specific layout file to prevent, say, the
+ use of the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+theorems-sec
+\end_layout
+
+\end_inset
+
+ module that numbers theorems by section.
+ This tag may
+\emph on
+not
+\emph default
+ be used in a module.
+ Modules have their own way of excluding other modules (see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Layout-modules"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
\begin_layout Plain Layout
Float
\end_layout
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:floats"
+reference "sub:Floats"
\end_inset
This section (re-)defines the layout of an inset.
It can be applied to an existing inset of to a new, user-defined inset,
- e.g., a new character style.
+ e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+a new character style.
See Section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:charstyle"
+reference "sub:Flex-insets-and"
\end_inset
\end_inset
- [[FIXME]]
+ A string that indicates the width of the left margin on the screen, for
+ example,
+\begin_inset Quotes eld
+\end_inset
+
+MMMMM
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
\end_inset
- [[FIXME]]
+ A string indicating what sort of output documents using this class will
+ produce.
+ At present, the options are: `docbook', `latex', and `literate'.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Premable
+Preamble
\end_layout
\end_inset
,\SpecialChar \ldots{}
); the complete list of supported features is unfortunately not documented
- outside the LyX source code---but see
+ outside the LyX source code—but see
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX Configuration
+Help\SpecialChar \menuseparator
+LaTeX Configuration
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Requires
+ProvidesModule
\end_layout
\end_inset
\end_inset
-] Whether the class requires the feature
+] Indicates that this layout provides the functionality of the module mentioned,
+ which should be specified by the filename without the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
- string
+.module
\end_layout
\end_inset
-.
- Multiple features must be separated by commas.
- Note that you can only request supported features.
-\end_layout
-
-\begin_layout Description
+ extension.
+ This will typically be used if the layout includes the module directly,
+ rather than using the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-RightMargin
+DefaultModule
\end_layout
\end_inset
- [[FIXME]]
+ tag to indicate that it ought to be used.
+ It could be used in a module that provided an alternate implementation
+ of the same functionality.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-SecNumDepth
+Requires
\end_layout
\end_inset
- [[FIXME]]
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sides
+string
\end_layout
\end_inset
- [
-\emph on
-
+] Whether the class requires the feature
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-1
+string
\end_layout
\end_inset
+.
+ Multiple features must be separated by commas.
+ Note that you can only request supported features.
+\end_layout
-\emph default
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-2
+RightMargin
\end_layout
\end_inset
-] Whether the class-default should be printing on one or both sides of the
- paper.
- Can be changed in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ A string that indicates the width of the right margin on the screen, for
+ example,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
+MMMMM
+\begin_inset Quotes erd
+\end_inset
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+.
+\end_layout
-\bar under
-S
-\bar default
-ettings
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SecNumDepth
+\end_layout
+
+\end_inset
+
+ Sets which divisions get numbered.
+ Corresponds to the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+secnumdepth
+\end_layout
+
+\end_inset
+
+ counter in LaTeX.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Sides
+\end_layout
+
+\end_inset
+
+ [
+\emph on
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+1
+\end_layout
+
+\end_inset
+
+
+\emph default
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+2
+\end_layout
+
+\end_inset
+
+] Whether the class-default should be printing on one or both sides of the
+ paper.
+ Can be changed in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:style"
+reference "sub:Paragraph-Styles"
\end_inset
environment.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status open
-
-\begin_layout Plain Layout
-TocDepth
-\end_layout
-
-\end_inset
-
- [[FIXME]]
-\end_layout
-
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UseModule
+TocDepth
\end_layout
\end_inset
- [
+ Sets which divisions are included in the table of contents.
+ Corresponds to the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string]
+tocdepth
\end_layout
\end_inset
- Specifies a module to be included by default with this document class.
- The user can still remove the module, but it will be active at the outset.
- (This applies only when new files are created, or when this class is chosen
- for an existing document.)
+ counter in LaTeX.
\end_layout
\begin_layout Subsection
\end_inset
section
-\end_layout
-
-\begin_layout Standard
\begin_inset CommandInset label
LatexCommand label
-name "sec:classoptions"
+name "sub:ClassOptions"
\end_inset
+
+\end_layout
+
+\begin_layout Standard
The
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- [[FIXME]]
+ Used to set the DTD line with XML-based output classes.
+ E.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.: PUBLIC
+\begin_inset Quotes eld
+\end_inset
+
+-//OASIS//DTD DocBook V4.2//EN
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
\begin_layout Description
\begin_layout Subsection
Paragraph Styles
-\end_layout
-
-\begin_layout Standard
\begin_inset CommandInset label
LatexCommand label
-name "sec:style"
+name "sub:Paragraph-Styles"
\end_inset
+
+\end_layout
+
+\begin_layout Standard
A paragraph style description looks like this:
\begin_inset Foot
status collapsed
\end_inset
- [[FIXME]]
+ Depth of XML command.
+ Used only with XML-type formats.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
+Edit\SpecialChar \menuseparator
+Paragraph
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:fonts"
+reference "sub:Font-description"
\end_inset
status collapsed
\begin_layout Plain Layout
-InnerTag
+BabelPreamble
\end_layout
\end_inset
- [[FIXME]]
-\end_layout
-
-\begin_layout Description
+ Language dependent information to be included in the LaTeX preamble when
+ this style is used.
+ Note that this will completely override any prior
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InTitle
+BabelPreamble
\end_layout
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-[1, 0]
-\end_layout
-
+ declarations.
+ Must end with
+\begin_inset Quotes eld
\end_inset
- If 1, marks the layout as being part of a title block (see also the
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TitleLatexType
+EndBabelPreamble
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-TitleLatexName
-\end_layout
+\begin_inset Quotes erd
\end_inset
- global entries).
+.
+ The contents of this tag will occur once in the LaTeX preamble for each
+ language used by the document.
+ Each time, the following substitutions are made:
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ItemSep
+$$lang
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-float=0
+ is replaced by the language name (as used by the babel package).
\end_layout
+\begin_layout Itemize
+The
+\begin_inset Quotes eld
\end_inset
-] This provides extra space between paragraphs that have the same layout.
- If you put other layouts into an environment, each is separated with the
- environment's
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Parsep
-\end_layout
-
+Function
+\begin_inset Quotes erd
\end_inset
-.
- But the whole items of the environment are additionally separated with
- this
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Itemsep
+_()
\end_layout
\end_inset
-.
- Note that this is a
-\emph on
- multiplier.
+ replaces its argument by the translation of the argument to the current
+ language.
\end_layout
+\begin_layout Standard
+This preamble snippet will only be used if the document contains more than
+ one language and the babel package is used.
+\end_layout
+
+\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ItemTag
+LangPreamble
\end_layout
\end_inset
- [[FIXME]]
-\end_layout
-
-\begin_layout Description
+ Like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+BabelPreamble
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:KeepEmpty"
-
+, but this preamble snippet occurs independently from the babel package,
+ and only for the document language.
+ Must end with
+\begin_inset Quotes eld
\end_inset
-[
-\emph on
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+EndLangPreamble
\end_layout
\end_inset
-\emph default
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-1
-\end_layout
-
+\begin_inset Quotes erd
\end_inset
-] Usually LyX does not allow you to leave a paragraph empty, since it would
- lead to empty LaTeX output.
- There are some cases where this could be desirable however: in a letter
- template, the required fields can be provided as empty fields, so that
- people do not forget them; in some special classes, a layout can be used
- as some kind of break, which does not contain actual text.
+.
\end_layout
-\begin_layout Description
+\begin_deeper
+\begin_layout Standard
+If the style defines text that appears in the typeset document, it may use
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelBottomsep
+LangPreamble
\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 (
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+BabelPreamble
\end_layout
\end_inset
-,
+ to support non-english and even multilanguage documents correctly.
+ The following excerpt (from the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+theorems-ams.inc
\end_layout
\end_inset
-).
+ file) shows how this works:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelCounter
+\begin_layout LyX-Code
+Preamble
\end_layout
-\end_inset
-
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-string=""
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
\end_layout
-\end_inset
-
-]
-\begin_inset Newline newline
-\end_inset
-
-The name of the counter for automatic numbering (see Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
-\end_inset
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
- for details).
- This must be given if
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
-\begin_layout Plain Layout
-Labeltype
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
\end_layout
-\end_inset
+\begin_layout LyX-Code
- is
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-Counter
+\begin_layout LyX-Code
+EndLangPreamble
\end_layout
-\end_inset
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
-.
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
\end_layout
-\begin_layout Description
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
+
+\begin_layout Standard
+The key to correct translation of the user visible text is the definition
+ of the command
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
-\end_layout
-\end_inset
+\backslash
+claimname
+\end_layout
- The font used for the label.
- See section
-\begin_inset space ~
\end_inset
+ in the language preamble.
+ This command holds the name of the theorem that will appear in the output.
+ The
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ then uses the commands offered by the babel package to redefine
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Labelsep
+
+\backslash
+claimname
\end_layout
\end_inset
- [
+ for each used language in multilanguage documents.
+\end_layout
+
+\end_deeper
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+InnerTag
\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.
+ [[FIXME]] (Used only with XML-type formats.)
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelString
+InTitle
\end_layout
\end_inset
- [
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+[1, 0]
\end_layout
\end_inset
-] The string used for a label with a
+ If 1, marks the layout as being part of a title block (see also the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+TitleLatexType
\end_layout
\end_inset
- labeltype.
- When
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelCounter
+TitleLatexName
\end_layout
\end_inset
- is set, this string can be contain the special formatting commands described
- in Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
-
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
+ global entries).
+\end_layout
-\begin_layout Plain Layout
-For the sake of backwards compatibility, the string
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-@
-\emph on
-style-name
-\emph default
-@
+ItemSep
\end_layout
\end_inset
- will be replaced by the expanded
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+float=0
\end_layout
\end_inset
- of style
+] This provides extra space between paragraphs that have the same layout.
+ If you put other layouts into an environment, each is separated with the
+ environment's
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-style-name
+Parsep
\end_layout
\end_inset
.
- This feature is now obsolete and should be replaced by the mechanisms of
- Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:counter"
-
-\end_inset
+ But the whole items of the environment are additionally separated with
+ this
+\begin_inset Flex CharStyle:Code
+status collapsed
-.
+\begin_layout Plain Layout
+Itemsep
\end_layout
\end_inset
-
+.
+ Note that this is a
+\emph on
+ multiplier.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+ItemTag
\end_layout
\end_inset
- [
+ [[FIXME]] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string=""
+KeepEmpty
\end_layout
\end_inset
-] This is used inside the appendix instead of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-LabelString
-\end_layout
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:KeepEmpty"
\end_inset
-.
- Note that every
+[
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+
+\emph on
+0
\end_layout
\end_inset
- statement resets
+
+\emph default
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+1
\end_layout
\end_inset
- too.
+] Usually LyX does not allow you to leave a paragraph empty, since it would
+ lead to empty LaTeX output.
+ There are some cases where this could be desirable however: in a letter
+ template, the required fields can be provided as empty fields, so that
+ people do not forget them; in some special classes, a layout can be used
+ as some kind of break, which does not contain actual text.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Labeltype
+LabelBottomsep
\end_layout
\end_inset
- [
+ [float=0] The vertical space between the label and the text body.
+ Only used for labels that are above the text body (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-No_Label
-\emph default
-, Manual, Static, Top_Environment,
-\begin_inset Newline newline
-\end_inset
-
-Centered_Top_Environment, Sensitive, Counter
+Top_Environment
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
-
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+Centered_Top_Environment
\end_layout
\end_inset
- means the label is the very first word (up to the first real blank).
-\begin_inset Foot
+).
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Use protected spaces if you want more than one word as the label.
+LabelCounter
\end_layout
\end_inset
-
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+string=""
\end_layout
\end_inset
- means it is defined in the layout (see
-\begin_inset Flex CharStyle:Code
-status collapsed
+]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-LabelString
-\end_layout
+The name of the counter for automatic numbering (see Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
\end_inset
-).
-
+ for details).
+ This must be given if
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Top_Environment
+Labeltype
\end_layout
\end_inset
- and
+ is
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Centered_Top_Environment
+Counter
\end_layout
\end_inset
- are special cases of
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+LabelFont
\end_layout
\end_inset
-.
- The label will be printed above the paragraph, but only at the top of an
- environment or the top of a chain of paragraphs with this layout.
- Usage is for example the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-Abstract
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
- layout or the
-\begin_inset Flex CharStyle:MenuItem
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Bibliography
+LabelIndent
\end_layout
\end_inset
- layout.
- This is also the case for
+ Text that indicates how far a label should be indented.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+Labelsep
\end_layout
\end_inset
- labels with latex type
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+string=""
\end_layout
\end_inset
-, in order to make layouts for theorems work correctly.
-
+] The horizontal space between the label and the text body.
+ Only used for labels that are not above the text body.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+LabelString
\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
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
- and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+string=""
+\end_layout
-Table
-\begin_inset Quotes erd
\end_inset
-.
-
+] The string used for a label with a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sensitive
+Static
\end_layout
\end_inset
- means the (hardcoded) label string depends on the kind of float.
- The
+ labeltype.
+ When
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Counter
+LabelCounter
\end_layout
\end_inset
- label type defines automatically numbered labels.
- See Section
+ is set, this string can be contain the special formatting commands described
+ in Section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:counter"
+reference "sub:Counters"
\end_inset
.
-\end_layout
+\begin_inset Foot
+status collapsed
-\begin_layout Description
+\begin_layout Plain Layout
+For the sake of backwards compatibility, the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexFooter
+@
+\emph on
+style-name
+\emph default
+@
\end_layout
\end_inset
- [[FIXME]]
-\end_layout
-
-\begin_layout Description
+ will be replaced by the expanded
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexHeader
+LabelString
\end_layout
\end_inset
- [[FIXME]]
-\end_layout
-
-\begin_layout Description
+ of style
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+
+\emph on
+style-name
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
+.
+ This feature is now obsolete and should be replaced by the mechanisms of
+ Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-LatexParagraph
+.
\end_layout
\end_inset
- [[FIXME]]
+
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LatexParam
+LabelStringAppendix
\end_layout
\end_inset
- An optional parameter for the corresponding
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+string=""
\end_layout
\end_inset
- stuff.
- This parameter cannot be changed from within LyX.
-\end_layout
-
-\begin_layout Description
+] This is used inside the appendix instead of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexType
+LabelString
\end_layout
\end_inset
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:LatexType"
-
-\end_inset
-
-[
+.
+ Note that every
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Paragraph
-\emph default
-, Command, Environment, Item_Environment,
+LabelString
\end_layout
\end_inset
-
+ statement resets
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+LabelStringAppendix
\end_layout
\end_inset
-] How the layout should be translated into LaTeX.
-
+ too.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Paragraph
+LabelTag
\end_layout
\end_inset
- means nothing special.
-
+ [FIXME] (Used only with XML-type formats.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Command
+Labeltype
\end_layout
\end_inset
- means
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\backslash
-
\emph on
-LatexName
+No_Label
\emph default
-{\SpecialChar \ldots{}
-}
+, Manual, Static, Top_Environment,
+\begin_inset Newline newline
+\end_inset
+
+Centered_Top_Environment, Sensitive, Counter
\end_layout
\end_inset
- and
+]
+\begin_inset Newline newline
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+Manual
\end_layout
\end_inset
- means
-\begin_inset Flex CharStyle:Code
+ means the label is the very first word (up to the first real blank).
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{
-\emph on
-LatexName
-\emph default
-}\SpecialChar \ldots{}
-
-\backslash
-end{
-\emph on
-LatexName
-\emph default
-}
+Use protected spaces if you want more than one word as the label.
\end_layout
\end_inset
-.
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Static
\end_layout
\end_inset
- is the same as
+ means it is defined in the layout (see
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Environment
+LabelString
\end_layout
\end_inset
-, except that a
+).
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-item
+Top_Environment
\end_layout
\end_inset
- is generated for each paragraph of this environment.
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-List_Environment
+Centered_Top_Environment
\end_layout
\end_inset
- is the same as
+ are special cases of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Item_Environment
+Static
\end_layout
\end_inset
-, except that
-\begin_inset Flex CharStyle:Code
+.
+ The label will be printed above the paragraph, but only at the top of an
+ environment or the top of a chain of paragraphs with this layout.
+ Usage is for example the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+Abstract
\end_layout
\end_inset
- is passed as an argument to the environment.
-
-\begin_inset Flex CharStyle:Code
+ layout or the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-LabelWidthString
+Bibliography
\end_layout
\end_inset
- can be defined in the
-\begin_inset Flex CharStyle:MenuItem
+ layout.
+ This is also the case for
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
+Manual
\end_layout
\end_inset
- dialog.
-
+ labels with latex type
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-LatexType
+Environment
\end_layout
\end_inset
- is perhaps a bit misleading, since these rules apply to SGML classes, too.
- Visit the SGML class files for specific examples.
-\end_layout
-
-\begin_layout Standard
-Putting the last few things together, the LaTeX output will be either:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-latexname[latexparam]{\SpecialChar \ldots{}
-}
-\end_layout
-
-\begin_layout Standard
-or:
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-begin{latexname}[latexparam] \SpecialChar \ldots{}
+, in order to make layouts for theorems work correctly.
-\backslash
-end{latexname}.
-\end_layout
-
-\begin_layout Standard
-depending upon the LaTex type.
-\end_layout
-
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+Sensitive
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
+ is a special case for the caption-labels
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-string=""
-\end_layout
+Figure
+\begin_inset Quotes erd
+\end_inset
+ and
+\begin_inset Quotes eld
\end_inset
-] If you put layouts into environments, the leftmargins are not simply added,
- but added with a factor
-\begin_inset Formula $\frac{4}{depth+4}$
+Table
+\begin_inset Quotes erd
\end_inset
.
- Note that this parameter is also used when the margin is defined as
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+Sensitive
\end_layout
\end_inset
- or
+ means the (hardcoded) label string depends on the kind of float.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Dynamic
+Counter
\end_layout
\end_inset
-.
- Then it is added to the manual or dynamic margin.
-
-\begin_inset Newline newline
-\end_inset
+ label type defines automatically numbered labels.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Counters"
-The argument is passed as a string.
- For example
-\begin_inset Quotes eld
\end_inset
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-MM
+LatexName
\end_layout
\end_inset
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
+\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_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-MM
+LatexParam
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
- in the normal font.
- You can get a negative width by prefixing the string with
-\begin_inset Quotes eld
-\end_inset
-
-
+ An optional parameter for the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
--
+LatexName
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- This way was chosen so that the look is the same with each used screen
- font.
-
+ stuff.
+ This parameter cannot be changed from within LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Margin
+LatexType
\end_layout
\end_inset
- [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:LatexType"
+
+\end_inset
+
+[
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\emph on
-Static
+Paragraph
\emph default
-, Manual, Dynamic, First_Dynamic, Right_Address_Box
+, Command, Environment, Item_Environment,
\end_layout
\end_inset
-]
-\begin_inset Newline newline
-\end_inset
-
-The kind of margin that the layout has on the left side.
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Static
+List_Environment
\end_layout
\end_inset
- just means a fixed margin.
+] How the layout should be translated into LaTeX.
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Manual
+Paragraph
\end_layout
\end_inset
- means that the left margin depends on the string entered in the
-\begin_inset Flex CharStyle:MenuItem
+ means nothing special.
+
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+Command
\end_layout
\end_inset
- dialog.
- This is used to typeset nice lists without tabulators.
-
+ means
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Dynamic
-\end_layout
-
-\end_inset
-
- means that the margin depends on the size of the label.
- This is used for automatic enumerated headlines.
- It is obvious that the headline
-\begin_inset Quotes eld
-\end_inset
-
-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
+\backslash
-5.4.3.2.1
-\begin_inset Quotes erd
-\end_inset
+\emph on
+LatexName
+\emph default
+{\SpecialChar \ldots{}
+}
+\end_layout
- plus the space) than
-\begin_inset Quotes eld
\end_inset
-3.2 Very long headline
-\begin_inset Quotes erd
-\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-, even if standard
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Environment
+\end_layout
-word processors
-\begin_inset Quotes erd
\end_inset
- are not able to do this.
-
+ means
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-First_Dynamic
+
+\backslash
+begin{
+\emph on
+LatexName
+\emph default
+}\SpecialChar \ldots{}
+
+\backslash
+end{
+\emph on
+LatexName
+\emph default
+}
\end_layout
\end_inset
- is similar, but only the very first row of the paragraph is dynamic, while
- the others are static; this is used, for example, for descriptions.
+.
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Right_Address_Box
+Item_Environment
\end_layout
\end_inset
- means the margin is chosen in a way that the longest row of this paragraph
- fits to the right margin.
- This is used to typeset an address on the right edge of the page.
-\end_layout
-
-\begin_layout Description
+ is the same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+Environment
\end_layout
\end_inset
- [
+, except that a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+item
\end_layout
\end_inset
-,
+ is generated for each paragraph of this environment.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+List_Environment
\end_layout
\end_inset
-] Whether fragile commands in this layout should be
+ is the same as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+Item_Environment
\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
+, except that
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Newline
+LabelWidthString
\end_layout
\end_inset
- [
+ is passed as an argument to the environment.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-0
+LabelWidthString
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ can be defined in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-\emph on
-1
+\bar under
+L
+\bar default
+ayout\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+aragraph
\end_layout
\end_inset
-] Whether newlines are translated into LaTeX newlines (
+ dialog.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\backslash
+\emph on
+LatexType
+\end_layout
+
+\end_inset
+
+ is perhaps a bit misleading, since these rules apply to SGML classes, too.
+ Visit the SGML class files for specific examples.
+\end_layout
+
+\begin_layout Standard
+Putting the last few things together, the LaTeX output will be either:
+\end_layout
+
+\begin_layout LyX-Code
\backslash
+latexname[latexparam]{\SpecialChar \ldots{}
+}
+\end_layout
+\begin_layout Standard
+or:
\end_layout
-\end_inset
+\begin_layout LyX-Code
-) or not.
- The translation can be switched off to allow more comfortable LaTeX editing
- inside LyX.
+\backslash
+begin{latexname}[latexparam] \SpecialChar \ldots{}
+
+\backslash
+end{latexname}.
+\end_layout
+
+\begin_layout Standard
+depending upon the LaTeX type.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+LeftMargin
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-1
+string=""
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-0
-\end_layout
-
+] If you put layouts into environments, the leftmargins are not simply added,
+ but added with a factor
+\begin_inset Formula $\frac{4}{depth+4}$
\end_inset
-] Whether the following Paragraph is allowed to indent its very first row.
-
+.
+ Note that this parameter is also used when the margin is defined as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Manual
\end_layout
\end_inset
- means that it is not allowed to do so;
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-0
+Dynamic
\end_layout
\end_inset
- means it could do so if it wants to.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-ObsoletedBy
-\end_layout
+.
+ 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
- [[FIXME]]
-\end_layout
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-OptionalArgs
+MM
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-int=0
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ means that the paragraph is indented with the width of
+\begin_inset Quotes eld
\end_inset
-] The number of optional arguments that can be used with this layout.
- This is useful for things like section headings, and only makes sense with
- LaTeX.
-\end_layout
-\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ParIndent
+MM
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-string=""
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+ in the normal font.
+ You can get a negative width by prefixing the string with
+\begin_inset Quotes eld
\end_inset
-] The indent of the very first line of a paragraph.
- The
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Parindent
+-
\end_layout
\end_inset
- will be fixed for a certain layout.
- The exception is Standard layout, since the indentation of a Standard layout
- paragraph can be prohibited with
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This way was chosen so that the look is the same with each used screen
+ font.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NextNoIndent
+Margin
\end_layout
\end_inset
-.
- Also, Standard layout paragraphs inside environments use the
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Parindent
+
+\emph on
+Static
+\emph default
+, Manual, Dynamic, First_Dynamic, Right_Address_Box
\end_layout
\end_inset
- of the environment, not their native one.
- For example, Standard paragraphs inside an enumeration are not indented.
-\end_layout
+]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+The kind of margin that the layout has on the left side.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Parsep
+Static
\end_layout
\end_inset
- [
+ just means a fixed margin.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+Manual
\end_layout
\end_inset
-] The vertical space between two paragraphs of this layout.
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+ means that the left margin depends on the string entered in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Parskip
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
\end_layout
\end_inset
- [
+ dialog.
+ This is used to typeset nice lists without tabulators.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float=0
+Dynamic
\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
+ 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
-skip
+5.4.3.2.1 Very long headline
\begin_inset Quotes erd
\end_inset
- to typeset a document.
- When
+ must have a wider left margin (as wide as
\begin_inset Quotes eld
\end_inset
-indent
+5.4.3.2.1
\begin_inset Quotes erd
\end_inset
- is chosen, this value is completely ignored.
- When
+ plus the space) than
\begin_inset Quotes eld
\end_inset
-skip
+3.2 Very long headline
\begin_inset Quotes erd
\end_inset
- is chosen, the parindent of a LaTeXtype
+, even if standard
\begin_inset Quotes eld
\end_inset
-Paragraph
+word processors
\begin_inset Quotes erd
\end_inset
- layout is ignored and all paragraphs are separated by this parskip argument.
- The vertical space is calculated with
+ are not able to do this.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-value
-\begin_inset space ~
-\end_inset
-
-* DefaultHeight
+First_Dynamic
\end_layout
\end_inset
- where
+ is similar, but only the very first row of the paragraph is dynamic, while
+ the others are static; this is used, for example, for descriptions.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-DefaultHeight
+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.
+ means the margin is chosen in a way that the longest row of this paragraph
+ fits to the right margin.
+ This is used to typeset an address on the right edge of the page.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-PassThru
+NeedProtect
\end_layout
\end_inset
[
-\emph on
-
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-
-\emph default
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-] Whether the contents of this paragraph should be output in raw form, meaning
- without special translations that LaTeX would require.
-\end_layout
-
-\begin_layout Description
+] Whether fragile commands in this layout should be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Preamble
-\end_layout
-
-\end_inset
-
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Preamble"
-
-\end_inset
-
-Information to be included in the LaTeX preamable when this style is used.
- Used to define macros, load packages, etc., required by this particular
- style.
- Must end with
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-EndPreamble
+\backslash
+protect
\end_layout
\end_inset
-
-\begin_inset Quotes erd
-\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
-[
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+0
\end_layout
\end_inset
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "des:Requires"
-
-\end_inset
-
-Whether the layout requires the feature
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+1
\end_layout
\end_inset
-.
- See the description of
+] Whether newlines are translated into LaTeX newlines (
\begin_inset Flex CharStyle: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_layout
\end_inset
-) for information on `features'.
-
+) or not.
+ The translation can be switched off to allow more comfortable LaTeX editing
+ inside LyX.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-RightMargin
+NextNoIndent
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string=""
+1
\end_layout
\end_inset
-] Similar to
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LeftMargin
+
+\emph on
+0
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+] Whether the following Paragraph is allowed to indent its very first row.
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Spacing
+1
\end_layout
\end_inset
- [
+ means that it is not allowed to do so;
\begin_inset Flex CharStyle:Code
status collapsed
\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 layout.
- The arguments
+ means it could do so if it wants to.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-single
+ObsoletedBy
\end_layout
\end_inset
-,
+ Name of a layout that has replaced this layout.
+ This is used to rename a layout, while keeping backward compatibility.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-onehalf
+OptionalArgs
\end_layout
\end_inset
- and
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-double
+int=0
\end_layout
\end_inset
- correspond respectively to a multiplier value of 1, 1.25 and 1.667.
- If you specify the argument
+] The number of optional arguments that can be used with this layout.
+ This is useful for things like section headings, and only makes sense with
+ LaTeX.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-other
+ParIndent
\end_layout
\end_inset
-, then you should also provide a numerical argument which will be the actual
- multiplier value.
- Note that, contrary to other parameters,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Spacing
+string=""
\end_layout
\end_inset
- implies the generation of specific LaTeX code, using the package
-\family roman
-
+] The indent of the very first line of a paragraph.
+ The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-setspace.sty
+Parindent
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ will be fixed for a certain layout.
+ The exception is Standard layout, since the indentation of a Standard layout
+ paragraph can be prohibited with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TextFont
+NextNoIndent
\end_layout
-\end_inset
-
- The font used for the text body .
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
-
\end_inset
.
-\end_layout
-
-\begin_layout Description
-Need
+ Also, Standard layout paragraphs inside environments use the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\series medium
-TocLevel [int]
+Parindent
\end_layout
\end_inset
- The level of the style in the table of contents.
- This is used for automatic numbering of section headings.
+ of the environment, not their native one.
+ For example, Standard paragraphs inside an enumeration are not indented.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TopSep
+Parsep
\end_layout
\end_inset
\end_inset
-] The vertical space with which the very first of a chain of paragraphs
- with this layout is separated from the previous paragraph.
- If the previous paragraph has another layout, the separations are not simply
- added, but the maximum is taken.
-\end_layout
-
-\begin_layout Subsection
-Floats
+] The vertical space between two paragraphs of this layout.
\end_layout
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:floats"
-
-\end_inset
-
-Since version 1.3.0 of LyX, it is has been both possible and necessary to
- define the floats (
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-figure
+Parskip
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:MenuItem
+ [
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-table
+float=0
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- Standard floats are included in the file
-\begin_inset Flex CharStyle:Code
-status collapsed
+] LyX allows the user to choose either
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-stdfloats.inc
-\end_layout
+indent
+\begin_inset Quotes erd
+\end_inset
+ or
+\begin_inset Quotes eld
\end_inset
-, so you may have to do no more than add
-\end_layout
+skip
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-Input stdfloats.inc
-\end_layout
-
-\begin_layout Standard
-to your layout file.
- If you want to implement a text class that proposes some other float types
- (like the AGU class bundled with LyX), the information below will hopefully
- help you:
-\end_layout
-
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Extension
-\end_layout
+ to typeset a document.
+ When
+\begin_inset Quotes eld
+\end_inset
+indent
+\begin_inset Quotes erd
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-string
-\end_layout
-
+ is chosen, this value is completely ignored.
+ When
+\begin_inset Quotes eld
\end_inset
-=
+skip
\begin_inset Quotes erd
\end_inset
+ is chosen, the parindent of a LaTeXtype
+\begin_inset Quotes eld
+\end_inset
+Paragraph
\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
+ layout is ignored and all paragraphs are separated by this parskip argument.
+ The vertical space is calculated with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-GuiName
+value
+\begin_inset space ~
+\end_inset
+
+* DefaultHeight
\end_layout
\end_inset
- [
+ where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+DefaultHeight
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
-
-\begin_inset Quotes erd
-\end_inset
-
-] The string that will be used in the menus and also for the caption.
+ 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
status collapsed
\begin_layout Plain Layout
-LaTeXBuiltin
+PassThru
\end_layout
\end_inset
- [
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:PathThru"
+
+\end_inset
+
+[
+\emph on
+
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
+
+\emph default
,
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-] Set to
+] Whether the contents of this paragraph should be output in raw form, meaning
+ without special translations that LaTeX would require.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+Preamble
\end_layout
\end_inset
- if the float is already defined by the LaTeX document class.
- If this is set to
-\begin_inset Flex CharStyle:Code
-status collapsed
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Preamble"
-\begin_layout Plain Layout
-0
-\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
\end_inset
-, the float will be defined using the LaTeX package
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-float
+EndPreamble
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
\end_layout
status collapsed
\begin_layout Plain Layout
-ListName
+Requires
\end_layout
\end_inset
- [
+[
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "des:Requires"
-\begin_inset Quotes erd
\end_inset
-] The heading used for the list of floats.
-\end_layout
-
-\begin_layout Description
+Whether the layout requires the feature
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NumberWithin
+string
\end_layout
\end_inset
- [
+.
+ See the description of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+Provides
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+ above (page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
-\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
+) for information on `features'.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chapter
+RightMargin
\end_layout
\end_inset
-, the floats will be numbered within chapters.
-
-\end_layout
-
-\begin_layout Description
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Placement
+string=""
\end_layout
\end_inset
- [
+] Similar to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LeftMargin
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+.
+\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Spacing
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] The default placement for the given class of floats.
- The string should be as in standard LaTeX:
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-t
+
+\emph on
+single
+\emph default
+, onehalf, double, other
\end_layout
\end_inset
-,
+
+\emph on
+value
+\emph default
+] This defines what the default spacing should be in the layout.
+ The arguments
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-b
+single
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-p
+onehalf
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-h
+double
\end_layout
\end_inset
- for top, bottom, page, and here, respectively.
-\begin_inset Foot
+ correspond respectively to a multiplier value of 1, 1.25 and 1.667.
+ If you specify the argument
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note that the order of these letters in the string is irrelevant, like in
- LaTeX.
+other
\end_layout
\end_inset
- On top of that there is a new type,
+, then you should also provide a numerical argument which will be the actual
+ multiplier value.
+ Note that, contrary to other parameters,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-H
+Spacing
\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
+ implies the generation of specific LaTeX code, using the package
+\family roman
- and nowhere else.
- Note however that the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-H
+setspace.sty
\end_layout
\end_inset
- specifier is special and, because of implementation details, cannot be
- used in non-builtin float types.
- If you do not understand what this means, just use
-\begin_inset Quotes eld
-\end_inset
-
+.
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tbp
+TextFont
\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 Quotes erd
\end_inset
.
status collapsed
\begin_layout Plain Layout
-Style
+
+\series medium
+TocLevel [int]
\end_layout
\end_inset
- [
+ The level of the style in the table of contents.
+ This is used for automatic numbering of section headings.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+TopSep
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+float=0
+\end_layout
+
\end_inset
+] The vertical space with which the very first of a chain of paragraphs
+ with this layout is separated from the previous paragraph.
+ If the previous paragraph has another layout, the separations are not simply
+ added, but the maximum is taken.
+\end_layout
+
+\begin_layout Subsection
+Floats
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Floats"
-\begin_inset Quotes erd
\end_inset
-] The style used when defining the float using
-\begin_inset Flex CharStyle:Code
+
+\end_layout
+
+\begin_layout Standard
+Since version 1.3.0 of LyX, it is has been both possible and necessary to
+ define the floats (
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
+figure
+\end_layout
-\backslash
-newfloat
+\end_inset
+
+,
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+table
\end_layout
\end_inset
-.
+, \SpecialChar \ldots{}
+) in the text class itself.
+ Standard floats are included in the file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+stdfloats.inc
+\end_layout
+
+\end_inset
+
+, so you may have to do no more than add
+\end_layout
+
+\begin_layout LyX-Code
+Input stdfloats.inc
+\end_layout
+
+\begin_layout Standard
+to your layout file.
+ If you want to implement a text class that proposes some other float types
+ (like the AGU class bundled with LyX), the information below will hopefully
+ help you:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Type
+Extension
\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-] The
-\begin_inset Quotes eld
-\end_inset
-
-type
-\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
- of the new class of floats, like program or algorithm.
- After the appropriate
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-newfloat
+GuiName
\end_layout
\end_inset
-, commands such as
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{program}
+string
\end_layout
\end_inset
- or
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
+=
+\begin_inset Quotes erd
+\end_inset
-\backslash
-end{algorithm*}
-\end_layout
+\begin_inset Quotes erd
\end_inset
- will be available.
+] The string that will be used in the menus and also for the caption.
\end_layout
-\begin_layout Standard
-Note that defining a float with type
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-type
+LaTeXBuiltin
\end_layout
\end_inset
- automatically defines the corresponding counter with name
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
\emph on
-type
+0
\end_layout
\end_inset
-.
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Subsection
-Inset layouts and Flex insets
+\begin_layout Plain Layout
+1
\end_layout
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:charstyle"
-
\end_inset
-LyX has supported character styles since version 1.4.0; since version 1.6.0
- these are called Flex insets.
-
-\end_layout
-
-\begin_layout Standard
-Furthermore, it is possible to define the general layout of many different
- types of insets.
- Currently, InsetLayout can be used to customize the layout parameters
- for footnotes, marginal notes, note insets, ERT insets, branches, listings,
- indexes, boxes, tables, algorithms, URLs, and optional arguments, as well
- as Flex insets.
-
-\end_layout
-
-\begin_layout Standard
-Flex insets come in three different kinds:
-\end_layout
-
-\begin_layout Itemize
-character style (
+] Set to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+1
\end_layout
\end_inset
-): These define semantic markup corresponding to such LaTeX commands as
-
+ if the float is already defined by the LaTeX document class.
+ If this is set to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-noun
+0
\end_layout
\end_inset
- and
+, the float will be defined using the LaTeX package
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-code
+float
\end_layout
\end_inset
.
\end_layout
-\begin_layout Itemize
-user custom (
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Custom
+ListName
\end_layout
\end_inset
-): These can be used to define custom collapsable insets, similar to ERT,
- footnote, and the like.
-\end_layout
-
-\begin_layout Itemize
-XML elements (
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Element
+string
\end_layout
\end_inset
-): For use with DocBook classes.
-\end_layout
-
-\begin_layout Standard
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-InsetLayout
-\end_layout
+\begin_inset Quotes erd
\end_inset
- definition starting line is of the form
-\end_layout
-
-\begin_layout LyX-Code
-InsetLayout <Type> <Name>
+] The heading used for the list of floats.
\end_layout
-\begin_layout Standard
-where
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<Type>
+NumberWithin
\end_layout
\end_inset
- can be
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Algorithm
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Branch
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] This (optional) argument determines whether floats of this class will
+ be numbered within some sectional unit of the document.
+ For example, if within is equal to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Box
+chapter
\end_layout
\end_inset
-,
+, the floats will be numbered within chapters.
+
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ERT
+Placement
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Figure
+string
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Foot
-\end_layout
+\begin_inset Quotes erd
\end_inset
-,
+] The default placement for the given class of floats.
+ The string should be as in standard LaTeX:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Index
+t
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Listings
+b
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-Marginal
+p
\end_layout
\end_inset
-,
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note:Comment
+h
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
+ for top, bottom, page, and here, respectively.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Note:Note
+Note that the order of these letters in the string is irrelevant, like in
+ LaTeX.
\end_layout
\end_inset
-,
+ On top of that there is a new type,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Note:GreyedOut
+H
\end_layout
\end_inset
-,
+, which does not really correspond to a float, since it means: put it
+\begin_inset Quotes eld
+\end_inset
+
+here
+\begin_inset Quotes erd
+\end_inset
+
+ and nowhere else.
+ Note however that the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-OptArg
+H
\end_layout
\end_inset
-,
+ specifier is special and, because of implementation details, cannot be
+ used in non-built in float types.
+ If you do not understand what this means, just use
+\begin_inset Quotes eld
+\end_inset
+
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Table
+tbp
\end_layout
\end_inset
-,
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-URL
+Style
\end_layout
\end_inset
-, or
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Flex
+string
\end_layout
\end_inset
-.
- If
-\begin_inset Flex CharStyle:Code
-status collapsed
+=
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-<Type>
-\end_layout
+\begin_inset Quotes erd
\end_inset
- is
+] The style used when defining the float using
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Flex
+
+\backslash
+newfloat
\end_layout
\end_inset
-, then
+.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<Name>
+Type
\end_layout
\end_inset
- should have the form
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-SubType:StyleName
+string
\end_layout
\end_inset
-, where
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] The
+\begin_inset Quotes eld
+\end_inset
+
+type
+\begin_inset Quotes erd
+\end_inset
+
+ of the new class of floats, like program or algorithm.
+ After the appropriate
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-SubType
+
+\backslash
+newfloat
\end_layout
\end_inset
- is either
+, commands such as
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CharStyle
+
+\backslash
+begin{program}
\end_layout
\end_inset
-,
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Custom
+
+\backslash
+end{algorithm*}
\end_layout
\end_inset
-, or
+ will be available.
+\end_layout
+
+\begin_layout Standard
+Note that defining a float with type
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Element
+
+\emph on
+type
\end_layout
\end_inset
-, and
+ automatically defines the corresponding counter with name
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-StyleName
+
+\emph on
+type
+\end_layout
+
+\end_inset
+
+.
\end_layout
+\begin_layout Subsection
+Flex insets and InsetLayout
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Flex-insets-and"
+
\end_inset
- is any valid identifier.
+
+\end_layout
+
+\begin_layout Standard
+LyX has supported character styles since version 1.4.0; as of version 1.6.0,
+ these are called Flex insets.
\end_layout
\begin_layout Standard
-The following
+Flex insets come in three different kinds:
+\end_layout
+
+\begin_layout Itemize
+character style (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InsetLayout
+CharStyle
\end_layout
\end_inset
- section can contain the following entries:
-\end_layout
-
-\begin_layout Description
+): These define semantic markup corresponding to such LaTeX commands as
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-BgColor
+
+\backslash
+noun
\end_layout
\end_inset
- The color for the inset's background.
- These valid colors are defined in
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-src/ColorCode.h
+
+\backslash
+code
\end_layout
\end_inset
.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+user custom (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-CopyStyle
+Custom
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "des:CopyStyle"
+): These can be used to define custom collapsible insets, similar to TeX
+ code, footnote, and the like.
+ An obvious example is an endnote inset, which is defined in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+endnote
+\end_layout
\end_inset
-).
+ module.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+XML elements (
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Decoration
+Element
\end_layout
\end_inset
- can be
+): For use with DocBook classes.
+\end_layout
+
+\begin_layout Standard
+Flex insets are defined using the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Classic
+InsetLayout
\end_layout
\end_inset
-,
+ tag, which shall be explained in a moment.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+InsetLayout
\end_layout
\end_inset
-, or
+ tag also serves another function: It can be used to customize the general
+ layout of many different types of insets.
+ Currently,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+InsetLayout
\end_layout
\end_inset
-, describing the rendering style used for the inset's frame and buttons.
- Footnotes generally use
+ can be used to customize the layout parameters for footnotes, marginal
+ notes, note insets, TeX code (ERT) insets, branches, listings, indexes,
+ boxes, tables, algorithms, URLs, and optional arguments, as well as to
+ define Flex insets.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Classic
+InsetLayout
\end_layout
\end_inset
-; ERT insets generally use
+ definition must begin with a line of the form:
+\end_layout
+
+\begin_layout LyX-Code
+InsetLayout <Type>
+\end_layout
+
+\begin_layout Standard
+Here
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Minimalistic
+<Type>
\end_layout
\end_inset
-; and character styles use
+ indicates the inset whose layout is being defined, and here there are two
+ cases.
+\end_layout
+
+\begin_layout Enumerate
+The layout for a pre-existing inset is being modified.
+ In this case, can be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Conglomerate
+<Type>
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ any one of the following:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Font
+Algorithm
\end_layout
\end_inset
- The font used for both the text body
-\emph on
-and
-\emph default
- the label.
- See section
-\begin_inset space ~
-\end_inset
-
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
+\begin_layout Plain Layout
+Branch
+\end_layout
\end_inset
-.
- Note that defining this font automatically defines the
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Box
\end_layout
\end_inset
- to the same value, so define this first and define
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Box:shaded
\end_layout
\end_inset
- later if you want them to be different.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ForceLTR
+ERT
\end_layout
\end_inset
- [[FIXME]]
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Figure
\end_layout
-\begin_layout Description
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+Foot
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:FreeSpacing"
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-KeepEmpty
+Index
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:KeepEmpty"
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Info
\end_layout
\end_inset
- What will be displayed on the button or elsewhere as the inset label.
- Some inset types (ERT and Branch) modify this label on the fly.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+Info:menu
\end_layout
\end_inset
- The font used for the label.
- See section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
-
-\end_inset
-
-.
- Note that this definition can never appear before
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Font
+Info:shortcut
\end_layout
\end_inset
-, lest it be ineffective.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Info:shortcuts
\end_layout
\end_inset
- The name of the corresponding LaTeX stuff.
- Either the environment or command name.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexParam
+Listings
\end_layout
\end_inset
- The optional parameter for the corresponding
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexName
+Marginal
\end_layout
\end_inset
- stuff, including possible bracket pairs like
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-[]
+Note:Comment
\end_layout
\end_inset
-.
- This parameter cannot be changed from within LyX.
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LatexType
+Note:Note
\end_layout
\end_inset
- As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:LatexType"
-
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyxType
+Note:GreyedOut
\end_layout
\end_inset
- Can be
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-charstyle
+OptArg
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-custom
+Table
\end_layout
\end_inset
-,
+, or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-element
+URL
\end_layout
\end_inset
-,
+.
+
+\end_layout
+
+\begin_layout Enumerate
+The layout for a Flex inset is being defined.
+ In this case,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-end
+<Type>
\end_layout
\end_inset
- (indicating a dummy definition ending definitions of charstyles etc.).
- This entry is only meaningful for Flex (user definable) insets.
-\end_layout
-
-\begin_layout Description
+ can be any valid identifier not used by a pre-existing inset.
+ Note that the definition of a flex inset must
+\emph on
+ als
+\emph default
+o include a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NeedProtect
+LyXType
\end_layout
\end_inset
- [
+ entry.
+\end_layout
+
+\begin_layout Standard
+The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-0
+InsetLayout
\end_layout
\end_inset
-,
+ definition can contain the following entries:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-1
+BgColor
\end_layout
\end_inset
-] Whether fragile commands in this layout should be
+ The color for the inset's background.
+ The valid colors are defined in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-protect
+src/ColorCode.h
\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
-Preamble
+CopyStyle
\end_layout
\end_inset
As with paragraph styles (see page
\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Preamble"
+LatexCommand ref
+reference "des:CopyStyle"
\end_inset
status collapsed
\begin_layout Plain Layout
-Requires
+CustomPars
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-string
+
+\emph on
+0
\end_layout
\end_inset
-] As with paragraph styles (see page
-\begin_inset CommandInset ref
-LatexCommand pageref
-reference "des:Requires"
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
\end_inset
-).
+] Indicates whether the user may employ the Paragraph Settings dialog to
+ customize the paragraph.
\end_layout
-\begin_layout Subsection
-Counters
-\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:counter"
+\begin_layout Plain Layout
+Decoration
+\end_layout
\end_inset
-Since version 1.3.0 of LyX, it is both possible and necessary to define the
- counters (
-\begin_inset Flex CharStyle:MenuItem
+ can be
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-chapter
+Classic
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-figure
+Minimalistic
\end_layout
\end_inset
-, \SpecialChar \ldots{}
-) in the text class itself.
- The standard counters are defined in the file
+, or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-stdcounters.inc
+Conglomerate
\end_layout
\end_inset
-, so you may have to do no more than add
-\end_layout
+, describing the rendering style used for the inset's frame and buttons.
+ Footnotes generally use
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Input stdcounters.inc
+\begin_layout Plain Layout
+Classic
\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, using the
- following parameters:
-\end_layout
+\end_inset
-\begin_layout Description
+, ERT insets generally
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString [string=""]
+Minimalistic
\end_layout
\end_inset
- when this is defined, this string defines how the counter is displayed.
- Setting this value sets
+, and character styles
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix
+Conglomerate
\end_layout
\end_inset
- to the same value.
- The following special constructs can be used in the string:
+.
\end_layout
-\begin_deeper
-\begin_layout Itemize
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-thecounter
+End
\end_layout
\end_inset
- will be replaced by the expansion of the
+ Required at the end of the InsetLayout declarations.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+Font
\end_layout
\end_inset
- (or
-\begin_inset Flex CharStyle:Code
-status collapsed
+ The font used for both the text body
+\emph on
+and
+\emph default
+ the label.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-LabelStringAppendix
-\end_layout
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
\end_inset
-) of the counter
+.
+ Note that defining this font automatically defines the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-counter
+LabelFont
\end_layout
\end_inset
-.
-
+ to the same value, so define this first and define
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
\end_layout
-\begin_layout Itemize
-counter values can be expressed using LaTeX-like macros
+\end_inset
+
+ later if you want them to be different.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+ForceLTR
+\end_layout
-\backslash
+\end_inset
-\emph on
-numbertype
-\emph default
-{
-\emph on
-counter
-\emph default
-}
-\end_layout
+ 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
-, where
+g.
+\begin_inset space \space{}
+\end_inset
+
+in TeX code or URL.
+ A kludge.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-numbertype
+ForcePlain
\end_layout
\end_inset
- can be:
-\begin_inset Foot
+ [
+\begin_inset Flex CharStyle: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 descibed below will produce arabic numerals.
- It would not be surprising to see this change in the future.
+0
\end_layout
\end_inset
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-arabic
+1
\end_layout
\end_inset
-: 1, 2, 3,\SpecialChar \ldots{}
-;
+] Indicates whether the PlainLayout should be used or, instead, the user
+ can change the paragraph style used in the inset.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-alph
+FreeSpacing
\end_layout
\end_inset
- for lower-case letters: a, b, c, \SpecialChar \ldots{}
-;
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:FreeSpacing"
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Alph
+InToc
\end_layout
\end_inset
- for upper-case letters: A, B, C, \SpecialChar \ldots{}
-;
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-roman
+
+\emph on
+0
\end_layout
\end_inset
- for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
-;
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Roman
+1
\end_layout
\end_inset
- for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
-;
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-hebrew
+KeepEmpty
\end_layout
\end_inset
- for hebrew numerals.
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:KeepEmpty"
+
+\end_inset
+
+).
\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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-master
+LabelFont
\end_layout
\end_inset
- (defined via
+ The font used for the label.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that this definition can never appear before
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Within
+Font
\end_layout
\end_inset
-), the string
+, lest it be ineffective.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-themaster.
-\backslash
-arabic{counter}
+LabelString
\end_layout
\end_inset
- is used; otherwise the string
+ What will be displayed on the button or elsewhere as the inset label.
+ Some inset types (TeX code and Branch) modify this label on the fly.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-arabic{counter}
+LatexName
\end_layout
\end_inset
- is used.
+ The name of the corresponding LaTeX stuff.
+ Either the environment or command name.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-LabelStringAppendix [string=""]
+LatexParam
\end_layout
\end_inset
- Same as
+ The optional parameter for the corresponding
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelString
+LatexName
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Description
+ stuff, including possible bracket pairs like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Name
+[]
\end_layout
\end_inset
- [
+.
+ This parameter cannot be changed from within LyX.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+LatexType
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
-
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:LatexType"
-\begin_inset Quotes erd
\end_inset
-] The name of the counter.
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Within
+LyxType
\end_layout
\end_inset
- [
+ Can be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-string
+charstyle
\end_layout
\end_inset
-=
-\begin_inset Quotes erd
-\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+custom
+\end_layout
-\begin_inset Quotes erd
\end_inset
-] If this is set to the name of another counter, the present counter will
- be reset everytime the other one is increased.
- For example,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-subsection
+element
\end_layout
\end_inset
- is numbered inside
+, or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-section
+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.
\end_layout
-\begin_layout Subsection
-Font description
-\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:fonts"
+\begin_layout Plain Layout
+MultiPar
+\end_layout
\end_inset
-A font description looks like this:
-\end_layout
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-Font
-\family roman
\emph on
-or
-\family default
-\emph default
- LabelFont
-\end_layout
-
-\begin_layout LyX-Code
- ...
-\end_layout
-
-\begin_layout LyX-Code
-EndFont
+0
\end_layout
-\begin_layout Standard
-The following commands are available:
-\end_layout
+\end_inset
-\begin_layout Description
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Color
+1
\end_layout
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
+] Whether multiple paragraphs are permitted in this inset.
+ This will also set CustomPars to the same value and ForcePlain to the opposite
+ value.
+ These can be reset to other values, if they are used
\emph on
-none
+after
+\emph default
+ MultiPar.
\end_layout
-\end_inset
-
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-black
+NeedProtect
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-white
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-red
+1
\end_layout
\end_inset
-,
+] Whether fragile commands in this layout should be
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-green
+
+\backslash
+protect
\end_layout
\end_inset
-,
+'ed.
+ (Note: This is
+\emph on
+not
+\emph default
+ whether the command should itself be protected.)
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-blue
+PassThru
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-cyan
+
+\emph on
+0
\end_layout
\end_inset
-,
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-magenta
+1
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-yellow
-\end_layout
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "des:PathThru"
\end_inset
-]
+).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Family
+Preamble
\end_layout
\end_inset
- [
-\emph on
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Roman
-\end_layout
+ As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Preamble"
\end_inset
+).
+\end_layout
-\emph default
-,
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sans
+Requires
\end_layout
\end_inset
-,
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Typewriter
+string
\end_layout
\end_inset
-]
-\end_layout
+] As with paragraph styles (see page
+\begin_inset CommandInset ref
+LatexCommand pageref
+reference "des:Requires"
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-Misc
+).
\end_layout
+\begin_layout Subsection
+Counters
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:Counters"
+
\end_inset
- [
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-string
\end_layout
-\end_inset
-
-] Valid argument sare:
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Since version 1.3.0 of LyX, it is both possible and necessary to define the
+ counters (
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-emph
+chapter
\end_layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-noun
+figure
\end_layout
\end_inset
-,
+, \SpecialChar \ldots{}
+) in the text class itself.
+ The standard counters are defined in the file
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-underbar
+stdcounters.inc
\end_layout
\end_inset
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-no_emph
+, so you may have to do no more than add
\end_layout
-\end_inset
+\begin_layout LyX-Code
+Input stdcounters.inc
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+to your layout file to get them to work.
+ But if you want to define custom counters, then you can do so.
+ The counter declaration must begin with:
+\end_layout
-\begin_layout Plain Layout
-no_noun
+\begin_layout LyX-Code
+Counter name
\end_layout
+\begin_layout Standard
+where of course `name' is replaced by the name of the counter.
+ And it must end with
+\begin_inset Quotes eld
\end_inset
- and
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-no_bar
+End
\end_layout
\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
.
- Each of these turns on or off the corresponding attribute.
+ The following parameters can also be used:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Series
+LabelString [string=""]
\end_layout
\end_inset
- [
-\emph on
-
+ when this is defined, this string defines how the counter is displayed.
+ Setting this value sets
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Medium
+LabelStringAppendix
\end_layout
\end_inset
+ to the same value.
+ The following special constructs can be used in the string:
+\end_layout
-\emph default
-,
+\begin_deeper
+\begin_layout Itemize
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Bold
+
+\backslash
+thecounter
\end_layout
\end_inset
-]
-\end_layout
-
-\begin_layout Description
+ will be replaced by the expansion of the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Shape
+LabelString
\end_layout
\end_inset
- [
-\emph on
-
+ (or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-Up
+LabelStringAppendix
\end_layout
\end_inset
-
-\emph default
-,
+) of the counter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Italic
+counter
\end_layout
\end_inset
-,
+.
+
+\end_layout
+
+\begin_layout Itemize
+counter values can be expressed using LaTeX-like macros
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-SmallCaps
+
+\backslash
+
+\emph on
+numbertype
+\emph default
+{
+\emph on
+counter
+\emph default
+}
\end_layout
\end_inset
-,
+, where
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Slanted
+
+\emph on
+numbertype
\end_layout
\end_inset
-]
-\end_layout
+ can be:
+\begin_inset Foot
+status collapsed
-\begin_layout Description
+\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 CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Size
+arabic
\end_layout
\end_inset
- [
+: 1, 2, 3,\SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-tiny
+alph
\end_layout
\end_inset
-,
+ for lower-case letters: a, b, c, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-small
+Alph
\end_layout
\end_inset
-,
+ for upper-case letters: A, B, C, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\emph on
-normal
+roman
\end_layout
\end_inset
-,
+ for lower-case roman numerals: i, ii, iii, \SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-large
+Roman
\end_layout
\end_inset
-,
+ for upper-case roman numerals: I, II, III\SpecialChar \ldots{}
+;
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-larger
+hebrew
\end_layout
\end_inset
-,
+ for hebrew numerals.
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+If LabelString is not defined, a default value is constructed as follows:
+ if the counter has a master counter
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-largest
+master
\end_layout
\end_inset
-,
+ (defined via
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-huge
+Within
\end_layout
\end_inset
-,
+), the string
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-giant
+
+\backslash
+themaster.
+\backslash
+arabic{counter}
\end_layout
\end_inset
-]
+ is used; otherwise the string
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+arabic{counter}
\end_layout
-\begin_layout Subsection
-Upgrading old layout files
+\end_inset
+
+ is used.
\end_layout
-\begin_layout Standard
-The file format of layout files changes from time to time, so old layout
- files need to be converted.
- This process has been automated since LyX 1.4.0: If LyX reads an old format
- layout file it will call the conversion tool
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/scripts/layout2layout.py
+LabelStringAppendix [string=""]
\end_layout
\end_inset
- and convert it to a temporary file in current format.
- The original file is left untouched.
- If you want to convert the layout file permanently, just call the converter
- by hand:
+ Same as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelString
\end_layout
-\begin_layout LyX-Code
-python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
+\end_inset
+
+, but for use in the Appendix.
\end_layout
-\begin_layout Standard
-(You need to replace
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$LyXDir
+Within
\end_layout
\end_inset
- with the name of your LyX system directory, unless you happen to have defined
- such an environment variable.) Then copy
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-myclassnew.layout
+string
\end_layout
\end_inset
- to
+=
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+] If this is set to the name of another counter, the present counter will
+ be reset every time the other one is increased.
+ For example,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir/layouts/
+subsection
\end_layout
\end_inset
-.
+ is numbered inside
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+section
\end_layout
-\begin_layout Standard
-The automatic conversion only handles syntax changes.
- It cannot handle the case where the contents of included files was changed,
- so these will have to be converted separately.
+\end_inset
+
+.
\end_layout
-\begin_layout Section
-Creating Templates
+\begin_layout Subsection
+Font description
\begin_inset CommandInset label
LatexCommand label
-name "sec:templates"
+name "sub:Font-description"
\end_inset
\end_layout
\begin_layout Standard
-Templates are created just like usual documents.
- The only difference is that usual documents contain all possible settings,
- including the font scheme and the paper size.
- Usually a user doesn't want a template to overwrite his defaults in these
- cases.
- For that reason, the designer of a template should remove the corresponding
- commands like
+A font description looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Font
+\family roman
+\emph on
+or
+\family default
+\emph default
+ LabelFont
+\end_layout
+
+\begin_layout LyX-Code
+ ...
+\end_layout
+
+\begin_layout LyX-Code
+EndFont
+\end_layout
+
+\begin_layout Standard
+The following commands are available:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-fontscheme
+Color
\end_layout
\end_inset
- or
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\backslash
-papersize
+\emph on
+none
\end_layout
\end_inset
- from the template LyX file.
- This can be done with any simple text-editor, for example
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-vi
+black
\end_layout
\end_inset
- or
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-xedit
+white
\end_layout
\end_inset
-.
-
-\end_layout
-
-\begin_layout Standard
-Put the edited template files you create in
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir/templates/
+red
\end_layout
\end_inset
-, copy the ones you use from the global template directory in
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/templates/
+green
\end_layout
\end_inset
- to the same place, and redefine the template path in the
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\family sans
-\bar default
-ools
-\family default
-\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
-Paths
+blue
\end_layout
\end_inset
- dialog.
-\end_layout
-
-\begin_layout Standard
-Note that there is a template which has a particular meaning:
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-defaults.lyx
+cyan
\end_layout
\end_inset
-.
- This template is loaded everytime you create a new document with
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
\begin_layout Plain Layout
-
-\bar under
-F
-\bar default
-ile
+magenta
\end_layout
\end_inset
-\SpecialChar \menuseparator
-
-\begin_inset Flex CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-N
-\bar default
-ew
+yellow
\end_layout
\end_inset
- in order to provide useful defaults.
- To create this template from inside LyX, all you have to do is to open
- a document with the correct settings, and use the
-\begin_inset Flex CharStyle:MenuItem
+]
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Sa
-\bar under
-v
-\bar default
-e as Document Defaults
+Family
\end_layout
\end_inset
- button.
-\end_layout
+ [
+\emph on
-\begin_layout Chapter
-Including External Material
-\end_layout
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain 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.
+Roman
\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 CharStyle:MenuItem
+,
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
-External Material
+Sans
\end_layout
\end_inset
-.
- Furthermore, it is possible to roll your own template to support a specific
- kind of material.
- Later we'll describe in more detail what is involved, and hopefully you
- will submit all the templates you create so we can include them in a later
- LyX version.
-\end_layout
-
-\begin_layout Standard
-Another basic idea of the external material feature is to distinguish between
- the original file that serves as a base for final material and the produced
- file that is included in your exported or printed document.
- For example, consider the case of a figure produced with
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Xfig
+Typewriter
\end_layout
\end_inset
-.
- The Xfig application itself works on an original file with the
+]
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.fig
+Misc
\end_layout
\end_inset
- extension.
- Within XFig, you create and change your figure, and when you are done,
- you save the
+ [
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-fig
+string
\end_layout
\end_inset
--file.
- When you want to include the figure in your document, you invoke
+] Valid argument are:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-transfig
+emph
\end_layout
\end_inset
- in order to create a PostScript file that can readily be included in your
- LaTeX file.
- In this case, the
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.fig
+noun
\end_layout
\end_inset
- file is the original file, and the PostScript file is the produced file.
-\end_layout
-
-\begin_layout Standard
-This distinction is important in order to allow updating of the material
- while you are in the process of writing the document.
- Furthermore, it provides us with the flexibility that is needed to support
- multiple export formats.
- For instance, in the case of a plain text file, it is not exactly an award-winn
-ing idea to include the figure as raw PostScript®.
- Instead, you'd either prefer to just include a reference to the figure
- or try to invoke some graphics to Ascii converter to make the final result
- look similar to the real graphics.
- The external material management allows you to do this, because it is parameter
-ized on the different export formats that LyX supports.
-\end_layout
-
-\begin_layout Standard
-Besides supporting the production of different products according to the
- exported format, it supports tight integration with editing and viewing
- applications.
- In the case of an XFig figure, you are able to invoke Xfig on the original
- file with a single click from within the external material dialog in LyX,
- and also preview the produced PostScript file with ghostview with another
- click.
- No more fiddling around with the command line and/or file browsers to locate
- and manipulate the original or produced files.
- In this way, you are finally able to take full advantage of the many different
- applications that are relevant to use when you write your documents, and
- ultimately be more productive.
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Section
-The external template configuration file
+\begin_layout Plain Layout
+underbar
\end_layout
-\begin_layout Standard
-It is relatively easy to add custom external template definitions to LyX.
- However, be aware that doing this in an careless manner most probably
-\emph on
-will
-\emph default
- introduce an easily exploitable security hole.
- So before you do this, please read the discussion about security in section
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:Security-discussion"
-
\end_inset
-.
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-Having said that, we encourage you to submit any interesting templates that
- you create.
-
+\begin_layout Plain Layout
+no_emph
\end_layout
-\begin_layout Standard
-The external templates are defined in the
+\end_inset
+
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LyXDir/lib/external_templates
+no_noun
\end_layout
\end_inset
- file.
- You can place your own version in
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir/external_templates
+no_bar
\end_layout
\end_inset
.
+ Each of these turns on or off the corresponding attribute.
\end_layout
-\begin_layout Standard
-A typical template looks like this:
-\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Template XFig
+\begin_layout Plain Layout
+Series
\end_layout
-\begin_layout LyX-Code
-GuiName "XFig: $$AbsOrRelPathParent$$Basename"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-HelpText
-\end_layout
+ [
+\emph on
-\begin_layout LyX-Code
-An XFig figure.
-\end_layout
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-HelpTextEnd
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-InputFormat fig
+\emph on
+Medium
\end_layout
-\begin_layout LyX-Code
-FileFilter "*.fig"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-AutomaticProduction true
-\end_layout
-\begin_layout LyX-Code
-Transform Rotate
-\end_layout
+\emph default
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Transform Resize
+\begin_layout Plain Layout
+Bold
\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 CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
+\begin_layout Plain Layout
+Shape
\end_layout
-\begin_layout LyX-Code
-
-\backslash
+\end_inset
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pstex_t}
-\end_layout
+ [
+\emph on
-\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_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-ReferencedFile dvi "$$AbsPath$$Basename.eps"
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-FormatEnd
+\emph on
+Up
\end_layout
-\begin_layout LyX-Code
-Format PDFLaTeX
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-TransformCommand Rotate RotationLatexCommand
-\end_layout
-\begin_layout LyX-Code
-TransformCommand Resize ResizeLatexCommand
-\end_layout
+\emph default
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Product "$$RotateFront$$ResizeFront
+\begin_layout Plain Layout
+Italic
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-
-\backslash
-input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- $$ResizeBack$$RotateBack"
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-UpdateFormat pdftex
+\begin_layout Plain Layout
+SmallCaps
\end_layout
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.pdftex_t"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Requirement "graphicx"
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+\begin_layout Plain Layout
+Slanted
\end_layout
-\begin_layout LyX-Code
-ReferencedFile latex "$$AbsPath$$Basename.pdf"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-FormatEnd
+]
\end_layout
-\begin_layout LyX-Code
-Format Ascii
-\end_layout
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-Product "$$Contents(
-\backslash
-"$$AbsPath$$Basename.asc
-\backslash
-")"
+\begin_layout Plain Layout
+Size
\end_layout
-\begin_layout LyX-Code
-UpdateFormat asciixfig
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.asc"
-\end_layout
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-FormatEnd
+\begin_layout Plain Layout
+tiny
\end_layout
-\begin_layout LyX-Code
-Format DocBook
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Product "<graphic fileref=
-\backslash
-"$$AbsOrRelPathMaster$$Basename.eps
-\backslash
-">
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
- </graphic>"
+\begin_layout Plain Layout
+small
\end_layout
-\begin_layout LyX-Code
-UpdateFormat eps
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-UpdateResult "$$AbsPath$$Basename.eps"
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-ReferencedFile docbook "$$AbsPath$$Basename.eps"
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\emph on
+normal
\end_layout
-\begin_layout LyX-Code
-FormatEnd
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-Product "[XFig: $$FName]"
-\end_layout
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-FormatEnd
+\begin_layout Plain Layout
+large
\end_layout
-\begin_layout LyX-Code
-TemplateEnd
-\end_layout
+\end_inset
-\begin_layout Standard
-As you can see, the template is enclosed in
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Template
+larger
\end_layout
\end_inset
- \SpecialChar \ldots{}
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TemplateEnd
+largest
\end_layout
\end_inset
-.
- It contains a header specifying some general settings and, for each supported
- primary document file format, a section
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Format
+huge
\end_layout
\end_inset
- \SpecialChar \ldots{}
-
+,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FormatEnd
+giant
\end_layout
\end_inset
-.
+]
\end_layout
\begin_layout Subsection
-The template header
+Upgrading old layout files
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The file format of layout files changes from time to time, so old layout
+ files need to be converted.
+ This process has been automated since LyX 1.4.0: If LyX reads an old format
+ layout file it will call the conversion tool
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-AutomaticProduction
-\begin_inset space ~
-\end_inset
-
-true|false
+LyXDir/scripts/layout2layout.py
\end_layout
\end_inset
- Whether the file represented by the template must be generated by LyX.
- This command must occur exactly once.
+ and convert it to a temporary file in current format.
+ The original file is left untouched.
+ If you want to convert the layout file permanently, just call the converter
+ by hand:
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-FileFilter
-\begin_inset space ~
-\end_inset
-
-<pattern>
+\begin_layout LyX-Code
+python $LyXDir/scripts/layout2layout.py myclass.layout myclassnew.layout
\end_layout
-\end_inset
-
- A glob pattern that is used in the file dialog to filter out the desired
- files.
- If there is more than one possible file extension (e.g.
-\begin_inset space ~
-\end_inset
-
-tgif has
+\begin_layout Standard
+(You need to replace
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.obj
+$LyXDir
\end_layout
\end_inset
- and
+ with the name of your LyX system directory, unless you happen to have defined
+ such an environment variable.) Then copy
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.tgo
+myclassnew.layout
\end_layout
\end_inset
-), use something like
+ to
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-"*.{obj,tgo}"
+UserDir/layouts/
\end_layout
\end_inset
.
- This command must occur exactly once.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+The automatic conversion only handles syntax changes.
+ It cannot handle the case where the contents of included files was changed,
+ so these will have to be converted separately.
+\end_layout
-\begin_layout Plain Layout
-GuiName
-\begin_inset space ~
-\end_inset
-
-<guiname>
-\end_layout
+\begin_layout Section
+Creating Templates
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Creating-Templates"
\end_inset
- The text that is displayed on the button.
- This command must occur exactly once.
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Templates are created just like usual documents.
+ The only difference is that usual documents contain all possible settings,
+ including the font scheme and the paper size.
+ Usually a user doesn't want a template to overwrite his defaults in these
+ cases.
+ For that reason, the designer of a template should remove the corresponding
+ commands like
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-HelpText
-\begin_inset space ~
-\end_inset
-<text>
-\begin_inset space ~
-\end_inset
-
-HelpTextEnd
+\backslash
+fontscheme
\end_layout
\end_inset
- The help text that is used in the External dialog.
- Provide enough information to explain to the user just what the template
- can provide him with.
- This command must occur exactly once.
-\end_layout
-
-\begin_layout Description
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-InputFormat
-\begin_inset space ~
-\end_inset
-<format>
+\backslash
+papersize
\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 CommandInset ref
-LatexCommand ref
-reference "sub:Formats"
+ from the template LyX file.
+ This can be done with any simple text-editor, for example
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_inset
+\begin_layout Plain Layout
+vi
+\end_layout
-).
- Use
-\begin_inset Quotes eld
\end_inset
-
+ or
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-*
+xedit
\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.
+.
+
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Put the edited template files you create in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Template
-\begin_inset space ~
-\end_inset
-
-<id>
+UserDir/templates/
\end_layout
\end_inset
- A unique name for the template.
- It must not contain substitution macros (see below).
-\end_layout
-
-\begin_layout Description
+, copy the ones you use from the global template directory in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Transform
-\begin_inset space ~
-\end_inset
-
-Rotate|Resize|Clip|Extra
+LyXDir/templates/
\end_layout
\end_inset
- This command specifies which transformations are supported by this template.
- It may occur zero or more times.
- This command enables the corresponding tabs in the external dialog.
- Each
-\begin_inset Flex CharStyle:Code
+ to the same place, and redefine the template path in the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Transform
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
\end_inset
- command must have either a corresponding
+ dialog.
+\end_layout
+
+\begin_layout Standard
+Note that there is a template which has a particular meaning:
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TransformCommand
+defaults.lyx
\end_layout
\end_inset
- or a
-\begin_inset Flex CharStyle:Code
+.
+ This template is loaded every time you create a new document with
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-TransformOption
+File\SpecialChar \menuseparator
+New
\end_layout
\end_inset
- command in the
-\begin_inset Flex CharStyle:Code
+ in order to provide useful defaults.
+ To create this template from inside LyX, all you have to do is to open
+ a document with the correct settings, and use the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Format
+Save as Document Defaults
\end_layout
\end_inset
- section.
- Otherwise the transformation will not be supported by that format.
+ button.
\end_layout
-\begin_layout Subsection
-The Format section
+\begin_layout Chapter
+Including External Material
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
\begin_layout Plain Layout
-Format
-\begin_inset space ~
-\end_inset
-
-LaTeX|PDFLaTeX|PlainText|DocBook
+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
- The primary document file format that this format definition is for.
- Not every template has a sensible representation in all document file formats.
- Please define nevertheless a
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-Format
\end_layout
-\end_inset
+\begin_layout Standard
+The use of material from sources external to LyX is covered in detail in
+ the
+\emph on
+Embedded Objects
+\emph default
+ manual.
+ This part of the manual covers what needs to happen behind the scenes for
+ new sorts of material to be included.
+\end_layout
- section for all formats.
- Use a dummy text when no representation is available.
- Then you can at least see a reference to the external material in the exported
- document.
+\begin_layout Section
+How does it work?
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+The external material feature is based on the concept of a
+\emph on
+template
+\emph default
+.
+ A template is a specification of how LyX should interface with a certain
+ kind of material.
+ As bundled, LyX comes with predefined templates for Xfig figures, various
+ raster format images, chess diagrams, and LilyPond music notation.
+ You can check the actual list by using the menu
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Option
-\begin_inset space ~
-\end_inset
-
-<name>
-\begin_inset space ~
-\end_inset
-
-<value>
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+External Material
\end_layout
\end_inset
- This command defines an additional macro
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-$$<name>
+.
+ 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
-\end_inset
-
- for substitution in
+\begin_layout Standard
+Another basic idea of the external material feature is to distinguish between
+ the original file that serves as a base for final material and the produced
+ file that is included in your exported or printed document.
+ For example, consider the case of a figure produced with
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Product
+Xfig
\end_layout
\end_inset
.
-
+ The Xfig application itself works on an original file with the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<value>
+.fig
\end_layout
\end_inset
- itself may contain substitution macros.
- The advantage over using
+ extension.
+ Within Xfig, you create and change your figure, and when you are done,
+ you save the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-<value>
+fig
\end_layout
\end_inset
- directly in
+-file.
+ When you want to include the figure in your document, you invoke
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Product
+transfig
\end_layout
\end_inset
- is that the substituted value of
+ in order to create a PostScript file that can readily be included in your
+ LaTeX file.
+ In this case, the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$<name>
+.fig
\end_layout
\end_inset
- is sanitized so that it is a valid optional argument in the document format.
- This command may occur zero or more times.
+ file is the original file, and the PostScript file is the produced file.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+This distinction is important in order to allow updating of the material
+ while you are in the process of writing the document.
+ Furthermore, it provides us with the flexibility that is needed to support
+ multiple export formats.
+ For instance, in the case of a plain text file, it is not exactly an award-winn
+ing idea to include the figure as raw PostScript.
+ Instead, you'd either prefer to just include a reference to the figure
+ or try to invoke some graphics to ASCII converter to make the final result
+ look similar to the real graphics.
+ The external material management allows you to do this, because it is parametri
+zed on the different export formats that LyX supports.
+\end_layout
-\begin_layout Plain Layout
-Product
-\begin_inset space ~
-\end_inset
+\begin_layout Standard
+Besides supporting the production of different products according to the
+ exported format, it supports tight integration with editing and viewing
+ applications.
+ In the case of an Xfig figure, you are able to invoke Xfig on the original
+ file with a single click from within the external material dialog in LyX,
+ and also preview the produced PostScript file with Ghostview with another
+ click.
+ No more fiddling around with the command line and/or file browsers to locate
+ and manipulate the original or produced files.
+ In this way, you are finally able to take full advantage of the many different
+ applications that are relevant to use when you write your documents, and
+ ultimately be more productive.
+\end_layout
-<text>
+\begin_layout Section
+The external template configuration file
\end_layout
+\begin_layout Standard
+It is relatively easy to add custom external template definitions to LyX.
+ However, be aware that doing this in an careless manner most probably
+\emph on
+will
+\emph default
+ introduce an easily exploitable security hole.
+ So before you do this, please read the discussion about security in section
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Security-discussion"
+
\end_inset
- 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_layout Standard
+Having said that, we encourage you to submit any interesting templates that
+ you create.
+
+\end_layout
+
+\begin_layout Standard
+The external templates are defined in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Preamble
-\begin_inset space ~
+LyXDir/lib/external_templates
+\end_layout
+
\end_inset
-<name>
+ file.
+ You can place your own version in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir/external_templates
\end_layout
\end_inset
- This command specifies a preamble snippet that will be included in the
- LaTeX preamble.
- It has to be defined using
+.
+\end_layout
+
+\begin_layout Standard
+A typical template looks like this:
+\end_layout
+
+\begin_layout LyX-Code
+Template XFig
+\end_layout
+
+\begin_layout LyX-Code
+GuiName "XFig: $$AbsOrRelPathParent$$Basename"
+\end_layout
+
+\begin_layout LyX-Code
+HelpText
+\end_layout
+
+\begin_layout LyX-Code
+An XFig figure.
+\end_layout
+
+\begin_layout LyX-Code
+HelpTextEnd
+\end_layout
+
+\begin_layout LyX-Code
+InputFormat fig
+\end_layout
+
+\begin_layout LyX-Code
+FileFilter "*.fig"
+\end_layout
+
+\begin_layout LyX-Code
+AutomaticProduction true
+\end_layout
+
+\begin_layout LyX-Code
+Transform Rotate
+\end_layout
+
+\begin_layout LyX-Code
+Transform Resize
+\end_layout
+
+\begin_layout LyX-Code
+Format LaTeX
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pstex_t}
+\end_layout
+
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat pstex
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pstex_t"
+\end_layout
+
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile dvi "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Format PDFLaTeX
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Rotate RotationLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+TransformCommand Resize ResizeLatexCommand
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$RotateFront$$ResizeFront
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+
+\backslash
+input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
+\end_layout
+
+\begin_layout LyX-Code
+ $$ResizeBack$$RotateBack"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat pdftex
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.pdftex_t"
+\end_layout
+
+\begin_layout LyX-Code
+Requirement "graphicx"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile latex "$$AbsPath$$Basename.pdf"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Format Ascii
+\end_layout
+
+\begin_layout LyX-Code
+Product "$$Contents(
+\backslash
+"$$AbsPath$$Basename.asc
+\backslash
+")"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat asciixfig
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.asc"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Format DocBook
+\end_layout
+
+\begin_layout LyX-Code
+Product "<graphic fileref=
+\backslash
+"$$AbsOrRelPathMaster$$Basename.eps
+\backslash
+">
+\end_layout
+
+\begin_layout LyX-Code
+ </graphic>"
+\end_layout
+
+\begin_layout LyX-Code
+UpdateFormat eps
+\end_layout
+
+\begin_layout LyX-Code
+UpdateResult "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile docbook "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+Product "[XFig: $$FName]"
+\end_layout
+
+\begin_layout LyX-Code
+FormatEnd
+\end_layout
+
+\begin_layout LyX-Code
+TemplateEnd
+\end_layout
+
+\begin_layout Standard
+As you can see, the template is enclosed in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-PreambleDef
+Template
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-PreambleDefEnd
+TemplateEnd
\end_layout
\end_inset
.
- This command may occur zero or more times.
+ It contains a header specifying some general settings and, for each supported
+ primary document file format, a section
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
\end_layout
-\begin_layout Description
+\end_inset
+
+ \SpecialChar \ldots{}
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ReferencedFile
-\begin_inset space ~
+FormatEnd
+\end_layout
+
\end_inset
-<format>
+.
+\end_layout
+
+\begin_layout Subsection
+The template header
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+AutomaticProduction
\begin_inset space ~
\end_inset
-<filename>
+true|false
\end_layout
\end_inset
- This command denotes files that are created by the conversion process and
- are needed for a particular export format.
- If the filename is relative, it is interpreted relative to the master document.
- This command may be given zero or more times.
+ Whether the file represented by the template must be generated by LyX.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-Requirement
+FileFilter
\begin_inset space ~
\end_inset
-<package>
+<pattern>
\end_layout
\end_inset
- The name of a required LaTeX package.
- The package is included via
+ 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
+
+tgif has
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+.obj
+\end_layout
-\backslash
-usepackage{}
+\end_inset
+
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.tgo
\end_layout
\end_inset
- in the LaTeX preamble.
- This command may occur zero or more times.
+), use something like
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+"*.{obj,tgo}"
+\end_layout
+
+\end_inset
+
+.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TransformCommand
+GuiName
\begin_inset space ~
\end_inset
-Rotate
+<guiname>
+\end_layout
+
+\end_inset
+
+ The text that is displayed on the button.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+HelpText
\begin_inset space ~
\end_inset
-RotationLatexCommand
+<text>
+\begin_inset space ~
+\end_inset
+
+HelpTextEnd
\end_layout
\end_inset
- This command specifies that the built in LaTeX command should be used for
- rotation.
- This command may occur once or not at all.
+ 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
-TransformCommand
+InputFormat
\begin_inset space ~
\end_inset
-Resize
-\begin_inset space ~
+<format>
+\end_layout
+
\end_inset
-ResizeLatexCommand
+ The file format of the original file.
+ This must be the name of a format that is known to LyX (see section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Formats"
+
+\end_inset
+
+).
+ Use
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+*
\end_layout
\end_inset
- This command specifies that the built in LaTeX command should be used for
- resizing.
- This command may occur once or not at all.
+
+\begin_inset Quotes erd
+\end_inset
+
+ if the template can handle original files of more than one format.
+ LyX will attempt to interrogate the file itself in order to deduce its
+ format in this case.
+ This command must occur exactly once.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
-
-Rotate
+Template
\begin_inset space ~
\end_inset
-RotationLatexOption
+<id>
\end_layout
\end_inset
- This command specifies that rotation is done via an optional argument.
- This command may occur once or not at all.
+ 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
-TransformOption
-\begin_inset space ~
-\end_inset
-
-Resize
+Transform
\begin_inset space ~
\end_inset
-ResizeLatexOption
+Rotate|Resize|Clip|Extra
\end_layout
\end_inset
- This command specifies that resizing is done via an optional argument.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
+ This command specifies which transformations are supported by this template.
+ It may occur zero or more times.
+ This command enables the corresponding tabs in the external dialog.
+ Each
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TransformOption
-\begin_inset space ~
-\end_inset
+Transform
+\end_layout
-Clip
-\begin_inset space ~
\end_inset
-ClipLatexOption
+ command must have either a corresponding
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TransformCommand
\end_layout
\end_inset
- This command specifies that clipping is done via an optional argument.
- This command may occur once or not at all.
-\end_layout
-
-\begin_layout Description
+ or a
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
TransformOption
-\begin_inset space ~
-\end_inset
+\end_layout
-Extra
-\begin_inset space ~
\end_inset
-ExtraLatexOption
+ command in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Format
\end_layout
\end_inset
- This command specifies that an extra optional argument is used.
- This command may occur once or not at all.
+ section.
+ Otherwise the transformation will not be supported by that format.
+\end_layout
+
+\begin_layout Subsection
+The Format section
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-UpdateFormat
+Format
\begin_inset space ~
\end_inset
-<format>
+LaTeX|PDFLaTeX|PlainText|DocBook
\end_layout
\end_inset
- The file format of the converted file.
- This must be the name of a format that is known to LyX (see the
-\begin_inset Flex CharStyle:MenuItem
+ The primary document file format that this format definition is for.
+ Not every template has a sensible representation in all document file formats.
+ Please define nevertheless a
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references:Conversion
+Format
\end_layout
\end_inset
- dialog).
- This command must occur exactly once.
+ section for all formats.
+ Use a dummy text when no representation is available.
+ Then you can at least see a reference to the external material in the exported
+ document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-UpdateResult
+Option
\begin_inset space ~
\end_inset
-<filename>
+<name>
+\begin_inset space ~
+\end_inset
+
+<value>
\end_layout
\end_inset
- The file name of the converted file.
- The file name must be absolute.
- This command must occur exactly once.
-\end_layout
+ This command defines an additional macro
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Subsection
-Preamble definitions
+\begin_layout Plain Layout
+$$<name>
\end_layout
-\begin_layout Standard
-The external template configuration file may contain additional preamble
- definitions enclosed by
+\end_inset
+
+ for substitution in
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-PreambleDef
+Product
\end_layout
\end_inset
- \SpecialChar \ldots{}
+.
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-PreambleDefEnd
+<value>
\end_layout
\end_inset
-.
- They can be used by the templates in the
+ itself may contain substitution macros.
+ The advantage over using
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Format
+<value>
\end_layout
\end_inset
- section.
-\end_layout
+ directly in
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Section
-The substitution mechanism
+\begin_layout Plain Layout
+Product
\end_layout
-\begin_layout Standard
-When the external material facility invokes an external program, it is done
- on the basis of a command defined in the template configuration file.
- These commands can contain various macros that are expanded before execution.
- Execution always take place in the directory of the containing document.
-\end_layout
+\end_inset
-\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.
+ is that the substituted value of
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$<name>
\end_layout
-\begin_layout Standard
-The available macros are the following:
+\end_inset
+
+ is sanitized so that it is a valid optional argument in the document format.
+ This command may occur zero or more times.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$AbsOrRelPathMaster
+Product
+\begin_inset space ~
+\end_inset
+
+<text>
\end_layout
\end_inset
- The file path, absolute or relative to the master LyX document.
+ 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
status collapsed
\begin_layout Plain Layout
-$$AbsOrRelPathParent
+Preamble
+\begin_inset space ~
+\end_inset
+
+<name>
\end_layout
\end_inset
- The file path, absolute or relative to the LyX document.
+ This command specifies a preamble snippet that will be included in the
+ LaTeX preamble.
+ It has to be defined using
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+PreambleDef
\end_layout
-\begin_layout Description
+\end_inset
+
+ \SpecialChar \ldots{}
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$AbsPath
+PreambleDefEnd
\end_layout
\end_inset
- The absolute file path.
+.
+ This command may occur zero or more times.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Basename
+ReferencedFile
+\begin_inset space ~
+\end_inset
+
+<format>
+\begin_inset space ~
+\end_inset
+
+<filename>
\end_layout
\end_inset
- The filename without path and without the extension.
+ This command denotes files that are created by the conversion process and
+ are needed for a particular export format.
+ If the filename is relative, it is interpreted relative to the master document.
+ This command may be given zero or more times.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Contents(
-\begin_inset Quotes eld
+Requirement
+\begin_inset space ~
\end_inset
-filename.ext
-\begin_inset Quotes erd
+<package>
+\end_layout
+
\end_inset
-)
+ The name of a required LaTeX package.
+ The package is included via
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+usepackage{}
\end_layout
\end_inset
- This macro will expand to the contents of the file with the name
+ in the LaTeX preamble.
+ This command may occur zero or more times.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-filename.ext
+TransformCommand
+\begin_inset space ~
+\end_inset
+
+Rotate
+\begin_inset space ~
+\end_inset
+
+RotationLatexCommand
\end_layout
\end_inset
-.
+ This command specifies that the built in LaTeX command should be used for
+ rotation.
+ This command may occur once or not at all.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Extension
+TransformCommand
+\begin_inset space ~
+\end_inset
+
+Resize
+\begin_inset space ~
+\end_inset
+
+ResizeLatexCommand
\end_layout
\end_inset
- The file extension (including the dot).
+ This command specifies that the built in LaTeX command should be used for
+ resizing.
+ This command may occur once or not at all.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$FName
+TransformOption
+\begin_inset space ~
+\end_inset
+
+Rotate
+\begin_inset space ~
+\end_inset
+
+RotationLatexOption
\end_layout
\end_inset
- The filename of the file specified in the external material dialog.
- This is either an absolute name, or it is relative to the LyX document.
+ 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
status collapsed
\begin_layout Plain Layout
-$$FPath
-\end_layout
-
+TransformOption
+\begin_inset space ~
\end_inset
- The path part of
-\begin_inset Flex CharStyle:Code
-status collapsed
+Resize
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-$$FName
+ResizeLatexOption
\end_layout
\end_inset
- (absolute name or relative to the LyX document).
+ 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
status collapsed
\begin_layout Plain Layout
-$$RelPathMaster
+TransformOption
+\begin_inset space ~
+\end_inset
+
+Clip
+\begin_inset space ~
+\end_inset
+
+ClipLatexOption
\end_layout
\end_inset
- The file path, relative to the master LyX document.
+ 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
status collapsed
\begin_layout Plain Layout
-$$RelPathParent
+TransformOption
+\begin_inset space ~
+\end_inset
+
+Extra
+\begin_inset space ~
+\end_inset
+
+ExtraLatexOption
\end_layout
\end_inset
- The file path, relative to the LyX document.
+ This command specifies that an extra optional argument is used.
+ This command may occur once or not at all.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Sysdir
-\end_layout
-
+UpdateFormat
+\begin_inset space ~
\end_inset
- This macro will expand to the absolute path of the system directory.
- This is typically used to point to the various helper scripts that are
- bundled with LyX.
+<format>
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ The file format of the converted file.
+ This must be the name of a format that is known to LyX (see the
+\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-$$Tempname
+
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references:Conversion
\end_layout
\end_inset
- A name and full path to a temporary file which will be automatically deleted
- whenever the containing document is closed, or the external material insertion
- deleted.
+ dialog).
+ This command must occur exactly once.
\end_layout
-\begin_layout Standard
-All path macros contain a trailing directory separator, so you can construct
- e.g.
- the absolute filename with
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$AbsPath$$Basename$$Extension
+UpdateResult
+\begin_inset space ~
+\end_inset
+
+<filename>
\end_layout
\end_inset
-.
+ The file name of the converted file.
+ The file name must be absolute.
+ This command must occur exactly once.
+\end_layout
+
+\begin_layout Subsection
+Preamble definitions
\end_layout
\begin_layout Standard
-The macros above are substituted in all commands unless otherwise noted.
- The command
+The external template configuration file may contain additional preamble
+ definitions enclosed by
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Product
+PreambleDef
\end_layout
\end_inset
- supports additionally the following substitutions if they are enabled by
- the
+ \SpecialChar \ldots{}
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Transform
+PreambleDefEnd
\end_layout
\end_inset
- and
+.
+ They can be used by the templates in the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TransformCommand
+Format
\end_layout
\end_inset
- commands:
+ section.
\end_layout
-\begin_layout Description
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Section
+The substitution mechanism
+\end_layout
-\begin_layout Plain Layout
-$$ResizeFront
+\begin_layout Standard
+When the external material facility invokes an external program, it is done
+ on the basis of a command defined in the template configuration file.
+ These commands can contain various macros that are expanded before execution.
+ Execution always take place in the directory of the containing document.
\end_layout
-\end_inset
+\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
- The front part of the resize command.
+\begin_layout Standard
+The available macros are the following:
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$ResizeBack
+$$AbsOrRelPathMaster
\end_layout
\end_inset
- The back part of the resize command.
+ The file path, absolute or relative to the master LyX document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$RotateFront
+$$AbsOrRelPathParent
\end_layout
\end_inset
- The front part of the rotation command.
+ The file path, absolute or relative to the LyX document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$RotateBack
+$$AbsPath
\end_layout
\end_inset
- The back part of the rotation command.
+ The absolute file path.
\end_layout
-\begin_layout Standard
-The value string of the
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Option
+$$Basename
\end_layout
\end_inset
- command supports additionally the following substitutions if they are enabled
- by the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Transform
+ The filename without path and without the extension.
\end_layout
-\end_inset
-
- and
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-TransformOption
-\end_layout
+$$Contents(
+\begin_inset Quotes eld
+\end_inset
+filename.ext
+\begin_inset Quotes erd
\end_inset
- commands:
+)
\end_layout
-\begin_layout Description
+\end_inset
+
+ This macro will expand to the contents of the file with the name
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$Clip
+filename.ext
\end_layout
\end_inset
- The clip option.
+.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Extra
+$$Extension
\end_layout
\end_inset
- The extra option.
+ The file extension (including the dot).
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Resize
+$$FName
\end_layout
\end_inset
- The resize option.
+ The filename of the file specified in the external material dialog.
+ This is either an absolute name, or it is relative to the LyX document.
\end_layout
\begin_layout Description
status collapsed
\begin_layout Plain Layout
-$$Rotate
-\end_layout
-
-\end_inset
-
- The rotation option.
-\end_layout
-
-\begin_layout Standard
-You may ask why there are so many path macros.
- There are mainly two reasons:
-\end_layout
-
-\begin_layout 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
-
-\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.
+$$FPath
\end_layout
-\begin_layout Standard
-So which path macro should be used in new template definitions? The rule
- is not difficult:
-\end_layout
+\end_inset
-\begin_layout Itemize
-Use
+ The path part of
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$AbsPath
+$$FName
\end_layout
\end_inset
- if an absolute path is required.
+ (absolute name or relative to the LyX document).
\end_layout
-\begin_layout Itemize
-Use
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$AbsOrRelPathMaster
+$$RelPathMaster
\end_layout
\end_inset
- if the substituted string is some kind of LaTeX input.
+ The file path, relative to the master LyX document.
\end_layout
-\begin_layout Itemize
-Else use
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-$$AbsOrRelPathParent
+$$RelPathParent
\end_layout
\end_inset
- in order to preserve the user's choice.
+ The file path, relative to the LyX document.
\end_layout
-\begin_layout Standard
-There are special cases where this rule does not work and e.g.
-\begin_inset space ~
-\end_inset
-
-relative names are needed, but normally it will work just fine.
- One example for such a case is the command
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
+$$Sysdir
\end_layout
\end_inset
- in the XFig template above: We can't use the absolute name because the
- copier for
+ This macro will expand to the absolute path of the system directory.
+ This is typically used to point to the various helper scripts that are
+ bundled with LyX.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.pstex_t
+$$Tempname
\end_layout
\end_inset
- files needs the relative name in order to rewrite the file content.
+ 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 Section
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:Security-discussion"
-
+\begin_layout Standard
+All path macros contain a trailing directory separator, so you can construct
+ e.
+\begin_inset space \thinspace{}
\end_inset
-Security discussion
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-\begin_inset Note Note
+the absolute filename with
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-This section is outdated
+$$AbsPath$$Basename$$Extension
\end_layout
\end_inset
-The external material feature interfaces with a lot of external programs
- and does so automatically, so we have to consider the security implications
- of this.
- In particular, since you have the option of including your own filenames
- and/or parameter strings and those are expanded into a command, it seems
- that it would be possible to create a malicious document which executes
- arbitrary commands when a user views or prints the document.
- This is something we definately want to avoid.
+.
\end_layout
\begin_layout Standard
-However, since the external program commands are specified in the template
- configuration file only, there are no security issues if LyX is properly
- configured with safe templates only.
- This is so because the external programs are invoked with the
+The macros above are substituted in all commands unless otherwise noted.
+ The command
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-execvp
+Product
\end_layout
\end_inset
--system call rather than the
+ supports additionally the following substitutions if they are enabled by
+ the
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-system
+Transform
\end_layout
\end_inset
- system-call, so it's not possible to execute arbitrary commands from the
- filename or parameter section via the shell.
-\end_layout
-
-\begin_layout Standard
-This also implies that you are restricted in what command strings you can
- use in the external material templates.
- In particular, pipes and redirection are not readily available.
- This has to be so if LyX should remain safe.
- If you want to use some of the shell features, you should write a safe
- script to do this in a controlled manner, and then invoke the script from
- the command string.
- In the
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-lib/scripts
+TransformCommand
\end_layout
\end_inset
- directory of the LyX installation, you can find a safe wrapper script
+ commands:
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-general_command_wrapper.py
+$$ResizeFront
\end_layout
\end_inset
- that supports redirection of input and output.
- That can serve as an example for how to write safe template scripts.
- For a more advanced example that uses
+ The front part of the resize command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-fork
+$$ResizeBack
\end_layout
\end_inset
- and friends, take a look at the
+ The back part of the resize command.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-pic2ascii.py
+$$RotateFront
\end_layout
\end_inset
- converter script.
+ The front part of the rotation command.
\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_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-execvp
+$$RotateBack
\end_layout
\end_inset
- system call in a controlled manner.
- Of course, for use in a controlled environment, it can be tempting to just
- fall back to use ordinary shell scripts.
- If you do so, be aware that you
-\emph on
-will
-\emph default
- provide an easily exploitable security hole in your system.
- Of course it stands to reason that such unsafe templates will never be
- included in the standard LyX distribution, although we do encourage people
- to submit new templates in the open source tradition.
- But LyX as shipped from the official distribution channels will never have
- unsafe templates.
-\end_layout
-
-\begin_layout Standard
-Including external material provides a lot of power, and you have to be
- careful not to introduce security hazards with this power.
- A subtle error in a single line in an innocent looking script can open
- the door to huge security problems.
- So if you do not fully understand the issues, we recommend that you consult
- a knowledgable security professional or the LyX development team if you
- have any questions about whether a given template is safe or not.
- And do this before you use it in an uncontrolled environment.
-\end_layout
-
-\begin_layout Chapter
-The LyX Server
-\end_layout
-
-\begin_layout Section
-Introduction
+ The back part of the rotation command.
\end_layout
\begin_layout Standard
-The LyX server is a method implemented in LyX that will enable other programs
- to talk to LyX, invoke LyX commands, and retrieve information about the
- LyX internal state.
- This is only intended for advanced users, but they should find it useful.
- Please note that, at present,
-\emph on
-the server does not work on Windows
-\emph default
-.
-\begin_inset Foot
+The value string of the
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-There is no principled reason it cannot do so.
- But none of the developers on Windows® have yet implemented this functionality
- there.
+Option
\end_layout
\end_inset
+ command supports additionally the following substitutions if they are enabled
+ by the
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Transform
\end_layout
-\begin_layout Section
-Starting the LyX Server
-\end_layout
+\end_inset
-\begin_layout Standard
-The LyX server works through the use of a pair of named pipes.
- These are usually located in
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-UserDir
+TransformOption
\end_layout
\end_inset
- and have the names
-\begin_inset Quotes eld
-\end_inset
-
+ commands:
+\end_layout
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.lyxpipe.in
+$$Clip
\end_layout
\end_inset
+ The clip option.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.lyxpipe.out
+$$Extra
\end_layout
\end_inset
+ The extra option.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-.
- External programs write into
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.lyxpipe.in
+$$Resize
\end_layout
\end_inset
- and read back data from
+ The resize option.
+\end_layout
+
+\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.lyxpipe.out
+$$Rotate
\end_layout
\end_inset
-.
- The stem of the pipe names can be defined in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ The rotation option.
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Standard
+You may ask why there are so many path macros.
+ There are mainly two reasons:
+\end_layout
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+\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
-\bar under
-P
-\bar default
-references
+\begin_layout Enumerate
+LaTeX treats relative file names differently than LyX and other programs
+ in nested included files.
+ For LyX, a relative file name is always relative to the document that contains
+ the file name.
+ For LaTeX, it is always relative to the master document.
+ These two definitions are identical if you have only one document, but
+ differ if you have a master document that includes part documents.
+ That means that relative filenames must be transformed when presented to
+ LaTeX.
+ Fortunately LyX does this automatically for you if you choose the right
+ macros.
+\end_layout
+
+\begin_layout Standard
+So which path macro should be used in new template definitions? The rule
+ is not difficult:
\end_layout
-\end_inset
-
- dialog, for example
+\begin_layout Itemize
+Use
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-"/home/myhome/.lyxpipe"
+$$AbsPath
\end_layout
\end_inset
-.
+ if an absolute path is required.
\end_layout
-\begin_layout Standard
-LyX will add the '
+\begin_layout Itemize
+Use
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.in
+$$AbsOrRelPathMaster
\end_layout
\end_inset
-' and '
+ if the substituted string is some kind of LaTeX input.
+\end_layout
+
+\begin_layout Itemize
+Else use
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-.out
+$$AbsOrRelPathParent
\end_layout
\end_inset
-' to create the pipes.
- The above setting also has the effect of activating the LyX server.
- If one of the pipes already exists, LyX will assume that another LyX process
- is already running and will not start the server.
- To have several LyX processes with servers at the same time, you have to
- change the configuration between the start of the programs.
-\end_layout
-
-\begin_layout Standard
-If you are developing a client program, you might find it useful to enable
- debugging information from the LyX server.
- Do this by starting LyX as lyx -dbg lyxserver.
-\end_layout
-
-\begin_layout Standard
-Warning: if LyX crashes, it may not manage to remove the pipes; in this
- case you must remove them manually.
- If LyX starts and the pipes exist already, it will not start any server.
+ in order to preserve the user's choice.
\end_layout
\begin_layout Standard
-Other than this, there are a few points to consider:
-\end_layout
-
-\begin_layout Itemize
-Both server and clients must run on UNIX or OS/2 machines.
- Communications between LyX on UNIX and clients on OS/2 or vice versa is
- not possible right now.
-\end_layout
+There are special cases where this rule does not work and e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Itemize
-On OS/2, only one client can connect to LyXServer at a time.
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Itemize
-On OS/2, clients must open inpipe with
+relative names are needed, but normally it will work just fine.
+ One example for such a case is the command
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-O_WRONLY
+ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-mode.
-\end_layout
-
-\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
+ in the XFig template above: We can't use the absolute name because the
+ copier for
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-development/lyxserver/server_monitor.c
+.pstex_t
\end_layout
\end_inset
-.
+ files needs the relative name in order to rewrite the file content.
\end_layout
\begin_layout Section
-Normal communication
-\end_layout
-
-\begin_layout Standard
-To issue a LyX call, the client writes a line of ASCII text into the input
- pipe.
- This line has the following format:
-\end_layout
-
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-argument
-\end_layout
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Security-discussion"
-\begin_layout Description
+\end_inset
-\emph on
-clientname
-\emph default
- is a name that the client can choose arbitrarily.
- Its only use is that LyX will echo it if it sends an answer---so a client
- can dispatch results from different requesters.
+Security discussion
\end_layout
-\begin_layout Description
+\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
-\emph on
-function
-\emph default
- is the function you want LyX to perform.
- It is the same as the commands you'd use in the minibuffer.
+\begin_layout Plain Layout
+WARNING: This section is definitely outdated.
\end_layout
-\begin_layout Description
-
-\emph on
-argument
-\emph default
- is an optional argument which is meaningful only to some functions (for
- instance
-\begin_inset Quotes eld
\end_inset
-self-insert
-\begin_inset Quotes erd
-\end_inset
- which will insert the argument as text at the cursor position.)
\end_layout
\begin_layout Standard
-The answer from LyX will arrive in the output pipe and be of the form
-\end_layout
-
-\begin_layout Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-data
+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 Standard
-where
-\emph on
-clientname
-\emph default
- and
-\emph on
-function
-\emph default
- are just echoed from the command request, while
-\emph on
-data
-\emph default
- is more or less useful information filled according to how the command
- execution worked out.
- Some commands will return information about the internal state of LyX,
- such as
-\begin_inset Quotes eld
-\end_inset
+However, since the external program commands are specified in the template
+ configuration file only, there are no security issues if LyX is properly
+ configured with safe templates only.
+ This is so because the external programs are invoked with the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+execvp
+\end_layout
-font-state
-\begin_inset Quotes erd
\end_inset
-, while other will return an empty data-response.
- This means that the command execution went fine.
-\end_layout
+-system call rather than the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-In case of errors, the response from LyX will have this form
+\begin_layout Plain Layout
+system
\end_layout
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-error message
-\end_layout
+\end_inset
-\begin_layout Standard
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
+ system-call, so it's not possible to execute arbitrary commands from the
+ filename or parameter section via the shell.
\end_layout
\begin_layout Standard
-Examples:
-\end_layout
+This also implies that you are restricted in what command strings you can
+ use in the external material templates.
+ In particular, pipes and redirection are not readily available.
+ This has to be so if LyX should remain safe.
+ If you want to use some of the shell features, you should write a safe
+ script to do this in a controlled manner, and then invoke the script from
+ the command string.
+ In the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout LyX-Code
-echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
+\begin_layout Plain Layout
+lib/scripts
\end_layout
-\begin_layout LyX-Code
-echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
-\begin_inset Newline newline
-\end_inset
-
-read a <~/.lyxpipe.out
-\begin_inset Newline newline
\end_inset
-echo $a
-\end_layout
+ directory of the LyX installation, you can find a safe wrapper script
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Section
-Notification
+\begin_layout Plain Layout
+general_command_wrapper.py
\end_layout
-\begin_layout Standard
-LyX can notify clients of events going on asynchronously.
- Currently it will only do this if the user binds a key sequence with the
- function
-\begin_inset Quotes eld
-\end_inset
-
-notify
-\begin_inset Quotes erd
\end_inset
-.
- The format of the string LyX sends is as follows:
-\end_layout
-
-\begin_layout Quote
+ that supports redirection of input and output.
+ That can serve as an example for how to write safe template scripts.
+ For a more advanced example that uses
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-NOTIFY:
+fork
\end_layout
\end_inset
+ and friends, take a look at the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\emph on
-key-sequence
-\end_layout
-
-\begin_layout Standard
-where
-\emph on
-key-sequence
-\emph default
- is the printed representation of the key sequence that was actually typed
- by the user.
+\begin_layout Plain Layout
+pic2ascii.py
\end_layout
-\begin_layout Standard
-This mechanism can be used to extend LyX's command set and implement macros:
- bind some key sequence to
-\begin_inset Quotes eld
-\end_inset
-
-notify
-\begin_inset Quotes erd
\end_inset
-, start a client that listens on the out pipe, dispatches the command according
- to the sequence and starts a function that may use LyX calls and LyX requests
- to issue a command or a series of commands to LyX.
-\end_layout
-
-\begin_layout Section
-The simple LyX Server Protocol
+ converter script.
\end_layout
\begin_layout Standard
-LyX implements a simple protocol that can be used for session management.
- All messages are of the form
+It is possible to design a template that interacts directly with the shell,
+ but since this would allow a malicious user to execute arbitrary commands
+ by writing clever filenames and/or parameters, we generally recommend that
+ you only use safe scripts that work with the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+execvp
\end_layout
-\begin_layout Quote
-LYXSRV:
+\end_inset
+
+ system call in a controlled manner.
+ Of course, for use in a controlled environment, it can be tempting to just
+ fall back to use ordinary shell scripts.
+ If you do so, be aware that you
\emph on
-clientname
+will
\emph default
-:
-\emph on
-protocol message
+ provide an easily exploitable security hole in your system.
+ Of course it stands to reason that such unsafe templates will never be
+ included in the standard LyX distribution, although we do encourage people
+ to submit new templates in the open source tradition.
+ But LyX as shipped from the official distribution channels will never have
+ unsafe templates.
\end_layout
\begin_layout Standard
-where
-\emph on
-protocol message
-\emph default
- can be
-\begin_inset Quotes eld
-\end_inset
-
-hello
-\begin_inset Quotes erd
-\end_inset
-
- or
-\begin_inset Quotes eld
-\end_inset
-
-bye
-\begin_inset Quotes erd
-\end_inset
-
-.
- If
-\begin_inset Quotes eld
-\end_inset
-
-hello
-\begin_inset Quotes erd
-\end_inset
-
- is received from a client, LyX will report back to inform the client that
- it's listening to it's messages, while
-\begin_inset Quotes eld
-\end_inset
-
-bye
-\begin_inset Quotes erd
-\end_inset
-
- sent from LyX will inform clients that LyX is closing.
+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.
\end_layout
\end_body
projects / lyx.git / blobdiff