-#LyX 1.6.2svn created this file. For more info see http://www.lyx.org/
-\lyxformat 345
+#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
+\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
% 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}
\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
\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
\begin_inset Newline newline
\end_inset
-Version 1.6.x
+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
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.
- 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
+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
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
- 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
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Graphics
-\end_layout
-
-\end_inset
-
- or 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
-External material
+Edit externally
\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
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
- 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
----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
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
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 a
+ chain of converters is called).
+\end_layout
+
\begin_layout Standard
In the
\begin_inset Flex CharStyle:MenuItem
\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
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
\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
) 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_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
\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
.
+\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.
+\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.
+
+\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
\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
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
\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
\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
\end_inset
-] Indicates that the module in question---which should be specified by filename
+] Indicates that the module in question—which should be specified by filename
without the
\begin_inset Flex CharStyle:Code
status collapsed
\end_inset
- extension---cannot be used with this document class.
+ extension—cannot be used with this document class.
This might be used in a journal-specific layout file to prevent, say, the
use of the
\begin_inset Flex CharStyle:Code
\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
,\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
\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
\end_inset
-] With this parameter the
-\begin_inset Flex CharStyle:MenuItem
+] With this parameter the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Fill
+\end_layout
+
+\end_inset
+
+ value of the
+\begin_inset Quotes eld
+\end_inset
+
+Vertical space above
+\begin_inset Quotes erd
+\end_inset
+
+ list of the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings
+\end_layout
+
+\end_inset
+
+ dialog can be set when initializing a paragraph with this style.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+Note from Jean-Marc:
+\emph default
+ I'm not sure that this setting has much use, and it should probably be
+ removed in later versions.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Font
+\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 CommandInset ref
+LatexCommand ref
+reference "sub:Font-description"
+
+\end_inset
+
+.
+ Note that defining this font automatically defines the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+ to the same value.
+ So you should define this one first if you also want to define
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LabelFont
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+FreeSpacing
+\end_layout
+
+\end_inset
+
+
+\begin_inset CommandInset label
+LatexCommand label
+name "des:FreeSpacing"
+
+\end_inset
+
+[
+\emph on
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+
+\emph default
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Usually LyX doesn't allow you to insert more than one space between words,
+ since a space is considered as the separation between two words, not a
+ character or symbol of its own.
+ This is a very fine thing but sometimes annoying, for example, when typing
+ program code or plain LaTeX code.
+ For this reason,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+FreeSpacing
+\end_layout
+
+\end_inset
+
+ can be enabled.
+ Note that LyX will create protected blanks for the additional blanks when
+ in another mode than LaTeX-mode.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ Language dependent information to be included in the LaTeX preamble when
+ this style is used.
+ Note that this will completely override any prior
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+BabelPreamble
+\end_layout
+
+\end_inset
+
+ declarations.
+ Must end with
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+EndBabelPreamble
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The contents of this tag will occur once in the LaTeX preamble for each
+ language used by the document.
+ Each time, the following substitutions are made:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+$$lang
+\end_layout
+
+\end_inset
+
+ is replaced by the language name (as used by the babel package).
+\end_layout
+
+\begin_layout Itemize
+The
+\begin_inset Quotes eld
+\end_inset
+
+Function
+\begin_inset Quotes erd
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+_()
+\end_layout
+
+\end_inset
+
+ replaces its argument by the translation of the argument to the current
+ language.
+\end_layout
+
+\begin_layout Standard
+This preamble snippet will only be used if the document contains more than
+ one language and the babel package is used.
+\end_layout
+
+\end_deeper
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+LangPreamble
+\end_layout
+
+\end_inset
+
+ Like
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Fill
+BabelPreamble
\end_layout
\end_inset
- value of the
+, 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
-Vertical space above
-\begin_inset Quotes erd
-\end_inset
- list of the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
-
-Settings
+EndLangPreamble
\end_layout
\end_inset
- dialog can be set when initializing a paragraph with this style.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-
-\emph on
-Note from Jean-Marc:
-\emph default
- I'm not sure that this setting has much use, and it should probably be
- removed in later versions.
-\end_layout
+\begin_inset Quotes erd
\end_inset
-
+.
\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
-Font
+LangPreamble
\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 CommandInset ref
-LatexCommand ref
-reference "sec:fonts"
-
-\end_inset
-
-.
- Note that defining this font automatically defines the
+ and
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-LabelFont
+BabelPreamble
\end_layout
\end_inset
- to the same value.
- So you should define this one first if you also want to define
+ 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
-LabelFont
+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 LyX-Code
+Preamble
+\end_layout
-\begin_layout Plain Layout
-FreeSpacing
+\begin_layout LyX-Code
+
+\backslash
+theoremstyle{remark}
\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+newtheorem{claim}[thm]{
+\backslash
+protect
+\backslash
+claimname}
+\end_layout
-
-\begin_inset CommandInset label
-LatexCommand label
-name "des:FreeSpacing"
+\begin_layout LyX-Code
+EndPreamble
+\end_layout
-\end_inset
+\begin_layout LyX-Code
+LangPreamble
+\end_layout
-[
-\emph on
+\begin_layout LyX-Code
+
+\backslash
+providecommand{
+\backslash
+claimname}{_(Claim)}
+\end_layout
+\begin_layout LyX-Code
+
+\end_layout
+
+\begin_layout LyX-Code
+EndLangPreamble
+\end_layout
+
+\begin_layout LyX-Code
+BabelPreamble
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+addto
+\backslash
+captions$$lang{
+\backslash
+renewcommand{
+\backslash
+claimname}{_(Claim)}}
+\end_layout
+
+\begin_layout LyX-Code
+EndBabelPreamble
+\end_layout
+
+\begin_layout Standard
+The key to correct translation of the user visible text is the definition
+ of the command
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-\emph on
-0
+\backslash
+claimname
\end_layout
\end_inset
-
-\emph default
-,
+ 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
-1
+BabelPreamble
\end_layout
\end_inset
-] Usually LyX doesn't allow you to insert more than one space between words,
- since a space is considered as the separation between two words, not a
- character or symbol of its own.
- This is a very fine thing but sometimes annoying, for example, when typing
- program code or plain LaTeX code.
- For this reason,
+ then uses the commands offered by the babel package to redefine
\begin_inset Flex CharStyle:Code
status collapsed
\begin_layout Plain Layout
-FreeSpacing
+
+\backslash
+claimname
\end_layout
\end_inset
- can be enabled.
- Note that LyX will create protected blanks for the additional blanks when
- in another mode than LaTeX-mode.
+ for each used language in multilanguage documents.
\end_layout
+\end_deeper
\begin_layout Description
\begin_inset Flex CharStyle:Code
status collapsed
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 Flex CharStyle:Code
status collapsed
+\begin_layout Plain Layout
+InToc
+\end_layout
+
+\end_inset
+
+ [
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+0
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+1
+\end_layout
+
+\end_inset
+
+] Whether to include the contents of this inset in the strings generated
+ for the `Outline' pane.
+ One would not, for example, want the content of a footnote in a section
+ header to be included in the TOC displayed in the outline, but one would
+ normally want the content of a character style displayed.
+ Default is false: not to include.
+\end_layout
+
+\begin_layout Description
+\begin_inset Flex CharStyle:Code
+status collapsed
+
\begin_layout Plain Layout
KeepEmpty
\end_layout
\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