#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 355
+\lyxformat 361
\begin_document
\begin_header
\textclass scrbook
\graphics default
\default_output_format default
+\bibtex_command default
+\index_command default
\paperfontsize 12
\spacing single
\use_hyperref true
\use_bibtopic false
\use_indices false
\paperorientation portrait
-\backgroundcolor #ffffff
\branch OutDated
\selected 0
\color #f5fae7
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes false
+\tracking_changes true
\output_changes false
-\author ""
+\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
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
status collapsed
\begin_layout Plain Layout
+
lyx2lyx
\end_layout
status collapsed
\begin_layout Plain Layout
+
lyx2lyx
\end_layout
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
status collapsed
\begin_layout Plain Layout
+
Ghostview
\end_layout
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_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
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_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
- 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
\begin_layout Standard
You do not have to define converters for all formats between which you want
to convert.
- For example, you will note that there is no `LyX to PostScript' converter,
- but LyX will export PostScript.
- It does so by first creating a LaTeX file (no converter needs to be defined
- for this) which is then converted to DVI using the `LaTeX to DVI' converter,
- and finally converting the resulting DVI file to PostScript.
- LyX finds such `chains' of converters automatically, and it will always
- choose the shortest possible chain.
+ For example, you will note that there is no `LyX to
+PostScript'
+ converter, but LyX will export PostScript.
+ It does so by first creating a
+LaTeX
+ file (no converter needs to be defined for this) which is then converted
+ to DVI using the `
+LaTeX
+ to
+DVI'
+ converter, and finally converting the resulting DVI file to PostScript.
+ LyX finds such `
+chains'
+ of converters automatically, and it will always choose the shortest possible
+ chain.
You can, though, still define multiple conversion methods between file
formats.
For example, the standard LyX configuration provides three ways to convert
- LaTeX to PDF: Directly, using
+
+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 "sec:Formats"
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
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_inset
.
- The argument in square brackets is optional: It declares any LaTeX packages
+
+\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.
Please note that only packages about which LyX knows should be listed in
the square brackets.
\end_inset
LyX will not check for arbitrary packages.
+
+\change_inserted 0 1243500694
+ It is also possible to use the form
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+
+\change_inserted 0 1243500706
+from->to
+\end_layout
+
+\end_inset
+
+, which declares that the module can only be used when there exists a conversion
+ chain between formats `from' and `to'.
+\change_unchanged
+
\end_layout
\begin_layout Standard
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
projects / features.git / blobdiff