#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 348
+\lyxformat 361
\begin_document
\begin_header
\textclass scrbook
\begin_preamble
% DO NOT ALTER THIS PREAMBLE!!!
%
-% This preamble is designed to ensure that the User's Guide prints
+% This preamble is designed to ensure that this document prints
% out as advertised. If you mess with this preamble,
-% parts of the User's Guide may not print out as expected. If you
+% parts of this document may not print out as expected. If you
% have problems LaTeXing this file, please contact
% the documentation team
% email: lyx-docs@lists.lyx.org
\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
+\bibtex_command default
+\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
\use_esint 0
\cite_engine basic
\use_bibtopic false
+\use_indices false
\paperorientation portrait
\branch OutDated
\selected 0
\paperpagestyle headings
\tracking_changes true
\output_changes false
-\author "rgheck"
-\author "ab"
-\author "Georg Baum,,,"
+\author "Jean-Marc Lasgouttes"
\author ""
\end_header
\end_inset
in the subject header, and please cc the current maintainer of this file,
- Richard Heck <rgheck@comcast.net>.
+ Richard Heck <
+rgheck
+@
+comcast
+.net>.
\end_layout
\end_inset
This manual covers the customization features present in LyX.
In it, we discuss issues like keyboard shortcuts, screen previewing options,
printer options, sending commands to LyX via the LyX Server, internationalizati
-on, installing new LaTeX classes and LyX layouts, etc.
+on, installing new
+LaTeX
+ classes and LyX layouts, etc.
We can't possibly hope to touch on everything you can change—our developers
add new features faster than we can document them—but we will explain the
most common customizations and hopefully point you in the right direction
\begin_layout Standard
Information from previous versions of this document that now seems to be
- outdated is contained in the OutDated branch of this document.
- By default, this information will not appear in the LaTeX output.
+ outdated is contained in the
+OutDated
+ branch of this document.
+ By default, this information will not appear in the
+LaTeX
+ output.
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-packages.lst
+packages.
+lst
\end_layout
\end_inset
\begin_layout Plain Layout
Help\SpecialChar \menuseparator
+
LaTeX
+
\begin_inset space ~
\end_inset
status collapsed
\begin_layout Plain Layout
-textclass.lst
+
+textclass
+.
+lst
\end_layout
\end_inset
\end_inset
- directories, along with the associated LaTeX document class and their descripti
-on.
+ directories, along with the associated
+LaTeX
+ document class and their description.
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-lyxmodules.lst
+
+lyxmodules
+.
+lst
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-*files.lst
+*files.
+lst
\end_layout
\end_inset
- lists of various sorts of LaTeX-related files found on your system
+ lists of various sorts of
+LaTeX
+-related files found on your system
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
-doc/LaTeXConfig.lyx
+doc/
+LaTeXConfig
+.lyx
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LaTeXConfig.lyx.in
+
+LaTeXConfig
+.lyx.in
\end_layout
\end_inset
.
- It contains information on your LaTeX configuration.
+ It contains information on your
+LaTeX
+ configuration.
\end_layout
\begin_layout Subsection
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
\end_inset
- that define the keybindings used in LyX.
+ that define the
+keybindings
+ used in LyX.
If there exists an internationalized version of the bind file named
\begin_inset Flex CharStyle:Code
status collapsed
status collapsed
\begin_layout Plain Layout
-clipart/
+
+clipart
+/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LaTeXConfig.lyx
+
+LaTeXConfig
+.lyx
\end_layout
\end_inset
deserves special attention, as noted above.
- The internationalized help docs are in subdirectories
+ The internationalized help docs are in
+subdirectories
+
\begin_inset Flex CharStyle:Code
status collapsed
\begin_inset CommandInset ref
LatexCommand ref
-reference "chap:i18n"
+reference "cha:Internationalizing-LyX"
\end_inset
status collapsed
\begin_layout Plain Layout
-kbd/
+
+kbd
+/
\end_layout
\end_inset
- contains keyboard keymapping files.
+ contains keyboard
+keymapping
+ files.
See Chapter
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:keymap"
+reference "sec:International-Keymap-Stuff"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "chap:textclass"
+reference "cha:Installing-New-Document"
\end_inset
status collapsed
\begin_layout Plain Layout
+
lyx2lyx
\end_layout
status collapsed
\begin_layout Plain Layout
+
lyx2lyx
\end_layout
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:templates"
+reference "sec:Creating-Templates"
\end_inset
status collapsed
\begin_layout Plain Layout
-ui/
+
+ui
+/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-.ui
+.
+ui
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-chkconfig.ltx
+
+chkconfig
+.
+ltx
\end_layout
\end_inset
- this is a LaTeX script used during the configuration process.
+ this is a
+LaTeX
+ script used during the configuration process.
Do not run directly.
\end_layout
status collapsed
\begin_layout Plain Layout
-configure.py
+configure.
+py
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
encodings
\end_layout
\end_inset
- this contains tables describing how different character encodings can be
- mapped to Unicode
+ this contains tables describing how different character
+encodings
+ can be mapped to Unicode
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
LyXDir
\end_layout
status collapsed
\begin_layout Plain Layout
+
UserDir
\end_layout
status collapsed
\begin_layout Plain Layout
-configure.py
+configure.
+py
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-UserDir/layouts
+
+UserDir
+/layouts
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-UserDir/doc/
+
+UserDir
+/doc/
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
--userdir
+-
+userdir
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
--userdir
+-
+userdir
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-LYX_USERDIR_VER
+LYX_
+USERDIR
+_
+VER
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-NewUserDir/layouts
+
+NewUserDir
+/layouts
\end_layout
\end_inset
which you want available from all your configurations, you must add it
to each directory separately.
You can avoid this with the following trick: after LyX creates the additional
- directory, most of the subdirectories (see above) are empty.
+ directory, most of the
+subdirectories
+ (see above) are empty.
If you want the new configuration to mirror an existing one, replace the
- empty subdirectory with a symbolic link to the matching subdirectory in
- the existing configuration.
+ empty
+subdirectory
+ with a symbolic link to the matching
+subdirectory
+ in the existing configuration.
Take care with the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- subdirectory, however, since it contains a file written by the configuration
- script (also accessible through
+
+subdirectory
+, however, since it contains a file written by the configuration script
+ (also accessible through
\begin_inset Flex CharStyle:MenuItem
status collapsed
\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
-
-\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
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences
-\end_layout
-
-\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.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-screen fonts) will have an instant effect.
- Others (e.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-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
+Formats
\begin_inset CommandInset label
LatexCommand label
-name "sub:Formats"
+name "sec:Formats"
\end_inset
-Formats
+
\end_layout
\begin_layout Standard
\end_inset
- field contains the named used to identify the format in the GUI.
+ field contains the name used to identify the format in the GUI.
The
\begin_inset Flex CharStyle:MenuItem
status collapsed
\end_inset
- and
+ and an
\begin_inset Flex CharStyle:MenuItem
status collapsed
status collapsed
\begin_layout Plain Layout
+
Ghostview
\end_layout
\end_inset
menu.
- The editor is for example launched when you press the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Edit
-\end_layout
-
-\end_inset
-
- button in the
+ The editor is for example launched when you right-click on an image and
+ choose
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-Graphics
+Edit externally
\end_layout
\end_inset
- or the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-External material
-\end_layout
-
-\end_inset
-
- dialog.
+ in the appearing context menu.
\end_layout
\begin_layout Standard
\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 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
status collapsed
\begin_layout Plain Layout
+
png
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdflatex
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
+
png
\end_layout
status collapsed
\begin_layout Plain Layout
+
jpg
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdflatex
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
+
png
\end_layout
status collapsed
\begin_layout Plain Layout
+
jpg
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
+
png
\end_layout
.
\end_layout
-\begin_layout Subsection
+\begin_layout Section
Copiers
\end_layout
\end_inset
- The `LaTeX name'
+ The `
+LaTeX
+
+name'
\end_layout
\begin_layout Standard
-The latter should be the filename as it would be used in a LaTeX's
+The latter should be the
+filename
+ as it would be used in a
+LaTeX's
+
\series bold
\backslash
\begin_layout Standard
Copiers can be used to do almost anything with output files.
- For example, suppose you want generated pdf files to be copied to a special
- directory,
+ For example, suppose you want generated
+pdf
+ files to be copied to a special directory,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-/home/you/pdf/
+/home/you/
+pdf
+/
\end_layout
\end_inset
\end_inset
-Save that in your local LyX directory—say,
+Save it in your local LyX directory—say,
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-/home/you/.lyx/scripts/pdfcopier.sh
+/home/you/.lyx/scripts/
+pdfcopier
+.sh
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-PDF(pdflatex)
+
+PDF
+(
+pdflatex
+)
\end_layout
\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
\begin_layout Plain Layout
-pdfcopier.sh $$i $$o
+
+pdfcopier
+.sh $$i $$o
\end_layout
\end_inset
When these formats are exported, the copier sees that not just the main
HTML file but various associated files (style files, images, etc.) are also
copied.
- All these files are written to a subdirectory of the directory in which
- the original LyX file was found.
+ All these files are written to a
+subdirectory
+ of the directory in which the original LyX file was found.
\begin_inset Foot
status collapsed
status collapsed
\begin_layout Plain Layout
+
LyXconv
\end_layout
status collapsed
\begin_layout Plain Layout
-/path/to/filename.lyx
+/path/to/
+filename
+.lyx
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-/path/to/filename.html.LyXconv
+/path/to/
+filename
+.
+html
+.
+LyXconv
\end_layout
\end_inset
\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
\end_inset
- The base filename of the input file (i.
+ The base
+filename
+ of the input file (i.
\begin_inset space \thinspace{}
\end_inset
\end_inset
- The path to the original input file (this is different from $$p when chain
- of converters is called).
+ The path to the original input file (this is different from $$p when a
+ chain of converters is called).
\end_layout
\begin_layout Standard
\end_inset
- This converter runs some form of LaTeX.
- This will make LyX's LaTeX error logs available.
+ This converter runs some form of
+LaTeX
+.
+ This will make LyX's
+LaTeX
+ error logs available.
\end_layout
\begin_layout Labeling
status collapsed
\begin_layout Plain Layout
+
needaux
\end_layout
\end_inset
- Needs the LaTeX
+ Needs the
+LaTeX
+
\begin_inset Flex CharStyle:MenuItem
status collapsed
status collapsed
\begin_layout Plain Layout
+
xml
\end_layout
status collapsed
\begin_layout Plain Layout
+
parselog
\end_layout
status collapsed
\begin_layout Plain Layout
-infile.out
+
+infile
+.out
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-script <infile.out >infile.log
+script <
+infile
+.out >
+infile
+.log
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
resultdir
\end_layout
\begin_inset Newline newline
\end_inset
-Note that resultdir and usetempdir make no sense together.
+Note that
+resultdir
+ and
+usetempdir
+ make no sense together.
The latter will be ignored if the former is given.
\end_layout
status collapsed
\begin_layout Plain Layout
+
resultfile
\end_layout
\end_inset
.
- Sensible only with resultdir and optional even then; if not given, it defaults
- to `index'.
+ Sensible only with
+resultdir
+ and optional even then; if not given, it defaults to `
+index'
+.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-You do not have to define converters between all the formats between which
- you want to convert.
- For example, you will note that there is no `LyX to PostScript' converter,
- but LyX will export PostScript.
- It does so by first creating a LaTeX file (no converter needs to be defined
- for this) which is then converted to DVI using the `LaTeX to DVI' converter,
- and finally converting the resulting DVI file to PostScript.
- LyX finds such `chains' of converters automatically, and it will always
- choose the shortest possible chain.
+You do not have to define converters for all formats between which you want
+ to convert.
+ For example, you will note that there is no `LyX to
+PostScript'
+ converter, but LyX will export PostScript.
+ It does so by first creating a
+LaTeX
+ file (no converter needs to be defined for this) which is then converted
+ to DVI using the `
+LaTeX
+ to
+DVI'
+ converter, and finally converting the resulting DVI file to PostScript.
+ LyX finds such `
+chains'
+ of converters automatically, and it will always choose the shortest possible
+ chain.
You can, though, still define multiple conversion methods between file
formats.
For example, the standard LyX configuration provides three ways to convert
- LaTeX to PDF: Directly, using
+
+LaTeX
+ to
+PDF
+: Directly, using
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
+
pdflatex
\end_layout
status collapsed
\begin_layout Plain Layout
+
ps2pdf
\end_layout
status collapsed
\begin_layout Plain Layout
+
dvipdfm
\end_layout
.
To define such alternate chains, you must define multiple target `file
- formats', as described in section
+
+formats'
+, as described in section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Formats"
+reference "sec:Formats"
\end_inset
status collapsed
\begin_layout Plain Layout
+
pdf
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdf2
\end_layout
status collapsed
\begin_layout Plain Layout
+
pdf3
\end_layout
status collapsed
\begin_layout Plain Layout
-.pdf
+.
+pdf
\end_layout
\end_inset
Internationalizing LyX
\begin_inset CommandInset label
LatexCommand label
-name "chap:i18n"
+name "cha:Internationalizing-LyX"
\end_inset
status collapsed
\begin_layout Plain Layout
+
gettext
\end_layout
status collapsed
\begin_layout Plain Layout
+
po
\end_layout
status collapsed
\begin_layout Plain Layout
+
gettext
\end_layout
It is possible to do this just for yourself, but if you're going to do
it, you might as well share the results of your labors with the rest of
the LyX community.
- Send a message to the LyX developers' list for more information about how
- to proceed.
+ Send a message to the LyX
+developers'
+ list for more information about how to proceed.
\end_layout
\begin_layout Standard
status collapsed
\begin_layout Plain Layout
-**.po
+**.
+po
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-xx.po
+xx.
+po
\end_layout
\end_inset
\end_inset
- in that directory, or you can use an existing po-file for some other language
- as a template).
+ in that directory, or you can use an existing
+po
+-file for some other language as a template).
\end_layout
\begin_layout Itemize
status collapsed
\begin_layout Plain Layout
-xx.po
+xx.
+po
\end_layout
\end_inset
\family typewriter
KBabel
\family default
- (for KDE).
+ (for
+KDE
+).
\family typewriter
Emacs
\family default
- contains a `mode' for editing
+ contains a `
+mode'
+ for editing
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
+
po
\end_layout
status collapsed
\begin_layout Plain Layout
+
po
\end_layout
status collapsed
\begin_layout Plain Layout
-msgfmt -o xx.mo < xx.po
+
+msgfmt
+ -o xx.mo < xx.
+po
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
po
\end_layout
-file could be added to the LyX distribution, so others can use it.
Adding it involves making additional changes to LyX.
- So send an email to the developers' mailing list if you're interested in
- doing that.
+ So send an email to the
+developers'
+ mailing list if you're interested in doing that.
\end_layout
\begin_layout Subsubsection
status collapsed
\begin_layout Plain Layout
+
gettext
\end_layout
status collapsed
\begin_layout Plain Layout
-To[[as in 'From format x to format y']]
+To[[as in
+'From
+ format x to format
+y'
+]]
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-To[[as in 'From page x to page y']].
+To[[as in
+'From
+ page x to page
+y'
+]].
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
+
gettext
\end_layout
\end_layout
\begin_layout Section
+International Keymap Stuff
\begin_inset CommandInset label
LatexCommand label
-name "sec:keymap"
+name "sec:International-Keymap-Stuff"
\end_inset
-International Keymap Stuff
+
\end_layout
\begin_layout Standard
\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
\end_layout
\begin_layout Subsection
+Layout modules
\begin_inset CommandInset label
LatexCommand label
name "sub:Layout-modules"
\end_inset
-Layout modules
+
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-
-\change_inserted 0 1235082501
The mandatory argument, in curly brackets, is the name of the module, as
it should appear in
\begin_inset Flex CharStyle:MenuItem
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 0 1235082501
Document\SpecialChar \menuseparator
Settings
\end_layout
.
-\change_unchanged
+\change_inserted 0 1243500588
+
+\end_layout
+
+\begin_layout Standard
The argument in square brackets is optional: It declares any LaTeX packages
on which the module depends.
-
-\change_deleted 0 1235082500
-The mandatory argument, in curly brackets, is the name of the module, as
- it should appear in
-\begin_inset Flex CharStyle:MenuItem
+ 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
-Document\SpecialChar \menuseparator
-Settings
+The list of such packages is documented only in the source code.
\end_layout
\end_inset
-.
-
-\change_inserted 0 1235082535
-Please note that only packages about which LyX knows should be listed in
- the square brackets.
-\begin_inset Foot
-status open
+ LyX will not check for arbitrary packages.
+
+\change_inserted 0 1243500694
+ It is also possible to use the form
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
\begin_layout Plain Layout
-\change_inserted 0 1235082591
-The list of such packages is documented only in the source code.
-\change_unchanged
-
+\change_inserted 0 1243500706
+from->to
\end_layout
\end_inset
- LyX will not check for arbitrary packages.
+, which declares that the module can only be used when there exists a conversion
+ chain between formats `from' and `to'.
\change_unchanged
\end_layout
] 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 1
-\change_deleted 2 1234611237
-2
-\change_inserted 2 1234611237
-4
-\change_unchanged
-.
-\change_deleted 1 1234946903
-
+ 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
\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 CommandInset ref
LatexCommand ref
-reference "sec:floats"
+reference "sub:Floats"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:charstyle"
+reference "sub:Flex-insets-and"
\end_inset
A string indicating what sort of output documents using this class will
produce.
At present, the options are: `docbook', `latex', and `literate'.
+\change_inserted 0 1243500198
+
+\end_layout
+
+\begin_layout Description
+
+\change_inserted 0 1243500505
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 0 1243500208
+OutputFormat
+\end_layout
+
+\end_inset
+
+ A string indicating the file format (as defined in the Preferences dialog)
+ produced by this class.
+ It is mainly useful when
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 0 1243500394
+OutputType
+\end_layout
+
+\end_inset
+
+ is `literate' and one wants to define a new type of literate document.
+ This string is reset to `docbook', `latex', or `literate' when the correspondin
+g
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 0 1243500473
+OutputType
+\end_layout
+
+\end_inset
+
+ parameter is encountered.
+\change_unchanged
+
\end_layout
\begin_layout Description
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:style"
+reference "sub:Paragraph-Styles"
\end_inset
\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
\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
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:fonts"
+reference "sub:Font-description"
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234613251
-Babel
-\change_deleted 2 1234611266
-I18N
-\change_unchanged
-Preamble
+BabelPreamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234613436
-Babel
-\change_deleted 2 1234611275
-I18N
-\change_unchanged
-Preamble
+BabelPreamble
\end_layout
\end_inset
status collapsed
\begin_layout Plain Layout
-End
-\change_deleted 2 1234611280
-I18N
-\change_inserted 2 1234613262
-Babel
-\change_unchanged
-Preamble
+EndBabelPreamble
\end_layout
\end_inset
replaces its argument by the translation of the argument to the current
language.
-\change_inserted 2 1234611470
-
\end_layout
\begin_layout Standard
-
-\change_inserted 2 1234615134
This preamble snippet will only be used if the document contains more than
one language and the babel package is used.
-\change_unchanged
-
\end_layout
\end_deeper
\begin_layout Description
-
-\change_inserted 2 1234614203
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234614202
LangPreamble
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234614202
BabelPreamble
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234614202
EndLangPreamble
\end_layout
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234611302
-Lang
-\change_deleted 2 1234611306
-I18N
-\change_unchanged
-Preamble
+LangPreamble
\end_layout
\end_inset
-
-\change_inserted 2 1234611823
- and
-\change_unchanged
-
-\change_inserted 2 1234611832
-
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234611838
BabelPreamble
\end_layout
\end_inset
-
-\change_unchanged
-to support non-english and even multilanguage documents correctly.
+ to support non-english and even multilanguage documents correctly.
The following excerpt (from the
\begin_inset Flex CharStyle:Code
status collapsed
Preamble
\end_layout
-\begin_layout LyX-Code
-
-\change_deleted 2 1234612061
-
-\backslash
-providecommand{
-\backslash
-claimname}{Claim}
-\end_layout
-
\begin_layout LyX-Code
\backslash
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 2 1234612037
LangPreamble
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 2 1234612045
\backslash
providecommand{
\begin_layout LyX-Code
-\change_inserted 2 1234611897
-
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 2 1234612050
EndLangPreamble
\end_layout
\begin_layout LyX-Code
-
-\change_inserted 2 1234611892
-Babel
-\change_deleted 2 1234611847
-I18n
-\change_unchanged
-Preamble
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_deleted 2 1234612079
-
-\backslash
-AtBeginDocument{
-\backslash
-ifx
-\backslash
-LdfInit
-\backslash
-undefined
-\backslash
-relax
-\backslash
-else%
+BabelPreamble
\end_layout
\begin_layout LyX-Code
-
+
\backslash
addto
\backslash
renewcommand{
\backslash
claimname}{_(Claim)}}
-\change_deleted 2 1234612086
-%
-\end_layout
-
-\begin_layout LyX-Code
-
-\change_deleted 2 1234612089
-
-\backslash
-fi}
-\change_unchanged
-
\end_layout
\begin_layout LyX-Code
-End
-\change_inserted 2 1234611859
-Babel
-\change_deleted 2 1234611856
-I18n
-\change_unchanged
-Preamble
+EndBabelPreamble
\end_layout
\begin_layout Standard
\end_inset
- in the
-\change_inserted 2 1234612144
-language
-\change_deleted 2 1234612146
-standard
-\change_unchanged
- preamble.
+ in the language preamble.
This command holds the name of the theorem that will appear in the output.
The
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-
-\change_inserted 2 1234612157
-Babel
-\change_deleted 2 1234612155
-I18N
-\change_unchanged
-Preamble
+BabelPreamble
\end_layout
\end_inset
\end_inset
- for each used language
-\change_inserted 2 1234622073
- in multilanguage documents
-\change_unchanged
-.
-
-\change_deleted 2 1234612171
- The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-ifx
-\backslash
-LdfInit
-\end_layout
-
-\end_inset
-
- test ensures that no LaTeX error occurs in documents that do not use babel.
- Since LyX loads babel after the style-specific preamble, the whole command
- is deferred to the actual start of the document with
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-
-\backslash
-AtBeginDocument
-\end_layout
-
-\end_inset
-
-.
-\change_unchanged
-
+ for each used language in multilanguage documents.
\end_layout
\end_deeper
The name of the counter for automatic numbering (see Section
\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
in Section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:counter"
+reference "sub:Counters"
\end_inset
Section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:counter"
+reference "sub:Counters"
\end_inset
See Section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:counter"
+reference "sub:Counters"
\end_inset
See section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:fonts"
+reference "sub:Font-description"
\end_inset
\begin_layout Subsection
Floats
-\end_layout
-
-\begin_layout Standard
\begin_inset CommandInset label
LatexCommand label
-name "sec:floats"
+name "sub:Floats"
\end_inset
+
+\end_layout
+
+\begin_layout Standard
Since version 1.3.0 of LyX, it is has been both possible and necessary to
define the floats (
\begin_inset Flex CharStyle:MenuItem
\begin_layout Subsection
Flex insets and InsetLayout
-\end_layout
-
-\begin_layout Standard
\begin_inset CommandInset label
LatexCommand label
-name "sec:charstyle"
+name "sub:Flex-insets-and"
\end_inset
+
+\end_layout
+
+\begin_layout Standard
LyX has supported character styles since version 1.4.0; as of version 1.6.0,
these are called Flex insets.
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:fonts"
+reference "sub:Font-description"
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
-reference "sec:fonts"
+reference "sub:Font-description"
\end_inset
\begin_layout Subsection
Counters
-\end_layout
-
-\begin_layout Standard
\begin_inset CommandInset label
LatexCommand label
-name "sec:counter"
+name "sub:Counters"
\end_inset
+
+\end_layout
+
+\begin_layout Standard
Since version 1.3.0 of LyX, it is both possible and necessary to define the
counters (
\begin_inset Flex CharStyle:MenuItem
\begin_layout Subsection
Font description
-\end_layout
-
-\begin_layout Standard
\begin_inset CommandInset label
LatexCommand label
-name "sec:fonts"
+name "sub:Font-description"
\end_inset
+
+\end_layout
+
+\begin_layout Standard
A font description looks like this:
\end_layout
Creating Templates
\begin_inset CommandInset label
LatexCommand label
-name "sec:templates"
+name "sec:Creating-Templates"
\end_inset
This must be the name of a format that is known to LyX (see section
\begin_inset CommandInset ref
LatexCommand ref
-reference "sub:Formats"
+reference "sec:Formats"
\end_inset
\end_layout
\begin_layout Section
+Security discussion
\begin_inset CommandInset label
LatexCommand label
name "sec:Security-discussion"
\end_inset
-Security discussion
-\end_layout
-
-\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
-WARNING: This section is definitely outdated.
-\end_layout
-
-\end_inset
-
\end_layout
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 Plain Layout
-lib/scripts
-\end_layout
-
-\end_inset
-
- directory of the LyX installation, you can find a safe wrapper script
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-general_command_wrapper.py
-\end_layout
-
-\end_inset
-
- that supports redirection of input and output.
- That can serve as an example for how to write safe template scripts.
- For a more advanced example that uses
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-fork
-\end_layout
-
-\end_inset
-
- and friends, take a look at the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-pic2ascii.py
-\end_layout
-
-\end_inset
-
- converter script.
+
\end_layout
\begin_layout Standard
projects / features.git / blobdiff